Enum CowArray 

pub enum CowArray<'a, T: Element, D: Dimension> {
    Borrowed(ArrayView<'a, T, D>),
    Owned(Array<T, D>),
}

A copy-on-write array that is either a borrowed view or an owned array.

This is useful when a function might or might not need to allocate: it can accept borrowed data and only clone if mutation is required.

Variants

Borrowed(ArrayView<'a, T, D>)

Borrowed — refers to data owned by another array.

Owned(Array<T, D>)

Owned — has its own data buffer.

Implementations

impl<'a, T: Element, D: Dimension> CowArray<'a, T, D>

pub fn from_view(view: ArrayView<'a, T, D>) -> Self

Create a CowArray from a borrowed view.

pub fn from_owned(arr: Array<T, D>) -> Self

Create a CowArray from an owned array.

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

Shape as a slice.

pub fn ndim(&self) -> usize

Number of dimensions.

pub fn size(&self) -> usize

Total number of elements.

pub fn is_empty(&self) -> bool

Whether the array has zero elements.

pub fn layout(&self) -> MemoryLayout

Memory layout.

pub fn is_borrowed(&self) -> bool

Whether this is a borrowed (view) variant.

pub fn is_owned(&self) -> bool

Whether this is an owned variant.

pub fn into_owned(self) -> Array<T, D>

Convert to an owned array, cloning if currently borrowed.

pub fn to_mut(&mut self) -> &mut Array<T, D>

Ensure this is the owned variant, cloning if necessary, and return a mutable reference to the owned array.

pub fn view(&self) -> ArrayView<'_, T, D>

Get a read-only view of the data.

If this is a borrowed variant, returns a view with the same lifetime as &self. If owned, returns a view borrowing from self.

pub fn as_ptr(&self) -> *const T

Raw pointer to the first element.

pub fn flags(&self) -> ArrayFlags

Array flags.

Trait Implementations

impl<T: Element, D: Dimension> Clone for CowArray<'_, T, D>

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<T: Element, D: Dimension> Debug for CowArray<'_, T, D>

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

Formats the value using the given formatter.

impl<T: Element, D: Dimension> Display for CowArray<'_, T, D>

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

Formats the value using the given formatter.

impl<T: Element, D: Dimension> From<Array<T, D>> for CowArray<'_, T, D>

fn from(arr: Array<T, D>) -> Self

Converts to this type from the input type.

impl<'a, T: Element, D: Dimension> From<ArrayView<'a, T, D>> for CowArray<'a, T, D>

fn from(view: ArrayView<'a, T, D>) -> Self

Converts to this type from the input type.