Struct Container

pub struct Container<'id, Array: TrustedContainer + ?Sized> { /* private fields */ }

A branded container, that allows access only to indices and ranges with the exact same brand in the 'id parameter.

The elements in the underlying data structure are accessible partly through special purpose methods, and through indexing/slicing.

The container can be indexed with self[i] where i is a trusted, dereferenceable index or range. Indexing like this uses no runtime checking at all, as it is statically guaranteed correct.

Implementations

impl<'id, Array: TrustedContainer + ?Sized> Container<'id, &Array>

pub fn project(&self) -> &Container<'id, Array>

impl<'id, Array: TrustedContainer + ?Sized> Container<'id, Array>

pub fn untrusted(&self) -> &Array

This container without the branding.

Note

The returned lifetime of &Array is not 'id! It’s completely valid to drop the container during the scope, in which case this reference would become invalid. If you need a longer lifetime, consider using scope_ref such that the reference is guaranteed to live for the entire scope.

pub fn unit_len(&self) -> usize

The length of the container in base item units.

pub fn start<I: Idx>(&self) -> Index<'id, I, Unknown>

The zero index without a proof of contents.

pub fn end<I: Idx>(&self) -> Index<'id, I, Unknown>

The index one past the end of this container.

pub fn empty_range<I: Idx>(&self) -> Range<'id, I, Unknown>

The empty range 0..0.

pub fn range<I: Idx>(&self) -> Range<'id, I, Unknown>

The full range of the container.

pub fn vet<I: Idx>(&self, idx: I) -> Result<Index<'id, I, NonEmpty>, IndexError>

Vet an absolute index.

pub fn vet_range<I: Idx>( &self, r: Range<I>, ) -> Result<Range<'id, I, Unknown>, IndexError>

Vet an absolute range.

pub fn split_at<I: Idx, P>( &self, idx: Index<'id, I, P>, ) -> (Range<'id, I, Unknown>, Range<'id, I, P>)

Split the container in two at the given index, such that the second range contains the index.

pub fn split_after<I: Idx>( &self, idx: Index<'id, I, NonEmpty>, ) -> (Range<'id, I, NonEmpty>, Range<'id, I, Unknown>)

Split the container in two after the given index, such that the first range contains the index.

pub fn split_around<I: Idx, P>( &self, r: Range<'id, I, P>, ) -> (Range<'id, I, Unknown>, Range<'id, I, Unknown>)

Split around the range r creating ranges 0..r.start and r.end...

The input r and return values (s, t) cover teh whole container in the order s, r, t.

pub fn before<I: Idx, P>(&self, idx: Index<'id, I, P>) -> Range<'id, I, Unknown>

Return the range before but not including the index.

pub fn after<I: Idx>( &self, idx: Index<'id, I, NonEmpty>, ) -> Range<'id, I, Unknown>

Return the range after but not including the index.

pub fn advance<I: Idx>( &self, idx: Index<'id, I, NonEmpty>, ) -> Option<Index<'id, I, NonEmpty>>

Advance an index to the next item in the container, if there is one.

pub fn advance_by<I: Idx, P>( &self, idx: Index<'id, I, P>, offset: usize, ) -> Result<Index<'id, I, NonEmpty>, IndexError>

Advance an index by a given base unit offset, if the index at said offset is a valid item index.

pub fn decrease_by<I: Idx, P>( &self, idx: Index<'id, I, P>, offset: usize, ) -> Result<Index<'id, I, NonEmpty>, IndexError>

Decrease an index by a given base unit offset, if the index at said offset is a valid item index.

impl<'id, Array: TrustedContainer + ?Sized> Container<'id, Box<Array>>

pub fn project(&self) -> &Container<'id, Array>

Available on crate feature std only.

impl<'id, T> Container<'id, Vec<T>>

pub fn project(&self) -> &Container<'id, [T]>

Available on crate feature std only.

impl<'id> Container<'id, String>

pub fn project(&self) -> &Container<'id, str>

Available on crate feature std only.

Trait Implementations

impl<'id, Array: TrustedContainer + Clone> Clone for Container<'id, Array>

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<'id, Array: TrustedContainer + Debug + ?Sized> Debug for Container<'id, Array>

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl<'id, Array: TrustedContainer + ?Sized, I: Idx> Index<Index<'id, I>> for Container<'id, Array>

type Output = <Array as TrustedContainer>::Item

The returned type after indexing.

fn index(&self, index: Index<'id, I, NonEmpty>) -> &Self::Output

Performs the indexing (container[index]) operation.

impl<'id, Array: TrustedContainer + ?Sized, I: Idx, P> Index<Range<'id, I, P>> for Container<'id, Array>

type Output = <Array as TrustedContainer>::Slice

The returned type after indexing.

fn index(&self, r: Range<'id, I, P>) -> &Self::Output

Performs the indexing (container[index]) operation.

impl<'id, Array: TrustedContainer + ?Sized, I: Idx, P> Index<RangeFrom<Index<'id, I, P>>> for Container<'id, Array>

type Output = <Array as TrustedContainer>::Slice

The returned type after indexing.

fn index(&self, r: RangeFrom<Index<'id, I, P>>) -> &Self::Output

Performs the indexing (container[index]) operation.

impl<'id, Array: TrustedContainer + ?Sized> Index<RangeFull> for Container<'id, Array>

type Output = <Array as TrustedContainer>::Slice

The returned type after indexing.

fn index(&self, _: RangeFull) -> &Self::Output

Performs the indexing (container[index]) operation.

impl<'id, Array: TrustedContainer + ?Sized, I: Idx, P> Index<RangeTo<Index<'id, I, P>>> for Container<'id, Array>

type Output = <Array as TrustedContainer>::Slice

The returned type after indexing.

fn index(&self, r: RangeTo<Index<'id, I, P>>) -> &Self::Output

Performs the indexing (container[index]) operation.

impl<'id, Array: TrustedContainer + Copy> Copy for Container<'id, Array>