Struct FamStructWrapper

pub struct FamStructWrapper<T: Default + FamStruct> { /* private fields */ }

A wrapper for FamStruct.

It helps in treating a FamStruct similarly to an actual Vec.

Implementations

impl<T: Default + FamStruct> FamStructWrapper<T>

pub fn new(num_elements: usize) -> Result<FamStructWrapper<T>, Error>

Create a new FamStructWrapper with num_elements elements.

The elements will be zero-initialized. The type of the elements will be FamStruct::Entry.

Arguments

• num_elements - The number of elements in the FamStructWrapper.

Errors

When num_elements is greater than the max possible len, it returns Error::SizeLimitExceeded.

pub fn from_entries(entries: &[T::Entry]) -> Result<FamStructWrapper<T>, Error>

Create a new FamStructWrapper from a slice of elements.

Arguments

• entries - The slice of FamStruct::Entry entries.

Errors

When the size of entries is greater than the max possible len, it returns Error::SizeLimitExceeded.

pub unsafe fn from_raw(content: Vec<T>) -> Self

Create a new FamStructWrapper from the raw content represented as Vec<T>.

Sometimes we already have the raw content of an FAM struct represented as Vec<T>, and want to use the FamStructWrapper as accessors.

Arguments

• content - The raw content represented as Vec[T].

Safety

This function is unsafe because the caller needs to ensure that the raw content is correctly layed out.

pub fn into_raw(self) -> Vec<T>

Consume the FamStructWrapper and return the raw content as Vec<T>.

pub fn as_fam_struct_ref(&self) -> &T

Get a reference to the actual FamStruct instance.

pub fn as_mut_fam_struct(&mut self) -> &mut T

Get a mut reference to the actual FamStruct instance.

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

Get a pointer to the FamStruct instance.

The caller must ensure that the fam_struct outlives the pointer this function returns, or else it will end up pointing to garbage.

Modifying the container referenced by this pointer may cause its buffer to be reallocated, which would also make any pointers to it invalid.

pub fn as_mut_fam_struct_ptr(&mut self) -> *mut T

Get a mutable pointer to the FamStruct instance.

The caller must ensure that the fam_struct outlives the pointer this function returns, or else it will end up pointing to garbage.

Modifying the container referenced by this pointer may cause its buffer to be reallocated, which would also make any pointers to it invalid.

pub fn as_slice(&self) -> &[T::Entry]

Get the elements slice.

pub fn as_mut_slice(&mut self) -> &mut [T::Entry]

Get the mutable elements slice.

pub fn push(&mut self, entry: T::Entry) -> Result<(), Error>

Append an element.

Arguments

• entry - The element that will be appended to the end of the collection.

Errors

When len is already equal to max possible len it returns Error::SizeLimitExceeded.

pub fn retain<P>(&mut self, f: P)

where P: FnMut(&T::Entry) -> bool,

Retain only the elements specified by the predicate.

Arguments

• f - The function used to evaluate whether an entry will be kept or not. When f returns true the entry is kept.

Trait Implementations

impl<T: Default + FamStruct> Clone for FamStructWrapper<T>

fn clone(&self) -> Self

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<T: Debug + Default + FamStruct> Debug for FamStructWrapper<T>

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

Formats the value using the given formatter.

impl<T: Default + FamStruct> From<Vec<T>> for FamStructWrapper<T>

fn from(vec: Vec<T>) -> Self

Converts to this type from the input type.

impl<T: Default + FamStruct + PartialEq> PartialEq for FamStructWrapper<T>

fn eq(&self, other: &FamStructWrapper<T>) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.