Struct narrow::offset::Offset

pub struct Offset<T, const NULLABLE: bool = false, OffsetItem: OffsetElement = i32, Buffer: BufferType = VecBuffer>
where
    <Buffer as BufferType>::Buffer<OffsetItem>: Validity<NULLABLE>,
{
    pub data: T,
    pub offsets: <<Buffer as BufferType>::Buffer<OffsetItem> as Validity<NULLABLE>>::Storage<Buffer>,
}

Offset abstraction.

Fields

data: T

The data

offsets: <<Buffer as BufferType>::Buffer<OffsetItem> as Validity<NULLABLE>>::Storage<Buffer>

The offsets

Implementations

impl<const NULLABLE: bool, T, OffsetItem: OffsetElement, Buffer: BufferType> Offset<T, NULLABLE, OffsetItem, Buffer>

where <Buffer as BufferType>::Buffer<OffsetItem>: Validity<NULLABLE>, Offset<T, NULLABLE, OffsetItem, Buffer>: Index,

pub fn iter(&self) -> OffsetIter<'_, NULLABLE, T, OffsetItem, Buffer>

Returns an iteratover over the offset items in this Offset.

Trait Implementations

impl<T, OffsetItem: OffsetElement, Buffer: BufferType> BitmapRef for Offset<T, true, OffsetItem, Buffer>

type Buffer = Buffer

The buffer type of the bitmap.

fn bitmap_ref(&self) -> &Bitmap<Self::Buffer>

Returns a reference to an immutable Bitmap.

impl<T, OffsetItem: OffsetElement, Buffer: BufferType> BitmapRefMut for Offset<T, true, OffsetItem, Buffer>

fn bitmap_ref_mut(&mut self) -> &mut Bitmap<Self::Buffer>

Returns a mutable reference to a Bitmap.

impl<T: Default, OffsetItem: OffsetElement, Buffer: BufferType> Default for Offset<T, false, OffsetItem, Buffer>

where <Buffer as BufferType>::Buffer<OffsetItem>: Default + Extend<OffsetItem>,

fn default() -> Self

Returns the “default value” for a type.

impl<T: Default, OffsetItem: OffsetElement, Buffer: BufferType> Default for Offset<T, true, OffsetItem, Buffer>

where <<Buffer as BufferType>::Buffer<OffsetItem> as Validity<true>>::Storage<Buffer>: Default, <Buffer as BufferType>::Buffer<OffsetItem>: Extend<OffsetItem>,

fn default() -> Self

Returns the “default value” for a type.

impl<T, U: IntoIterator + Length, OffsetItem: OffsetElement, Buffer: BufferType> Extend<Option<U>> for Offset<T, true, OffsetItem, Buffer>

where T: Extend<<U as IntoIterator>::Item>, <<Buffer as BufferType>::Buffer<OffsetItem> as Validity<true>>::Storage<Buffer>: Extend<(bool, OffsetItem)>,

fn extend<I: IntoIterator<Item = Option<U>>>(&mut self, iter: I)

Extends a collection with the contents of an iterator.

fn extend_one(&mut self, item: A)

🔬This is a nightly-only experimental API. (extend_one)

Extends a collection with exactly one element.

fn extend_reserve(&mut self, additional: usize)

🔬This is a nightly-only experimental API. (extend_one)

Reserves capacity in a collection for the given number of additional elements.

impl<T, U: IntoIterator + Length, OffsetItem: OffsetElement, Buffer: BufferType> Extend<U> for Offset<T, false, OffsetItem, Buffer>

where T: Extend<<U as IntoIterator>::Item>, <Buffer as BufferType>::Buffer<OffsetItem>: Extend<OffsetItem>,

fn extend<I: IntoIterator<Item = U>>(&mut self, iter: I)

Extends a collection with the contents of an iterator.

fn extend_one(&mut self, item: A)

🔬This is a nightly-only experimental API. (extend_one)

Extends a collection with exactly one element.

fn extend_reserve(&mut self, additional: usize)

🔬This is a nightly-only experimental API. (extend_one)

Reserves capacity in a collection for the given number of additional elements.

impl<T, OffsetItem: OffsetElement, Buffer: BufferType> From<Offset<T, false, OffsetItem, Buffer>> for Offset<T, true, OffsetItem, Buffer>

where <Buffer as BufferType>::Buffer<OffsetItem>: Length, Bitmap<Buffer>: FromIterator<bool>,

fn from(value: Offset<T, false, OffsetItem, Buffer>) -> Self

Converts to this type from the input type.

