Enum Stash 

pub enum Stash<C, B> {
    Typed(C),
    Bytes(B),
    Align(Box<[u64]>),
}

A container of either typed columns, or serialized bytes that can be borrowed as the former.

When B dereferences to a byte slice, the container can be borrowed as if the container type C. This container inherents the readable properties of C through borrowing, but does not implement the traits itself.

The container can be cleared and pushed into. When cleared it reverts to a typed variant, and when pushed into if the typed variant it will accept the item, and if not it will panic.

Variants

Typed(C)

The typed variant of the container.

Bytes(B)

The bytes variant of the container.

Align(Box<[u64]>)

Relocated, aligned binary data, if Bytes doesn’t work for some reason.

Most commonly this works around misaligned binary data, but it can also be useful if the B type is a scarce resource that should be released.

Implementations

impl<C: ContainerBytes, B: Deref<Target = [u8]>> Stash<C, B>

pub fn borrow<'a>(&'a self) -> <C as Borrow>::Borrowed<'a>

Borrows the contents, either from a typed container or by decoding serialized bytes.

This method is relatively cheap but is not free.

pub fn length_in_bytes(&self) -> usize

The number of bytes needed to write the contents using the Indexed encoder.

pub fn into_bytes<W: Write>(&self, writer: &mut W)

Write the contents into a std::io::Write using the Indexed encoder.

Trait Implementations

impl<C: ContainerBytes, B: Deref<Target = [u8]> + Clone + 'static> Borrow for Stash<C, B>

type Ref<'a> = <C as Borrow>::Ref<'a>

For each lifetime, a reference with that lifetime.

type Borrowed<'a> = <C as Borrow>::Borrowed<'a>

The type of a borrowed container.

fn borrow<'a>(&'a self) -> Self::Borrowed<'a>

Converts a reference to the type to a borrowed variant.

fn reborrow<'b, 'a: 'b>(item: Self::Borrowed<'a>) -> Self::Borrowed<'b>

where Self: 'a,

Reborrows the borrowed type to a shorter lifetime. See Columnar::reborrow for details.

fn reborrow_ref<'b, 'a: 'b>(item: Self::Ref<'a>) -> Self::Ref<'b>

where Self: 'a,

Reborrows the borrowed type to a shorter lifetime. See Columnar::reborrow for details.

impl<C: Clear + Default, B> Clear for Stash<C, B>

fn clear(&mut self)

Clears self, without changing its capacity.

impl<C: Clone, B: Clone> Clone for Stash<C, B>

fn clone(&self) -> Stash<C, B>

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl<C: Default, B> Default for Stash<C, B>

fn default() -> Self

Returns the “default value” for a type.

impl<C: Container, B: Deref<Target = [u8]>> From<B> for Stash<C, B>

fn from(bytes: B) -> Self

Converts to this type from the input type.

impl<C: ContainerBytes, B: Deref<Target = [u8]>> Len for Stash<C, B>

fn len(&self) -> usize

The number of contained elements.

fn is_empty(&self) -> bool

Whether this contains no elements.

impl<T, C: Container + Push<T>, B> Push<T> for Stash<C, B>

fn push(&mut self, item: T)

Pushes an item onto self.

fn extend(&mut self, iter: impl IntoIterator<Item = T>)

Pushes elements of an iterator onto self.