Struct AttributeSet 

pub struct AttributeSet { /* private fields */ }

An AttributeSet provides storage and access to all of the attributes attached to a Miden Assembly item, e.g. procedure definition.

Attributes are unique by name, so if you attempt to add multiple attributes with the same name, the last write wins. In Miden Assembly syntax, multiple key-value attributes are merged automatically, and a syntax error is only generated when keys conflict. All other attribute types produce an error if they are declared multiple times on the same item.

Implementations

impl AttributeSet

pub fn new<I>(attrs: I) -> AttributeSet

where I: IntoIterator<Item = Attribute>,

Create a new AttributeSet from attrs

If the input attributes have duplicate entries for the same name, only one will be selected, but it is unspecified which.

pub fn is_empty(&self) -> bool

Returns true if there are no attributes in this set

pub fn len(&self) -> usize

Returns the number of attributes in this set

pub fn has(&self, name: impl AsRef<str>) -> bool

Check if this set has an attributed named name

pub fn get(&self, name: impl AsRef<str>) -> Option<&Attribute>

Get the attribute named name, if one is present.

pub fn get_mut(&mut self, name: impl AsRef<str>) -> Option<&mut Attribute>

Get a mutable reference to the attribute named name, if one is present.

pub fn iter(&self) -> Iter<'_, Attribute>

Get an iterator over the attributes in this set

pub fn iter_mut(&mut self) -> IterMut<'_, Attribute>

Get a mutable iterator over the attributes in this set

pub fn insert(&mut self, attr: Attribute) -> bool

Insert attr in the attribute set, replacing any existing attribute with the same name

Returns true if the insertion was new, or false if the insertion replaced an existing entry.

pub fn insert_new(&mut self, attr: Attribute) -> Result<(), Attribute>

Insert attr in the attribute set, but only if there is no existing attribute with the same name.

Returns Err with attr if there is already an existing attribute with the same name.

pub fn remove(&mut self, name: impl AsRef<str>) -> Option<Attribute>

Removes the attribute named name, if present.

pub fn entry(&mut self, key: Ident) -> AttributeSetEntry<'_>

Gets the given key’s corresponding entry in the set for in-place modfication

pub fn clear(&mut self)

Clear all attributes from the set

Trait Implementations

impl Clone for AttributeSet

fn clone(&self) -> AttributeSet

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for AttributeSet

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

Formats the value using the given formatter.

impl Default for AttributeSet

fn default() -> AttributeSet

Returns the “default value” for a type.

impl Deserializable for AttributeSet

fn read_from<R>(source: &mut R) -> Result<AttributeSet, 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 read_from_bytes(bytes: &[u8]) -> Result<Self, DeserializationError>

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

impl Extend<Attribute> for AttributeSet

fn extend<T>(&mut self, iter: T)

where T: IntoIterator<Item = Attribute>,

Extends a collection with the contents of an iterator.

fn extend_one(&mut self, item: A)

🔬This is a nightly-only experimental API. (extend_one)

Extends a collection with exactly one element.

fn extend_reserve(&mut self, additional: usize)

🔬This is a nightly-only experimental API. (extend_one)

Reserves capacity in a collection for the given number of additional elements.

impl FromIterator<Attribute> for AttributeSet

fn from_iter<T>(iter: T) -> AttributeSet

where T: IntoIterator<Item = Attribute>,

Creates a value from an iterator.

impl PartialEq for AttributeSet

fn eq(&self, other: &AttributeSet) -> 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 Serializable for AttributeSet

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 Eq for AttributeSet

impl StructuralPartialEq for AttributeSet