Struct AnnotationSet 

pub struct AnnotationSet { /* private fields */ }

A deterministic annotation collection.

Implementations

impl AnnotationSet

pub const fn new() -> Self

Creates an empty annotation set.

pub fn insert(&mut self, annotation: Annotation) -> Option<AnnotationValue>

Inserts an annotation and returns the previous value for the key, if any.

pub fn insert_pair( &mut self, key: impl AsRef<str>, value: impl Into<AnnotationValue>, ) -> Result<Option<AnnotationValue>, AnnotationKeyError>

Inserts a key-value pair and returns the previous value for the key, if any.

Errors

Returns AnnotationKeyError::Empty when the key is empty.

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

Gets a value by key text.

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

Removes a value by key text.

pub fn iter(&self) -> impl Iterator<Item = (&AnnotationKey, &AnnotationValue)>

Iterates annotations in deterministic key order.

pub fn len(&self) -> usize

Returns the number of annotations.

pub fn is_empty(&self) -> bool

Returns true when the set has no annotations.

Trait Implementations

impl Clone for AnnotationSet

fn clone(&self) -> AnnotationSet

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for AnnotationSet

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

Formats the value using the given formatter.

impl Default for AnnotationSet

fn default() -> AnnotationSet

Returns the “default value” for a type.

impl PartialEq for AnnotationSet

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

impl StructuralPartialEq for AnnotationSet