Struct ArrayBytesFixedDisjointView 

pub struct ArrayBytesFixedDisjointView<'a> { /* private fields */ }

A disjoint view of the bytes in an array with a fixed-length data type.

The subset represented by this view must not overlap with the subset of any other created views that reference the same array bytes.

Implementations

impl<'a> ArrayBytesFixedDisjointView<'a>

pub unsafe fn new( bytes: UnsafeCellSlice<'a, u8>, data_type_size: usize, shape: &'a [u64], subset: ArraySubset, ) -> Result<ArrayBytesFixedDisjointView<'a>, ArrayBytesFixedDisjointViewCreateError>

Create a new non-overlapping view of the bytes in an array.

Errors

Returns ArrayBytesFixedDisjointViewCreateError if

• subset is out-of-bounds of shape, or
• the length of bytes is not the product of the elements in shape multiplied by data_type_size.

Safety

The subset represented by this view must not overlap with the subset of any other created views that reference the same array bytes.

Panics

Panics if the product of the elements in shape multiplied by data_type_size exceeds usize::MAX.

pub unsafe fn subdivide( &self, subset: ArraySubset, ) -> Result<ArrayBytesFixedDisjointView<'a>, ArrayBytesFixedDisjointViewCreateError>

Create a new non-overlapping view of the bytes in an array that is a subset of the current view.

Errors

Returns SubsetOutOfBoundsError if subset is out-of-bounds of the parent subset.

Safety

The subset represented by this view must not overlap with the subset of any other created views that reference the same array bytes.

pub fn shape(&self) -> &[u64]

Return the shape of the bytes this view is created from.

pub fn subset(&self) -> &ArraySubset

Return the subset of the bytes this view is created from.

pub fn num_elements(&self) -> u64

Return the number of elements in the view.

pub fn num_contiguous_elements(&self) -> usize

Return the contiguous element length of the view.

This is the number of elements that are accessed in a single contiguous block.

pub fn contiguous_bytes_len(&self) -> usize

Return the size in bytes of contiguous elements in the view.

This is the number of elements that are accessed in a single contiguous block.

pub fn fill(&mut self, fill_value: &[u8]) -> Result<(), InvalidBytesLengthError>

Fill the view with the fill value.

Errors

Returns InvalidBytesLengthError if the length of the fill_value does not match the data type size.

Panics

Panics if an offset into the internal bytes reference exceeds usize::MAX.

pub fn copy_from_slice( &mut self, subset_bytes: &[u8], ) -> Result<(), InvalidBytesLengthError>

Copy bytes into the view.

The subset_bytes must be the same length as the byte length of the elements in the view.

Errors

Returns an InvalidBytesLengthError if the length of subset_bytes is not the same as the byte length of the elements in the view.

Panics

Panics if an offset into the internal bytes reference exceeds usize::MAX.

Trait Implementations

impl<'a> From<&'a mut ArrayBytesFixedDisjointView<'a>> for ArrayBytesDecodeIntoTarget<'a>

fn from( view: &'a mut ArrayBytesFixedDisjointView<'a>, ) -> ArrayBytesDecodeIntoTarget<'a>

Converts to this type from the input type.