Struct TrackedArrayBase 

pub struct TrackedArrayBase<'scope, 'data, T, const N: isize> { /* private fields */ }

A tracked array that provides immutable access

Implementations

impl<'scope, 'data, T, const N: isize> TrackedArrayBase<'scope, 'data, T, N>

pub fn bits_data<'borrow>( &'borrow self, ) -> BitsAccessor<'borrow, 'scope, 'data, T, T, N>

where T: ConstructType + ValidField + IsBits,

Create an accessor for isbits data.

Thanks to the restrictions on T the data is guaranteed to be stored inline as an array of Ts.

pub fn bits_data_with_layout<'borrow, L>( &'borrow self, ) -> BitsAccessor<'borrow, 'scope, 'data, T, L, N>

where T: ConstructType + HasLayout<'static, 'static, Layout = L>, L: IsBits + ValidField,

Create an accessor for isbits data with layout L.

Thanks to the restrictions on T and L the elements are guaranteed to be stored inline as an array of Ls.

pub fn try_bits_data<'borrow, L>( &'borrow self, ) -> JlrsResult<BitsAccessor<'borrow, 'scope, 'data, T, L, N>>

where L: IsBits + ValidField,

Try to create an accessor for isbits data with layout L.

If the array doesn’t have an isbits layout ArrayLayoutError::NotBits is returned. If L is not a valid field layout for the element type TypeError::InvalidLayout is returned.

pub unsafe fn bits_data_unchecked<'borrow, L>( &'borrow self, ) -> BitsAccessor<'borrow, 'scope, 'data, T, L, N>

where L: IsBits + ValidField,

Create an accessor for isbits data with layout L without checking any invariants.

Safety:

The element type must be an isbits type, and L must be a valid field layout of the element type.

pub fn inline_data<'borrow>( &'borrow self, ) -> InlineAccessor<'borrow, 'scope, 'data, T, T, N>

where T: ConstructType + ValidField,

Create an accessor for inline data.

Thanks to the restrictions on T the data is guaranteed to be stored inline as an array of Ts.

pub fn inline_data_with_layout<'borrow, L>( &'borrow self, ) -> InlineAccessor<'borrow, 'scope, 'data, T, L, N>

where T: ConstructType + HasLayout<'scope, 'data, Layout = L>, L: ValidField,

Create an accessor for inline data with layout L.

Thanks to the restrictions on T and L the elements are guaranteed to be stored inline as an array of Ls.

pub fn try_inline_data<'borrow, L>( &'borrow self, ) -> JlrsResult<InlineAccessor<'borrow, 'scope, 'data, T, L, N>>

where L: ValidField,

Try to create an accessor for inline data with layout L.

If the array doesn’t have an inline layout ArrayLayoutError::NotInline is returned. If L is not a valid field layout for the element type TypeError::InvalidLayout is returned.

pub unsafe fn inline_data_unchecked<'borrow, L>( &'borrow self, ) -> InlineAccessor<'borrow, 'scope, 'data, T, L, N>

where L: ValidField,

Create an accessor for inline data with layout L without checking any invariants.

Safety:

The elements must be stored inline, and L must be a valid field layout of the element type.

pub fn union_data<'borrow>( &'borrow self, ) -> BitsUnionAccessor<'borrow, 'scope, 'data, T, N>

where T: BitsUnionCtor,

Create an accessor for unions of isbits types.

This function panics if the array doesn’t have a union layout.

pub fn try_union_data<'borrow>( &'borrow self, ) -> JlrsResult<BitsUnionAccessor<'borrow, 'scope, 'data, T, N>>

Try to create an accessor for unions of isbits types.

If the element type is not a union of isbits types ArrayLayoutError::NotUnion is returned.

pub unsafe fn union_data_unchecked<'borrow>( &'borrow self, ) -> BitsUnionAccessor<'borrow, 'scope, 'data, T, N>

Create an accessor for unions of isbits types without checking any invariants.

Safety:

The element type must be a union of isbits types.

pub fn managed_data<'borrow>( &'borrow self, ) -> ManagedAccessor<'borrow, 'scope, 'data, T, T, N>

where T: Managed<'scope, 'data> + ConstructType,

Create an accessor for managed data.

Thanks to the restrictions on T the data is guaranteed to be as an array of Option<Weak<T>>s.

pub fn try_managed_data<'borrow, L>( &'borrow self, ) -> JlrsResult<ManagedAccessor<'borrow, 'scope, 'data, T, L, N>>

