Struct DecoratorId 

pub struct DecoratorId(/* private fields */);

An opaque handle to a Decorator in some MastForest. It is the responsibility of the user to use a given DecoratorId with the corresponding MastForest.

Implementations

impl DecoratorId

pub fn from_u32_safe( value: u32, mast_forest: &MastForest, ) -> Result<DecoratorId, DeserializationError>

Returns a new DecoratorId with the provided inner value, or an error if the provided value is greater than the number of nodes in the forest.

For use in deserialization.

pub fn from_u32_bounded( value: u32, bound: usize, ) -> Result<DecoratorId, DeserializationError>

Returns a new DecoratorId with the provided inner value, or an error if the provided value is greater than or equal to bound.

For use in deserialization when the bound is known without needing the full MastForest.

Trait Implementations

impl Clone for DecoratorId

fn clone(&self) -> DecoratorId

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for DecoratorId

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

Formats the value using the given formatter.

impl Deserializable for DecoratorId

fn read_from<R>(source: &mut R) -> Result<DecoratorId, DeserializationError>

where R: ByteReader,

Reads a sequence of bytes from the provided source, attempts to deserialize these bytes into Self, and returns the result.

fn min_serialized_size() -> usize

Returns the minimum serialized size for one instance of this type.

fn read_from_bytes(bytes: &[u8]) -> Result<Self, DeserializationError>

Attempts to deserialize the provided bytes into Self and returns the result.

fn read_from_bytes_with_budget( bytes: &[u8], budget: usize, ) -> Result<Self, DeserializationError>

Deserializes Self from bytes with a byte budget limit.

impl<'de> Deserialize<'de> for DecoratorId

fn deserialize<__D>( __deserializer: __D, ) -> Result<DecoratorId, <__D as Deserializer<'de>>::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for DecoratorId

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

Formats the value using the given formatter.

impl From<u32> for DecoratorId

fn from(value: u32) -> DecoratorId

Converts to this type from the input type.

impl Hash for DecoratorId

fn hash<__H>(&self, state: &mut __H)

where __H: Hasher,

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl Idx for DecoratorId

fn to_usize(self) -> usize

Convert from this ID type to usize.

impl Index<DecoratorId> for MastForest

type Output = Decorator

The returned type after indexing.

fn index( &self, decorator_id: DecoratorId, ) -> &<MastForest as Index<DecoratorId>>::Output

Performs the indexing (container[index]) operation.

impl IndexMut<DecoratorId> for MastForest

fn index_mut( &mut self, decorator_id: DecoratorId, ) -> &mut <MastForest as Index<DecoratorId>>::Output

Performs the mutable indexing (container[index]) operation.

impl Ord for DecoratorId

fn cmp(&self, other: &DecoratorId) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized,

Restrict a value to a certain interval.

impl PartialEq for DecoratorId

fn eq(&self, other: &DecoratorId) -> 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.

impl PartialOrd for DecoratorId

fn partial_cmp(&self, other: &DecoratorId) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

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

Tests less than (for self and other) and is used by the < operator.

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

Tests less than or equal to (for self and other) and is used by the <= operator.

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

Tests greater than (for self and other) and is used by the > operator.

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

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl Serializable for DecoratorId

fn write_into<W>(&self, target: &mut W)

where W: ByteWriter,

Serializes self into bytes and writes these bytes into the target.

fn to_bytes(&self) -> Vec<u8>

Serializes self into a vector of bytes.

fn get_size_hint(&self) -> usize

Returns an estimate of how many bytes are needed to represent self.

impl Serialize for DecoratorId

fn serialize<__S>( &self, __serializer: __S, ) -> Result<<__S as Serializer>::Ok, <__S as Serializer>::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl Copy for DecoratorId

impl Eq for DecoratorId

impl StructuralPartialEq for DecoratorId