Struct meshx::attrib::Attribute

pub struct Attribute<I> {
    pub data: AttributeData,
    /* private fields */
}

Mesh attribute with an associated topology I.

This stores values that can be attached to mesh elements.

Fields

data: AttributeData

Underlying attribute data.

This can be used to manipulate attribute values or their references directly.

Implementations

impl<I> Attribute<I>

This type wraps a DataVec to store attribute data. Having the type parameter I allows the compiler verify that attributes are being indexed correctly.

pub fn direct_with_size<T: AttributeValue>(n: usize, def: T) -> Self

Construct a direct attribute with a given size.

pub fn indirect_with_size<T: AttributeValueHash>(n: usize, def: T) -> Self

Construct an indirect attribute with a given size.

pub fn direct_from_vec<T: AttributeValue + Default>(vec: Vec<T>) -> Self

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

pub fn indirect_from_vec<T: AttributeValueHash + Default>( vec: Vec<T>, cache: &mut AttribValueCache ) -> Self

Construct an indirect attribute from a given Vec<T> of data, while saving any repeated values in the given cache.

pub fn indirect_from_data(data: IndirectData) -> Self

Construct an indirect attribute from a given IndirectData instance. It is assumed that the included data is already cached correctly in the associated cache.

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

Produce a slice to the underlying direct attribute data.

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

Produce a mutable slice to the underlying direct attribute data.

pub fn duplicate_empty(&self) -> Self

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

