Struct gut::mesh::attrib::DirectData

pub struct DirectData { /* fields omitted */ }

Attribute data stored directly with each associated element.

This type doesn’t store the location of the attribute.

Implementations

impl DirectData

This type wraps a DataVec to store attribute data.

pub fn check<T>(&self) -> Result<&DirectData, Error> where
    T: Any, 

Get the type data stored within this attribute

pub fn check_mut<T>(&mut self) -> Result<&mut DirectData, Error> where
    T: Any, 

Get the mutable typed data stored within this attribute

pub fn element_type_id(&self) -> TypeId

Get the type data stored within this attribute

pub fn element_size(&self) -> usize

Get the number of bytes per element stored in this attribute.

pub fn len(&self) -> usize

Number of elements stored by this attribute. This is the same as the number of elements in the associated topology.

pub fn byte_len(&self) -> usize

Number of bytes stored by this attribute. This is the same as the number of elements multiplied by the size of each element.

pub fn is_empty(&self) -> bool

Check if there are any values in this attribute.

pub unsafe fn get_unchecked_ref<T>(&self, i: usize) -> &T where
    T: Any, 

Get a const reference to the i’th attribute value.

Safety

Calling this method with an out-of-bounds index is undefined behavior even if the output is not used. For a safe alternative use the get_ref method.

pub unsafe fn get_unchecked_mut<T>(&mut self, i: usize) -> &mut T where
    T: Any, 

Get a mutable reference to the i’th attribute value.

Safety

Calling this method with an out-of-bounds index is undefined behavior even if the output is not used. For a safe alternative use the get_mut method.

pub fn data_ref(&self) -> &VecDyn<AttributeValueVTable>

Get a reference to the internal value vector.

pub fn data_mut(&mut self) -> &mut VecDyn<AttributeValueVTable>

Get a mutable reference to the internal value vector.

pub fn into_data(self) -> VecDyn<AttributeValueVTable>

Convert this attribute into the underlying buffer. This consumes the attribute.

pub fn extend_by(&mut self, n: usize)

Extend this attribute by n elements. Effectively, this function appends the default element n number of times to this attribute.

pub fn rotate_left(&mut self, mid: usize)

Rotates elements of this attribute in-place to the left.

Rotate this attribute in-place such that the first mid elements of the underlying buffer move to the end while the last self.len() - mid elements move to the front. After calling rotate_left, the element previously at index mid will become the first element in the slice.

pub fn rotate_right(&mut self, k: usize)

Rotates elements of this attribute in-place to the right.

Rotate this attribute in-place such that the first self.len() - k elements of the underlying buffer move to the end while the last k elements move to the front. After calling rotate_right, the element previously at index self.len() - k will become the first element in the slice.

pub fn with_size<T>(n: usize, def: T) -> DirectData where
    T: AttributeValue, 

Construct an attribute with a given size.

pub fn from_vec<T>(vec: Vec<T, Global>) -> DirectData where
    T: AttributeValue + Default, 

Construct an attribute from a given Vec<T> of data reusing the space already allocated by the Vec.

pub unsafe fn from_raw_data(
    buf: VecDyn<AttributeValueVTable>,
    default_element: Value<Box<[MaybeUninit<u8>], Global>, AttributeValueVTable>
) -> DirectData

Construct an attribute from a given DataVec of data reusing the space already allocated.

Safety

The given def must be a valid binary representation of an element stored in the given DataVec.

pub fn from_slice<T>(buf: &[T]) -> DirectData where
    T: AttributeValue + Default, 

Construct an attribute from a given slice of data, by copying the data.

pub fn duplicate_empty(&self) -> DirectData

Construct a new empty attribute with the same buffer type and default element as self.

pub fn duplicate_with(
    &self,
    dup_data: impl FnOnce(Slice<'_, AttributeValueVTable>) -> VecDyn<dyn HasAttributeValue + 'static>
) -> DirectData

Construct a new attribute with the same buffer type and default element as self.

The data within the newly created attribute is expected to be initialized with the given function init, which takes the output DataVec for the new attribute and the existing DataSlice from self.

pub fn duplicate_with_len(
    &self,
    len: usize,
    init: impl FnOnce(SliceMut<'_, AttributeValueVTable>, Slice<'_, AttributeValueVTable>)
) -> DirectData

Construct a new attribute with the same buffer type, default element as self.

The attribute is first initialized with the default value by allocating len default elements. Then the newly created buffer is expected to be modified by the init function.

pub fn as_slice<T>(&self) -> Result<&[T], Error> where
    T: Any, 

Produce a slice to the underlying data.

pub fn as_mut_slice<T>(&mut self) -> Result<&mut [T], Error> where
    T: Any, 

Produce a mutable slice to the underlying data.

pub fn clone_into_vec<T>(&self) -> Result<Vec<T, Global>, Error> where
    T: Any + Clone, 

Convert the data stored by this attribute into a vector of the same size.

pub fn push_cloned(
    &mut self,
    new_value_ref: ValueRef<'_, AttributeValueVTable>
) -> Result<&mut DirectData, Error>

Push a value onto the underlying data buffer.

pub fn iter<'a, T>(&'a self) -> Result<Iter<'a, T>, Error> where
    T: 'a + Any, 

Produce an iterator over the underlying data elements.

pub fn iter_mut<'a, T>(&'a mut self) -> Result<IterMut<'a, T>, Error> where
    T: 'a + Any, 

Produce a mutable iterator over the underlying data elements.

pub fn into_vec<T>(self) -> Result<Vec<T, Global>, Error> where
    T: AttributeValue, 

Convert this attribute into a typed vector of T. This consumes the attribute.

pub fn default_element(&self) -> ValueRef<'_, AttributeValueVTable>

Get a reference to the defult element as a byte slice.

Trait Implementations

impl Clone for DirectData

pub fn clone(&self) -> DirectData

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for DirectData

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

Formats the value using the given formatter.

impl PartialEq<DirectData> for DirectData

pub fn eq(&self, other: &DirectData) -> bool

This method tests for self and other values to be equal, and is used by ==.

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

This method tests for !=.

impl StructuralPartialEq for DirectData