Struct flatk::chunked::Offsets

pub struct Offsets<O = Vec<usize>>(_);

A collection of offsets into another collection. This newtype is intended to verify basic invariants about offsets into another collection, namely that the collection is monotonically increasing and non-empty.

Methods

impl<'a> Offsets<&'a [usize]>

pub fn pop_offset(&mut self) -> Option<usize>

Pops an offset from the given slice of offsets and produces an increment for advancing the data pointer. This is a helper function for implementing iterators over Chunked types. This function panics if offsets is empty.

impl<O: AsRef<[usize]>> Offsets<O>

pub fn new(offsets: O) -> Self

impl<O> Offsets<O>

pub fn into_inner(self) -> O

Trait Implementations

impl<O: AsMut<[usize]>> AsMut<[usize]> for Offsets<O>

fn as_mut(&mut self) -> &mut [usize]

Performs the conversion.

impl<O: AsRef<[usize]>> AsRef<[usize]> for Offsets<O>

fn as_ref(&self) -> &[usize]

Performs the conversion.

impl Clear for Offsets

fn clear(&mut self)

Remove all elements from the current set without necessarily deallocating the space previously used.

impl<O: Clone> Clone for Offsets<O>

fn clone(&self) -> Offsets<O>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<O: Copy> Copy for Offsets<O>

impl<O: Debug> Debug for Offsets<O>

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

Formats the value using the given formatter.

impl Default for Offsets<Vec<usize>>

A default set of offsets must allocate.

fn default() -> Self

Returns the "default value" for a type.

impl<O: Dummy> Dummy for Offsets<O>

unsafe fn dummy() -> Self

impl<O: AsRef<[usize]>> From<O> for Offsets<O>

fn from(offsets: O) -> Self

Performs the conversion.

impl<O: FromIterator<usize> + AsRef<[usize]>> FromIterator<usize> for Offsets<O>

fn from_iter<T>(iter: T) -> Self where
    T: IntoIterator<Item = usize>, 

Creates a value from an iterator.

impl<'a, O: Get<'a, Range<usize>>> GetIndex<'a, Offsets<O>> for Range<usize>

type Output = Offsets<O::Output>

fn get(self, offsets: &Offsets<O>) -> Option<Self::Output>

impl<I: SliceIndex<[usize]>, O: AsRef<[usize]>> Index<I> for Offsets<O>

type Output = I::Output

The returned type after indexing.

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

Performs the indexing (container[index]) operation.

impl<I: SliceIndex<[usize]>, O: AsRef<[usize]> + AsMut<[usize]>> IndexMut<I> for Offsets<O>

fn index_mut(&mut self, index: I) -> &mut Self::Output

Performs the mutable indexing (container[index]) operation.

impl<O: AsRef<[usize]>> IndexRange for Offsets<O>

fn index_range(&self, range: Range<usize>) -> Option<Range<usize>>

Return the [begin..end) bound of the chunk at the given index.

impl<O: IntoIterator> IntoIterator for Offsets<O>

type Item = O::Item

The type of the elements being iterated over.

type IntoIter = O::IntoIter

Which kind of iterator are we turning this into?

fn into_iter(self) -> Self::IntoIter

Creates an iterator from a value.

impl<O: IntoOwned> IntoOwned for Offsets<O>

type Owned = Offsets<O::Owned>

fn into_owned(self) -> Self::Owned

fn clone_into(self, target: &mut Self::Owned)

impl<O: Isolate<Range<usize>>> IsolateIndex<Offsets<O>> for Range<usize>

type Output = Offsets<O::Output>

fn try_isolate(self, offsets: Offsets<O>) -> Option<Self::Output>

impl<O: PartialEq> PartialEq<Offsets<O>> for Offsets<O>

fn eq(&self, other: &Offsets<O>) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Offsets<O>) -> bool

This method tests for !=.

impl<O: Push<usize>> Push<usize> for Offsets<O>

fn push(&mut self, item: usize)

impl<O: RemovePrefix> RemovePrefix for Offsets<O>

fn remove_prefix(&mut self, n: usize)

Remove n elements from the beginning.

impl<O: Reserve> Reserve for Offsets<O>

fn reserve_with_storage(&mut self, n: usize, storage_n: usize)

fn reserve(&mut self, n: usize)

impl<O: Set> Set for Offsets<O>

type Elem = O::Elem

Owned element of the set.

type Atom = O::Atom

The most basic element contained by this collection. If this collection contains other collections, this type should be different than Elem.

fn len(&self) -> usize

fn is_empty(&self) -> bool

impl<'a> SplitOffsetsAt for Offsets<&'a [usize]>

fn split_offsets_at(
    self,
    mid: usize
) -> (Offsets<&'a [usize]>, Offsets<&'a [usize]>, usize)

Splits a slice of offsets at the given index into two slices such that each slice is a valid slice of offsets. This means that the element at index mid is shared between the two output slices. In addition, return the offset of the middle element: this is the value offsets[mid] - offsets[0].

Panics

Calling this function with an empty slice or with mid greater than or equal to its length will cause a panic.

impl<O> StructuralPartialEq for Offsets<O>

impl<O: Truncate> Truncate for Offsets<O>

fn truncate(&mut self, new_len: usize)

impl<'a, O: AsRef<[usize]>> View<'a> for Offsets<O>

type Type = Offsets<&'a [usize]>

fn view(&'a self) -> Self::Type

impl<'a, O: AsMut<[usize]>> ViewMut<'a> for Offsets<O>

type Type = Offsets<&'a mut [usize]>

fn view_mut(&'a mut self) -> Self::Type

impl<O: Viewed> Viewed for Offsets<O>