Struct arrow2::offset::OffsetsBuffer

pub struct OffsetsBuffer<O: Offset>(_);

A wrapper type of Buffer<O> that is guaranteed to:

• Always contain an element
• Every element is >0
• element at position i is >= than element at position i-1.

Implementations

impl<O: Offset> OffsetsBuffer<O>

pub unsafe fn new_unchecked(offsets: Buffer<O>) -> Self

Safety

This is safe iff the invariants of this struct are guaranteed in offsets.

pub fn new() -> Self

Returns an empty OffsetsBuffer (i.e. with a single element, the zero)

pub fn get_mut(&mut self) -> Option<Offsets<O>>

Copy-on-write API to convert OffsetsBuffer into Offsets.

pub fn buffer(&self) -> &Buffer<O>

Returns a reference to its internal Buffer.

pub fn len(&self) -> usize

Returns the length of this container

pub fn as_slice(&self) -> &[O]

Returns the byte slice stored in this buffer

pub fn last(&self) -> &O

Returns the last offset of this container, which is guaranteed to exist.

pub fn start_end(&self, index: usize) -> (usize, usize)

Returns a range (start, end) corresponding to the position index

Panic

This function panics iff index >= self.len()

pub unsafe fn start_end_unchecked(&self, index: usize) -> (usize, usize)

Returns a range (start, end) corresponding to the position index

Safety

index must be < self.len()

pub unsafe fn slice_unchecked(self, offset: usize, length: usize) -> Self

Returns a new OffsetsBuffer that is a slice of this buffer starting at offset. Doing so allows the same memory region to be shared between buffers.

Safety

The caller must ensure offset + length <= self.len()

pub fn lengths(&self) -> impl Iterator<Item = usize> + '_

Returns an iterator with the lengths of the offsets

pub fn into_inner(self) -> Buffer<O>

Returns the inner Buffer.

Trait Implementations

impl<O: Clone + Offset> Clone for OffsetsBuffer<O>

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

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<O: Debug + Offset> Debug for OffsetsBuffer<O>

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

Formats the value using the given formatter.

impl<O: Offset> Default for OffsetsBuffer<O>

fn default() -> Self

Returns the “default value” for a type.

impl From<&OffsetsBuffer<i32>> for OffsetsBuffer<i64>

fn from(offsets: &OffsetsBuffer<i32>) -> Self

Converts to this type from the input type.

impl<O: Offset> From<Offsets<O>> for OffsetsBuffer<O>

fn from(offsets: Offsets<O>) -> Self

Converts to this type from the input type.

impl<O: PartialEq + Offset> PartialEq<OffsetsBuffer<O>> for OffsetsBuffer<O>

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

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

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl TryFrom<&OffsetsBuffer<i64>> for OffsetsBuffer<i32>

type Error = Error

The type returned in the event of a conversion error.

fn try_from(offsets: &OffsetsBuffer<i64>) -> Result<Self, Self::Error>

Performs the conversion.

impl<O: Offset> TryFrom<Buffer<O>> for OffsetsBuffer<O>

type Error = Error

The type returned in the event of a conversion error.

fn try_from(offsets: Buffer<O>) -> Result<Self, Self::Error>

Performs the conversion.

impl<O: Offset> TryFrom<Vec<O, Global>> for OffsetsBuffer<O>

type Error = Error

The type returned in the event of a conversion error.

fn try_from(offsets: Vec<O>) -> Result<Self, Self::Error>

Performs the conversion.

impl<O: Offset> StructuralPartialEq for OffsetsBuffer<O>