Struct squash::OwnedSlice

pub struct OwnedSlice<T, H = BoxHeader> where
    H: Header,  { /* fields omitted */ }

An owned slice.

This is similar to Box<[T]> (or Arc<[T]>, depending on the Header H type parameter). It holds a heap allocated slice of fixed length. The difference is in internal representation ‒ this is behind a thin pointer and encoded with smaller memory overhead (small slices don't need full 8 bytes of length).

Examples

use squash::OwnedSlice;
let s: OwnedSlice<u16> = OwnedSlice::new(&[1, 2, 3]).unwrap();
assert_eq!(3, s.len());

Internal representation

The heap layout is the header, followed by exactly the number of extra bytes the header needed to encode the length, followed by the actual slice data, with alignments taken into account.

Implementations

impl<T, H> OwnedSlice<T, H> where
    H: Header, 

pub fn new(src: &[T]) -> Result<Self, TooLong> where
    T: Clone, 

Creates a new owned slice by cloning a content of the passed one.

Errors

If the slice is bigger than the header can encode, this is signalized by the TooLong error. Note that the limits of headers provided by this library are generally quite generous and many users may opt to handle the theoretical errors by unwrapping/panicking.

Trait Implementations

impl<T, H> Clone for OwnedSlice<T, H> where
    H: Header,
    T: Clone, 

pub fn clone(&self) -> Self

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<T, H> Debug for OwnedSlice<T, H> where
    H: Header,
    T: Debug, 

pub fn fmt(&self, fmt: &mut Formatter<'_>) -> FmtResult

Formats the value using the given formatter.

impl<T, H> Default for OwnedSlice<T, H> where
    H: Header, 

pub fn default() -> Self

Returns the "default value" for a type.

impl<T, H> Deref for OwnedSlice<T, H> where
    H: Header, 

type Target = [T]

The resulting type after dereferencing.

pub fn deref(&self) -> &[T]

Dereferences the value.

impl<T> DerefMut for OwnedSlice<T, BoxHeader>

pub fn deref_mut(&mut self) -> &mut Self::Target

Mutably dereferences the value.

impl<T, H> Drop for OwnedSlice<T, H> where
    H: Header, 

pub fn drop(&mut self)

Executes the destructor for this type.

impl<T, H> Send for OwnedSlice<T, H> where
    H: Header + Send + Sync,
    T: Send + Sync, 

impl<T, H> Sync for OwnedSlice<T, H> where
    H: Header + Send + Sync,
    T: Send + Sync,