Struct jlrs::value::array::TypedArray

#[repr(transparent)]pub struct TypedArray<'frame, 'data, T>(_, _, _, _)
 where
    T: Copy + ValidLayout;

Exactly the same as Array, except it has an explicit element type T.

Implementations

impl<'frame, 'data, T: Copy + ValidLayout> TypedArray<'frame, 'data, T>

pub fn dimensions(self) -> Dimensions

Returns the array's dimensions.

pub fn element_type(self) -> Value<'frame, 'static>

Returns the type of this array's elements.

pub fn is_inline_array(self) -> bool

Returns true if the elements of the array are stored inline.

pub fn has_inlined_pointers(self) -> bool

Returns true if the elements of the array are stored inline and at least one of the field of the inlined type is a pointer.

pub fn is_value_array(self) -> bool

Returns true if the elements of the array are stored as Values.

pub fn copy_inline_data(self) -> JlrsResult<CopiedArray<T>>

Copy the data of an inline array to Rust. Returns JlrsError::NotInline if the data is not stored inline or JlrsError::WrongType if the type of the elements is incorrect.

pub fn inline_data<'borrow, 'fr, F>(
    self,
    frame: &'borrow F
) -> JlrsResult<ArrayData<'borrow, 'fr, T, F>> where
    F: Frame<'fr>, 

Immutably borrow inline array data, you can borrow data from multiple arrays at the same time. Returns JlrsError::NotInline if the data is not stored inline or JlrsError::WrongType if the type of the elements is incorrect.

pub fn inline_data_mut<'borrow, 'fr, F>(
    self,
    frame: &'borrow mut F
) -> JlrsResult<InlineArrayDataMut<'borrow, 'fr, T, F>> where
    F: Frame<'fr>, 

Mutably borrow inline array data, you can mutably borrow a single array at the same time. Returns JlrsError::NotInline if the data is not stored inline or JlrsError::WrongType if the type of the elements is incorrect.

pub unsafe fn unrestricted_inline_data_mut<'borrow, 'fr, F>(
    self,
    frame: &'borrow F
) -> JlrsResult<UnrestrictedInlineArrayDataMut<'borrow, 'fr, T, F>> where
    F: Frame<'fr>, 

Mutably borrow inline array data without the restriction that only a single array can be mutably borrowed. It's your responsibility to ensure you don't create multiple mutable references to the same array data.

Returns JlrsError::NotInline if the data is not stored inline or JlrsError::WrongType if the type of the elements is incorrect.

pub unsafe fn value_data<'borrow, 'fr, F>(
    self,
    frame: &'borrow F
) -> JlrsResult<ArrayData<'borrow, 'fr, Value<'frame, 'data>, F>> where
    F: Frame<'fr>, 

Immutably borrow the data of this value array, you can borrow data from multiple arrays at the same time. The values themselves can be mutable, but you can't replace an element with another value. Returns JlrsError::Inline if the data is stored inline.

Safety: no slot on the GC stack is required to access and use the values in this array, the GC is aware of the array's data. If the element is changed either from Rust or Julia, the original value is no longer protected from garbage collection. If you need to keep using this value you must protect it by calling Value::extend.

pub unsafe fn value_data_mut<'borrow, 'fr, F>(
    self,
    frame: &'borrow mut F
) -> JlrsResult<ValueArrayDataMut<'borrow, 'frame, 'data, 'fr, F>> where
    F: Frame<'fr>, 

Mutably borrow the data of this value array, you can mutably borrow a single array at the same time. Returns JlrsError::Inline if the data is stored inline.

Safety: no slot on the GC stack is required to access and use the values in this array, the GC is aware of the array's data. If the element is changed either from Rust or Julia, the original value is no longer protected from garbage collection. If you need to keep using this value you must protect it by calling Value::extend.

pub unsafe fn unrestricted_value_data_mut<'borrow, 'fr, F>(
    self,
    frame: &'borrow F
) -> JlrsResult<UnrestrictedValueArrayDataMut<'borrow, 'frame, 'data, 'fr, F>> where
    F: Frame<'fr>, 

Mutably borrow the data of this value array without the restriction that only a single array can be mutably borrowed. It's your responsibility to ensure you don't create multiple mutable references to the same array data. Returns JlrsError::Inline if the data is stored inline.

Safety: no slot on the GC stack is required to access and use the values in this array, the GC is aware of the array's data. If the element is changed either from Rust or Julia, the original value is no longer protected from garbage collection. If you need to keep using this value you must protect it by calling Value::extend.

pub fn as_value(self) -> Value<'frame, 'data>

Convert self to a Value.

Trait Implementations

impl<'frame, 'data, T: Copy + ValidLayout> Cast<'frame, 'data> for TypedArray<'frame, 'data, T>

type Output = Self

pub fn cast(value: Value<'frame, 'data>) -> JlrsResult<Self::Output>

pub unsafe fn cast_unchecked(value: Value<'frame, 'data>) -> Self::Output

impl<'frame, 'data, T: Clone> Clone for TypedArray<'frame, 'data, T> where
    T: Copy + ValidLayout, 

pub fn clone(&self) -> TypedArray<'frame, 'data, T>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<'frame, 'data, T: Copy> Copy for TypedArray<'frame, 'data, T> where
    T: Copy + ValidLayout, 

impl<'frame, 'data, T: Debug> Debug for TypedArray<'frame, 'data, T> where
    T: Copy + ValidLayout, 

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

Formats the value using the given formatter.

impl<'frame, 'data, T: Copy + ValidLayout> Into<Array<'frame, 'data>> for TypedArray<'frame, 'data, T>

pub fn into(self) -> Array<'frame, 'data>

Performs the conversion.

impl<'frame, 'data, T: Copy + ValidLayout> Into<Value<'frame, 'data>> for TypedArray<'frame, 'data, T>

pub fn into(self) -> Value<'frame, 'data>

Performs the conversion.

impl<'frame, 'data, T: Copy + ValidLayout> JuliaTypecheck for TypedArray<'frame, 'data, T>

pub unsafe fn julia_typecheck(t: DataType<'_>) -> bool

impl<'frame, 'data, T: Copy + ValidLayout> ValidLayout for TypedArray<'frame, 'data, T>

pub unsafe fn valid_layout(v: Value<'_, '_>) -> bool