Struct BorrowedShreddingState 

pub struct BorrowedShreddingState<'a> {
    value: Option<&'a GenericByteViewArray<BinaryViewType>>,
    typed_value: Option<&'a Arc<dyn Array>>,
}

Similar to ShreddingState except it holds borrowed references of the target arrays. Useful for avoiding clone operations when the caller does not need a self-standing shredding state.

Fields

value: Option<&'a GenericByteViewArray<BinaryViewType>>

typed_value: Option<&'a Arc<dyn Array>>

Implementations

impl<'a> BorrowedShreddingState<'a>

pub fn new( value: Option<&'a GenericByteViewArray<BinaryViewType>>, typed_value: Option<&'a Arc<dyn Array>>, ) -> BorrowedShreddingState<'a>

Create a new BorrowedShreddingState from the given value and typed_value fields

Note you can create a BorrowedShreddingState from a &[StructArray] using BorrowedShreddingState::try_from(&struct_array), for example:

let struct_array: StructArray = get_struct_array();
let shredding_state = BorrowedShreddingState::try_from(&struct_array).unwrap();

pub fn value_field(&self) -> Option<&'a GenericByteViewArray<BinaryViewType>>

Return a reference to the value field, if present

pub fn typed_value_field(&self) -> Option<&'a Arc<dyn Array>>

Return a reference to the typed_value field, if present

Trait Implementations

impl<'a> Clone for BorrowedShreddingState<'a>

fn clone(&self) -> BorrowedShreddingState<'a>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<'a> Debug for BorrowedShreddingState<'a>

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

Formats the value using the given formatter.

impl From<BorrowedShreddingState<'_>> for ShreddingState

fn from(state: BorrowedShreddingState<'_>) -> ShreddingState

Converts to this type from the input type.

impl<'a> TryFrom<&'a StructArray> for BorrowedShreddingState<'a>

type Error = ArrowError

The type returned in the event of a conversion error.

fn try_from( inner_struct: &'a StructArray, ) -> Result<BorrowedShreddingState<'a>, ArrowError>

Performs the conversion.