Trait Container

pub trait Container:
    Default
    + Clone
    + 'static {
    type Item;

    // Required methods
    fn len(&self) -> usize;
    fn capacity(&self) -> usize;
    fn clear(&mut self);

    // Provided method
    fn is_empty(&self) -> bool { ... }
}

A container transferring data through dataflow edges

A container stores a number of elements and thus is able to describe it length (len()) and whether it is empty (is_empty()). It supports removing all elements (clear).

A container must implement default. The default implementation is not required to allocate memory for variable-length components.

We require the container to be cloneable to enable efficient copies when providing references of containers to operators. Care must be taken that the type’s clone_from implementation is efficient (which is not necessarily the case when deriving Clone.) TODO: Don’t require Container: Clone

Required Associated Types

type Item

The type of elements this container holds.

Required Methods

fn len(&self) -> usize

The number of elements in this container

The length of a container must be consistent between sending and receiving it. When exchanging a container and partitioning it into pieces, the sum of the length of all pieces must be equal to the length of the original container.

fn capacity(&self) -> usize

The capacity of the underlying container

fn clear(&mut self)

Remove all contents from self while retaining allocated memory. After calling clear, is_empty must return true and len 0.

Provided Methods

fn is_empty(&self) -> bool

Determine if the container contains any elements, corresponding to len() == 0.

Dyn Compatibility

This trait is not dyn compatible.

In older versions of Rust, dyn compatibility was called "object safety", so this trait is not object safe.

Implementations on Foreign Types

impl<T: Clone + 'static> Container for Vec<T>

type Item = T

fn len(&self) -> usize

fn is_empty(&self) -> bool

fn capacity(&self) -> usize

fn clear(&mut self)

impl<T: Container> Container for Rc<T>

type Item = <T as Container>::Item

fn len(&self) -> usize

fn is_empty(&self) -> bool

fn capacity(&self) -> usize

fn clear(&mut self)

impl<T: Container> Container for Arc<T>

type Item = <T as Container>::Item

fn len(&self) -> usize

fn is_empty(&self) -> bool

fn capacity(&self) -> usize

fn clear(&mut self)

Implementors

impl<T: Columnation + 'static> Container for TimelyStack<T>

type Item = T