pub fn duplicate_with( &self, duplicate_data: impl FnOnce(&mut VecDyn<dyn HasAttributeValue>, Slice<'_, dyn HasAttributeValue>) ) -> Self

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

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

pub fn duplicate_with_len( &self, len: usize, init: impl FnOnce(DataSliceMut<'_>, DataSlice<'_>) ) -> Self

Construct a new attribute with the same buffer type, default element and topology type 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 promote_empty<J>(&self) -> Attribute<J>

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

In contrast to duplicate_empty this function allows the new attribute to correspond with a different topology.

pub fn promote<J>(&self) -> Attribute<J>

Construct a new attribute with the same data and default element as self, but corresponding to a different topology.

pub fn promote_into<J>(self) -> Attribute<J>

Construct a new attribute with the same data and default element as self, but corresponding to a different topology.

This function consumes the given attribute.

pub fn promote_with<J>( &self, promote_data: impl FnOnce(&mut VecDyn<dyn HasAttributeValue>, Slice<'_, dyn HasAttributeValue>) ) -> Attribute<J>

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

pub fn promote_with_len<J>( &self, len: usize, init: impl FnOnce(DataSliceMut<'_>, DataSlice<'_>) ) -> Attribute<J>

Construct a new attribute with the same buffer type and 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 direct_from_slice<T: AttributeValue + Default>(data: &[T]) -> Self

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

pub fn indirect_from_slice<T: AttributeValueHash + Default>( data: &[T], cache: &mut AttribValueCache ) -> Self

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

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

Get the type data stored within this attribute

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

Get the mutable typed data stored within this attribute

pub fn iter<'a, T: Any>( &'a self ) -> Result<Box<dyn Iterator<Item = &'a T> + 'a>, Error>

Produce an iterator over the underlying data elements.

pub fn direct_iter<T: Any>(&self) -> Result<Iter<'_, T>, Error>

Produce an iterator over the underlying data elements for a direct attribute.

pub fn indirect_iter<T: Any>(&self) -> Result<impl Iterator<Item = &T>, Error>

Produce an iterator over the underlying data elements for an indirect attribute.

pub fn direct_iter_mut<T: Any>(&mut self) -> Result<IterMut<'_, T>, Error>

Produce a mutable iterator over the underlying data elements for a direct attribute.

pub fn indirect_update_with<T, F>( &mut self, f: F, cache: &mut AttribValueCache ) -> Result<&mut Self, Error>

where T: AttributeValueHash, F: FnMut(usize, &Irc<T>) -> Option<Irc<T>>,

Iterate over all the value in this attribute and update them as needed.

This function takes a closure which takes an index and a smart pointer to the stored value and produces an optional new value. The new value is then used to update the attribute using the provided cache.

pub fn clone_into_vec<T: AttributeValueHash>(&self) -> Result<Vec<T>, Error>

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

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

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

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 is_empty(&self) -> bool

Check if there are any values in this attribute.

pub fn data_slice(&self) -> DataSlice<'_>

Get a reference to the internal data as a DataSlice.

pub fn data_mut_slice(&mut self) -> DataSliceMut<'_>

Get a mutable reference to the internal data as a DataSliceMut.

pub fn into_data(self) -> DataVec

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)

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)

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 default_element(&self) -> ValueRef<'_>

Get a reference to the default element.

impl Attribute<MeshIndex>

pub fn get<T: Any + Copy, I: Into<MeshIndex>>(&self, i: I) -> Result<T, Error>

Get i’th attribute value.

pub fn get_ref<T: Any, I: Into<MeshIndex>>(&self, i: I) -> Result<&T, Error>

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

pub fn get_mut<T: Any, I: Into<MeshIndex>>( &mut self, i: I ) -> Result<&mut T, Error>

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

This function works only on direct attributes. Indirect attributes cannot be modified via mutable references, since they employ a special caching mechanism which aliases each stored element.

impl Attribute<VertexIndex>

pub fn get<T: Any + Copy, I: Into<VertexIndex>>(&self, i: I) -> Result<T, Error>

Get i’th attribute value.

pub fn get_ref<T: Any, I: Into<VertexIndex>>(&self, i: I) -> Result<&T, Error>

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

pub fn get_mut<T: Any, I: Into<VertexIndex>>( &mut self, i: I ) -> Result<&mut T, Error>

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

This function works only on direct attributes. Indirect attributes cannot be modified via mutable references, since they employ a special caching mechanism which aliases each stored element.

impl Attribute<EdgeIndex>

pub fn get<T: Any + Copy, I: Into<EdgeIndex>>(&self, i: I) -> Result<T, Error>

Get i’th attribute value.

pub fn get_ref<T: Any, I: Into<EdgeIndex>>(&self, i: I) -> Result<&T, Error>

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

pub fn get_mut<T: Any, I: Into<EdgeIndex>>( &mut self, i: I ) -> Result<&mut T, Error>

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

This function works only on direct attributes. Indirect attributes cannot be modified via mutable references, since they employ a special caching mechanism which aliases each stored element.

impl Attribute<FaceIndex>

pub fn get<T: Any + Copy, I: Into<FaceIndex>>(&self, i: I) -> Result<T, Error>

Get i’th attribute value.

pub fn get_ref<T: Any, I: Into<FaceIndex>>(&self, i: I) -> Result<&T, Error>

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

pub fn get_mut<T: Any, I: Into<FaceIndex>>( &mut self, i: I ) -> Result<&mut T, Error>

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

This function works only on direct attributes. Indirect attributes cannot be modified via mutable references, since they employ a special caching mechanism which aliases each stored element.

impl Attribute<CellIndex>

pub fn get<T: Any + Copy, I: Into<CellIndex>>(&self, i: I) -> Result<T, Error>

Get i’th attribute value.

pub fn get_ref<T: Any, I: Into<CellIndex>>(&self, i: I) -> Result<&T, Error>

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

pub fn get_mut<T: Any, I: Into<CellIndex>>( &mut self, i: I ) -> Result<&mut T, Error>

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

This function works only on direct attributes. Indirect attributes cannot be modified via mutable references, since they employ a special caching mechanism which aliases each stored element.

impl Attribute<EdgeVertexIndex>

pub fn get<T: Any + Copy, I: Into<EdgeVertexIndex>>( &self, i: I ) -> Result<T, Error>

Get i’th attribute value.

pub fn get_ref<T: Any, I: Into<EdgeVertexIndex>>( &self, i: I ) -> Result<&T, Error>

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

pub fn get_mut<T: Any, I: Into<EdgeVertexIndex>>( &mut self, i: I ) -> Result<&mut T, Error>

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

This function works only on direct attributes. Indirect attributes cannot be modified via mutable references, since they employ a special caching mechanism which aliases each stored element.

impl Attribute<FaceVertexIndex>

pub fn get<T: Any + Copy, I: Into<FaceVertexIndex>>( &self, i: I ) -> Result<T, Error>

Get i’th attribute value.

pub fn get_ref<T: Any, I: Into<FaceVertexIndex>>( &self, i: I ) -> Result<&T, Error>

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

pub fn get_mut<T: Any, I: Into<FaceVertexIndex>>( &mut self, i: I ) -> Result<&mut T, Error>

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

This function works only on direct attributes. Indirect attributes cannot be modified via mutable references, since they employ a special caching mechanism which aliases each stored element.

impl Attribute<FaceEdgeIndex>

pub fn get<T: Any + Copy, I: Into<FaceEdgeIndex>>( &self, i: I ) -> Result<T, Error>

Get i’th attribute value.

pub fn get_ref<T: Any, I: Into<FaceEdgeIndex>>(&self, i: I) -> Result<&T, Error>

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

pub fn get_mut<T: Any, I: Into<FaceEdgeIndex>>( &mut self, i: I ) -> Result<&mut T, Error>

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

This function works only on direct attributes. Indirect attributes cannot be modified via mutable references, since they employ a special caching mechanism which aliases each stored element.

impl Attribute<CellVertexIndex>

pub fn get<T: Any + Copy, I: Into<CellVertexIndex>>( &self, i: I ) -> Result<T, Error>

Get i’th attribute value.

pub fn get_ref<T: Any, I: Into<CellVertexIndex>>( &self, i: I ) -> Result<&T, Error>

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

pub fn get_mut<T: Any, I: Into<CellVertexIndex>>( &mut self, i: I ) -> Result<&mut T, Error>

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

This function works only on direct attributes. Indirect attributes cannot be modified via mutable references, since they employ a special caching mechanism which aliases each stored element.

impl Attribute<CellEdgeIndex>

pub fn get<T: Any + Copy, I: Into<CellEdgeIndex>>( &self, i: I ) -> Result<T, Error>

Get i’th attribute value.

pub fn get_ref<T: Any, I: Into<CellEdgeIndex>>(&self, i: I) -> Result<&T, Error>

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

pub fn get_mut<T: Any, I: Into<CellEdgeIndex>>( &mut self, i: I ) -> Result<&mut T, Error>

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

This function works only on direct attributes. Indirect attributes cannot be modified via mutable references, since they employ a special caching mechanism which aliases each stored element.

impl Attribute<CellFaceIndex>

pub fn get<T: Any + Copy, I: Into<CellFaceIndex>>( &self, i: I ) -> Result<T, Error>

Get i’th attribute value.

pub fn get_ref<T: Any, I: Into<CellFaceIndex>>(&self, i: I) -> Result<&T, Error>

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

pub fn get_mut<T: Any, I: Into<CellFaceIndex>>( &mut self, i: I ) -> Result<&mut T, Error>

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

This function works only on direct attributes. Indirect attributes cannot be modified via mutable references, since they employ a special caching mechanism which aliases each stored element.

impl Attribute<VertexEdgeIndex>

pub fn get<T: Any + Copy, I: Into<VertexEdgeIndex>>( &self, i: I ) -> Result<T, Error>

Get i’th attribute value.

pub fn get_ref<T: Any, I: Into<VertexEdgeIndex>>( &self, i: I ) -> Result<&T, Error>

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

pub fn get_mut<T: Any, I: Into<VertexEdgeIndex>>( &mut self, i: I ) -> Result<&mut T, Error>

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

This function works only on direct attributes. Indirect attributes cannot be modified via mutable references, since they employ a special caching mechanism which aliases each stored element.

impl Attribute<VertexFaceIndex>

pub fn get<T: Any + Copy, I: Into<VertexFaceIndex>>( &self, i: I ) -> Result<T, Error>

Get i’th attribute value.

pub fn get_ref<T: Any, I: Into<VertexFaceIndex>>( &self, i: I ) -> Result<&T, Error>

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

pub fn get_mut<T: Any, I: Into<VertexFaceIndex>>( &mut self, i: I ) -> Result<&mut T, Error>

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

This function works only on direct attributes. Indirect attributes cannot be modified via mutable references, since they employ a special caching mechanism which aliases each stored element.

impl Attribute<VertexCellIndex>

pub fn get<T: Any + Copy, I: Into<VertexCellIndex>>( &self, i: I ) -> Result<T, Error>

Get i’th attribute value.

pub fn get_ref<T: Any, I: Into<VertexCellIndex>>( &self, i: I ) -> Result<&T, Error>

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

pub fn get_mut<T: Any, I: Into<VertexCellIndex>>( &mut self, i: I ) -> Result<&mut T, Error>

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

This function works only on direct attributes. Indirect attributes cannot be modified via mutable references, since they employ a special caching mechanism which aliases each stored element.

impl Attribute<EdgeFaceIndex>

pub fn get<T: Any + Copy, I: Into<EdgeFaceIndex>>( &self, i: I ) -> Result<T, Error>

Get i’th attribute value.

pub fn get_ref<T: Any, I: Into<EdgeFaceIndex>>(&self, i: I) -> Result<&T, Error>

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

pub fn get_mut<T: Any, I: Into<EdgeFaceIndex>>( &mut self, i: I ) -> Result<&mut T, Error>

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

This function works only on direct attributes. Indirect attributes cannot be modified via mutable references, since they employ a special caching mechanism which aliases each stored element.

impl Attribute<EdgeCellIndex>

pub fn get<T: Any + Copy, I: Into<EdgeCellIndex>>( &self, i: I ) -> Result<T, Error>

Get i’th attribute value.

pub fn get_ref<T: Any, I: Into<EdgeCellIndex>>(&self, i: I) -> Result<&T, Error>

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

pub fn get_mut<T: Any, I: Into<EdgeCellIndex>>( &mut self, i: I ) -> Result<&mut T, Error>

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

This function works only on direct attributes. Indirect attributes cannot be modified via mutable references, since they employ a special caching mechanism which aliases each stored element.

impl Attribute<FaceCellIndex>

pub fn get<T: Any + Copy, I: Into<FaceCellIndex>>( &self, i: I ) -> Result<T, Error>

Get i’th attribute value.

pub fn get_ref<T: Any, I: Into<FaceCellIndex>>(&self, i: I) -> Result<&T, Error>

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

pub fn get_mut<T: Any, I: Into<FaceCellIndex>>( &mut self, i: I ) -> Result<&mut T, Error>

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

This function works only on direct attributes. Indirect attributes cannot be modified via mutable references, since they employ a special caching mechanism which aliases each stored element.

Trait Implementations

impl<I: Clone> Clone for Attribute<I>

fn clone(&self) -> Attribute<I>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<I: Debug> Debug for Attribute<I>

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

Formats the value using the given formatter.

impl<I: PartialEq> PartialEq for Attribute<I>

fn eq(&self, other: &Attribute<I>) -> bool

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

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

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

impl<I> StructuralPartialEq for Attribute<I>