where L: Managed<'scope, 'data> + Typecheck,

Try to create an accessor for managed data of type L.

If the element type is incompatible with L ArrayLayoutError::NotManaged is returned.

pub unsafe fn managed_data_unchecked<'borrow, L>( &'borrow self, ) -> ManagedAccessor<'borrow, 'scope, 'data, T, L, N>

where L: Managed<'scope, 'data>,

Create an accessor for managed data of type L without checking any invariants.

Safety:

The element type must be compatible with L.

pub fn value_data<'borrow>( &'borrow self, ) -> ValueAccessor<'borrow, 'scope, 'data, T, N>

where T: Managed<'scope, 'data> + ConstructType,

Create an accessor for value data.

Thanks to the restrictions on T the data is guaranteed to be as an array of Option<Weak<Value>>s.

pub fn try_value_data<'borrow>( &'borrow self, ) -> JlrsResult<ValueAccessor<'borrow, 'scope, 'data, T, N>>

Try to create an accessor for value data.

If the elements are stored inline ArrayLayoutError::NotPointer is returned.

pub unsafe fn value_data_unchecked<'borrow>( &'borrow self, ) -> ValueAccessor<'borrow, 'scope, 'data, T, N>

Create an accessor for managed data of type L without checking any invariants.

Safety:

The elements must not be stored inline.

pub fn indeterminate_data<'borrow>( &'borrow self, ) -> IndeterminateAccessor<'borrow, 'scope, 'data, T, N>

Create an accessor for indeterminate data.

Methods from Deref<Target = ArrayBase<'scope, 'data, T, N>>

pub fn dimensions<'borrow>(&'borrow self) -> ArrayDimensions<'borrow, N>

Returns the dimensions of this array.

pub fn zero_init(&self) -> bool

Returns true if the elements are zero-initialized.

pub unsafe fn bits_data<'borrow>( &'borrow self, ) -> BitsAccessor<'borrow, 'scope, 'data, T, T, N>

where T: ConstructType + ValidField + IsBits,

Create an accessor for isbits data.

Thanks to the restrictions on T the data is guaranteed to be stored inline as an array of Ts.

Safety:

No mutable accessors to this data must exist.

pub unsafe fn bits_data_with_layout<'borrow, L>( &'borrow self, ) -> BitsAccessor<'borrow, 'scope, 'data, T, L, N>

where T: ConstructType + HasLayout<'static, 'static, Layout = L>, L: IsBits + ValidField,

Create an accessor for isbits data with layout L.

Thanks to the restrictions on T and L the elements are guaranteed to be stored inline as an array of Ls.

Safety:

No mutable accessors to this data must exist.

pub unsafe fn try_bits_data<'borrow, L>( &'borrow self, ) -> JlrsResult<BitsAccessor<'borrow, 'scope, 'data, T, L, N>>

where L: IsBits + ValidField,

Try to create an accessor for isbits data with layout L.

If the array doesn’t have an isbits layout ArrayLayoutError::NotBits is returned. If L is not a valid field layout for the element type TypeError::InvalidLayout is returned.

Safety:

No mutable accessors to this data must exist.

pub unsafe fn bits_data_unchecked<'borrow, L>( &'borrow self, ) -> BitsAccessor<'borrow, 'scope, 'data, T, L, N>

where L: IsBits + ValidField,

Create an accessor for isbits data with layout L without checking any invariants.

Safety:

No mutable accessors to this data must exist. The element type must be an isbits type, and L must be a valid field layout of the element type.

pub unsafe fn inline_data<'borrow>( &'borrow self, ) -> InlineAccessor<'borrow, 'scope, 'data, T, T, N>

where T: ConstructType + ValidField,

Create an accessor for inline data.

Thanks to the restrictions on T the data is guaranteed to be stored inline as an array of Ts.

Safety:

No mutable accessors to this data must exist.

pub unsafe fn inline_data_with_layout<'borrow, L>( &'borrow self, ) -> InlineAccessor<'borrow, 'scope, 'data, T, L, N>

where T: ConstructType + HasLayout<'scope, 'data, Layout = L>, L: ValidField,

Create an accessor for inline data with layout L.

Thanks to the restrictions on T and L the elements are guaranteed to be stored inline as an array of Ls.

Safety:

No mutable accessors to this data must exist.

pub unsafe fn try_inline_data<'borrow, L>( &'borrow self, ) -> JlrsResult<InlineAccessor<'borrow, 'scope, 'data, T, L, N>>

where L: ValidField,

Try to create an accessor for inline data with layout L.

