常用集合特质

此crate提供了描述数据结构上常见操作的特质。这在构建不依赖于底层数据结构实现的泛型数据结构上的新类型时特别有用。

以下是此crate提供的特质的示例

/// Mutable collection where new elements can be inserted.
pub trait Insert: Collection {
    /// The output of the insertion function.
    type Output;

    /// Insert a new element in the collection.
    fn insert(&mut self, element: Self::Item) -> Self::Output;
}

使用方法

这些特质可以用来定义具有特殊属性的集合，而与实际内部数据结构无关。例如，以下代码定义了一个Ordered<S>堆栈集合，保证了堆栈中元素的良好排序。

use cc_traits::{
    Collection,
    Back,
    PushBack
};

/// Ordered stack.
pub struct Ordered<S> {
    inner: S
}

impl<S> Ordered<S> {
    pub fn new() -> Self where S: Default {
        Ordered {
            inner: S::default()
        }
    }
}

impl<S> Ordered<S> {
    /// Push the given element on the stack iff it is grater or equal
    /// to every other element already in the stack.
    pub fn try_push<T>(&mut self, element: T) -> Result<(), T>
    where
        T: PartialOrd,
        S: Collection<Item=T> + Back + PushBack, // `S` must be a stack providing `back` and `push_back`.
        for<'a> S::ItemRef<'a>: PartialOrd<&'a T> // The reference type must be comparable with other reference types.
    {
        if self.inner.back().map(|back| back <= &element).unwrap_or(true) {
            self.inner.push_back(element);
            Ok(())
        } else {
            Err(element)
        }
    }
}

let mut vec: Ordered<Vec<i32>> = Ordered::new(); // a `Vec` is a stack so it works.

assert!(vec.try_push(1).is_ok());
assert!(vec.try_push(2).is_ok());
assert!(vec.try_push(0).is_err());

use std::collections::VecDeque;
let mut deque: Ordered<VecDeque<i32>> = Ordered::new(); // a `VecDeque` is also a stack.

assert!(deque.try_push(1).is_ok());
assert!(deque.try_push(2).is_ok());
assert!(deque.try_push(0).is_err());

特质别名

通过启用nightly，您可以访问一些特质别名定义，这可以有助于减少代码的冗长。以下是一个这样的别名定义堆栈的常见接口的示例

pub trait Stack<T> = Collection<Item=T> + Len + Back;
pub trait StackMut<T> = Stack<T> + BackMut + PushBack + PopBack;

截至版本0.8.0，这些特质也作为常规特质定义可用，无需nightly功能。

标准库

默认情况下，此crate中定义的所有特质（当相关时）都针对标准库集合实现。您可以使用nostd功能禁用此功能。

外部实现

除了标准库外，如果您启用同名功能，特质还实现了某些流行的crate。以下是一些受支持的crate

• slab 提供了 Slab 集合。
• smallvec 提供了 SmallVec 集合。
• serde_json 提供了 JSON 对象的 Map<String, Value> 集合。
• ijson 提供了 IObject 和 IArray 集合。

许可协议

许可协议为以下之一

• Apache许可证，版本2.0（LICENSE-APACHE 或 https://apache.ac.cn/licenses/LICENSE-2.0）
• MIT许可证（LICENSE-MIT 或 http://opensource.org/licenses/MIT）

由您选择。

贡献

除非您明确声明，否则任何根据Apache-2.0许可证定义提交以包含在作品中的贡献，都将如上所述双重许可，不附加任何额外条款或条件。