impl<T, U: IntoIterator + Length, OffsetItem: OffsetElement, Buffer: BufferType> FromIterator<Option<U>> for Offset<T, true, OffsetItem, Buffer>

where Self: Default, T: Extend<<U as IntoIterator>::Item>, <<Buffer as BufferType>::Buffer<OffsetItem> as Validity<true>>::Storage<Buffer>: Extend<(bool, OffsetItem)>,

fn from_iter<I: IntoIterator<Item = Option<U>>>(iter: I) -> Self

Creates a value from an iterator.

impl<T, U: IntoIterator + Length, OffsetItem: OffsetElement, Buffer: BufferType> FromIterator<U> for Offset<T, false, OffsetItem, Buffer>

where Self: Default, T: Extend<<U as IntoIterator>::Item>, <Buffer as BufferType>::Buffer<OffsetItem>: Extend<OffsetItem>,

fn from_iter<I: IntoIterator<Item = U>>(iter: I) -> Self

Creates a value from an iterator.

impl<T, OffsetItem: OffsetElement, Buffer: BufferType> Index for Offset<T, false, OffsetItem, Buffer>

type Item<'a> = OffsetSlice<'a, T, false, OffsetItem, Buffer> where Self: 'a

The item.

unsafe fn index_unchecked(&self, index: usize) -> Self::Item<'_>

Returns the value at given index. Skips bound checking.

fn index(&self, index: usize) -> Option<Self::Item<'_>>

Returns the value at given index. Returns None if the index is out of range.

fn index_checked(&self, index: usize) -> Self::Item<'_>

Returns the value at given index. Panics if the index is out of bounds.

impl<T, OffsetItem: OffsetElement, Buffer: BufferType> Index for Offset<T, true, OffsetItem, Buffer>

type Item<'a> = Option<OffsetSlice<'a, T, true, OffsetItem, Buffer>> where Self: 'a

The item.

unsafe fn index_unchecked(&self, index: usize) -> Self::Item<'_>

Returns the value at given index. Skips bound checking.

fn index(&self, index: usize) -> Option<Self::Item<'_>>

Returns the value at given index. Returns None if the index is out of range.

fn index_checked(&self, index: usize) -> Self::Item<'_>

Returns the value at given index. Panics if the index is out of bounds.

impl<'a, const NULLABLE: bool, T, OffsetItem: OffsetElement, Buffer: BufferType> IntoIterator for &'a Offset<T, NULLABLE, OffsetItem, Buffer>

where <Buffer as BufferType>::Buffer<OffsetItem>: Validity<NULLABLE>, Offset<T, NULLABLE, OffsetItem, Buffer>: Index,

type Item = <Offset<T, NULLABLE, OffsetItem, Buffer> as Index>::Item<'a>

The type of the elements being iterated over.

type IntoIter = OffsetIter<'a, NULLABLE, T, OffsetItem, Buffer>

Which kind of iterator are we turning this into?

fn into_iter(self) -> Self::IntoIter

Creates an iterator from a value.

impl<T, OffsetItem: OffsetElement, Buffer: BufferType> Length for Offset<T, false, OffsetItem, Buffer>

fn len(&self) -> usize

Returns the number of elements in the collection, also referred to as its length.

fn is_empty(&self) -> bool

Returns true if there are no elements in the collection.

impl<T, OffsetItem: OffsetElement, Buffer: BufferType> Length for Offset<T, true, OffsetItem, Buffer>

fn len(&self) -> usize

Returns the number of elements in the collection, also referred to as its length.

fn is_empty(&self) -> bool

Returns true if there are no elements in the collection.

impl<T, OffsetItem: OffsetElement, Buffer: BufferType> ValidityBitmap for Offset<T, true, OffsetItem, Buffer>

fn is_null(&self, index: usize) -> Option<bool>

Returns true if the element at position index is null.

unsafe fn is_null_unchecked(&self, index: usize) -> bool

Returns true if the element at position index is null, without performing any bounds checking.

fn null_count(&self) -> usize

Returns the number of null elements.

fn is_valid(&self, index: usize) -> Option<bool>

Returns true if the element at position index is valid.

unsafe fn is_valid_unchecked(&self, index: usize) -> bool

Returns true if the element at position index is valid, without performing any bounds checking.

fn valid_count(&self) -> usize

Returns the number of valid elements.

fn any_null(&self) -> bool

Returns true if the array contains at least one null element.

fn all_null(&self) -> bool

Returns true if all the elements are null.

fn any_valid(&self) -> bool

Returns true if the array contains at least one valid element.

fn all_valid(&self) -> bool

Returns true if all the elements are valid.