If the array doesn’t have an inline layout ArrayLayoutError::NotInline is returned. If L is not a valid field layout for the element type TypeError::InvalidLayout is returned.

Safety:

No mutable accessors to this data must exist.

pub unsafe fn inline_data_unchecked<'borrow, L>( &'borrow self, ) -> InlineAccessor<'borrow, 'scope, 'data, T, L, N>

where L: ValidField,

Create an accessor for inline data with layout L without checking any invariants.

Safety:

No mutable accessors to this data must exist. The elements must be stored inline, and L must be a valid field layout of the element type.

pub unsafe fn union_data<'borrow>( &'borrow self, ) -> BitsUnionAccessor<'borrow, 'scope, 'data, T, N>

where T: BitsUnionCtor,

Create an accessor for unions of isbits types.

This function panics if the array doesn’t have a union layout.

Safety:

No mutable accessors to this data must exist.

pub unsafe fn try_union_data<'borrow>( &'borrow self, ) -> JlrsResult<BitsUnionAccessor<'borrow, 'scope, 'data, T, N>>

Try to create an accessor for unions of isbits types.

If the element type is not a union of isbits types ArrayLayoutError::NotUnion is returned.

Safety:

No mutable accessors to this data must exist.

pub unsafe fn union_data_unchecked<'borrow>( &'borrow self, ) -> BitsUnionAccessor<'borrow, 'scope, 'data, T, N>

Create an accessor for unions of isbits types without checking any invariants.

Safety:

No mutable accessors to this data must exist. The element type must be a union of isbits types.

pub unsafe fn managed_data<'borrow>( &'borrow self, ) -> ManagedAccessor<'borrow, 'scope, 'data, T, T, N>

where T: Managed<'scope, 'data> + ConstructType,

Create an accessor for managed data.

Thanks to the restrictions on T the data is guaranteed to be as an array of Option<Weak<T>>s.

Safety:

No mutable accessors to this data must exist.

pub unsafe fn try_managed_data<'borrow, L>( &'borrow self, ) -> JlrsResult<ManagedAccessor<'borrow, 'scope, 'data, T, L, N>>

where L: Managed<'scope, 'data> + Typecheck,

Try to create an accessor for managed data of type L.

If the element type is incompatible with L ArrayLayoutError::NotManaged is returned.

Safety:

No mutable accessors to this data must exist.

pub unsafe fn managed_data_unchecked<'borrow, L>( &'borrow self, ) -> ManagedAccessor<'borrow, 'scope, 'data, T, L, N>

where L: Managed<'scope, 'data>,

Create an accessor for managed data of type L without checking any invariants.

Safety:

No mutable accessors to this data must exist. The element type must be compatible with L.

pub unsafe fn value_data<'borrow>( &'borrow self, ) -> ValueAccessor<'borrow, 'scope, 'data, T, N>

where T: Managed<'scope, 'data> + ConstructType,

Create an accessor for value data.

Thanks to the restrictions on T the data is guaranteed to be as an array of Option<Weak<Value>>s.

Safety:

No mutable accessors to this data must exist.

pub unsafe fn try_value_data<'borrow>( &'borrow self, ) -> JlrsResult<ValueAccessor<'borrow, 'scope, 'data, T, N>>

Try to create an accessor for value data.

If the elements are stored inline ArrayLayoutError::NotPointer is returned.

Safety:

No mutable accessors to this data must exist.

pub unsafe fn value_data_unchecked<'borrow>( &'borrow self, ) -> ValueAccessor<'borrow, 'scope, 'data, T, N>

Create an accessor for managed data of type L without checking any invariants.

Safety:

No mutable accessors to this data must exist. The elements must not be stored inline.

pub unsafe fn indeterminate_data<'borrow>( &'borrow self, ) -> IndeterminateAccessor<'borrow, 'scope, 'data, T, N>

Create an accessor for indeterminate data.

Safety:

No mutable accessors to this data must exist.

Trait Implementations

impl<'scope, 'data, T, const N: isize> Clone for TrackedArrayBase<'scope, 'data, T, N>

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<'scope, 'data, T, const N: isize> Deref for TrackedArrayBase<'scope, 'data, T, N>

type Target = ArrayBase<'scope, 'data, T, N>

The resulting type after dereferencing.

fn deref(&self) -> &Self::Target

Dereferences the value.

impl<T, const N: isize> Drop for TrackedArrayBase<'_, '_, T, N>

fn drop(&mut self)

Executes the destructor for this type.