Struct Metadata 

pub struct Metadata<N, K, L, W, WV, A, AV>
where
    N: Field,
    K: Field,
    L: Field,
    W: Field,
    WV: WeightValue,
    A: Field,
    AV: AnnotationValue,
{
    pub id: Uuid,
    pub name: Option<N>,
    pub kind: Option<K>,
    pub labels: BTreeSet<L>,
    pub weights: BTreeMap<W, WV>,
    pub annotations: BTreeMap<A, AV>,
}

Metadata for any object.

Fields

id: Uuid

Instance identifier. Defaults to a randomly generated UUIDv4.

name: Option<N>

Name associated with this instance.

kind: Option<K>

Kind of object or main category associated with this instance.

labels: BTreeSet<L>

Set of labels associated with this instance.

weights: BTreeMap<W, WV>

Numerical weights associated with this instance.

annotations: BTreeMap<A, AV>

Free-form annotations associated with this instance.

Implementations

impl<N, K, L, W, WV, A, AV> Metadata<N, K, L, W, WV, A, AV>

where N: Field, K: Field, L: Field, W: Field, WV: WeightValue, A: Field, AV: AnnotationValue,

pub fn builder() -> MetadataBuilder<N, K, L, W, WV, A, AV>

Create an instance of Metadata using the builder syntax

impl<N, K, L, W, WV, A, AV> Metadata<N, K, L, W, WV, A, AV>

where N: Field, K: Field, L: Field, W: Field, WV: WeightValue, A: Field, AV: AnnotationValue,

pub fn as_replace_transaction(self) -> Transaction<N, K, L, W, WV, A, AV>

Creates a “replace” transaction from this metadata.

pub fn as_append_transaction(self) -> Transaction<N, K, L, W, WV, A, AV>

Creates an “append” transaction from this metadata.

impl<N, K, L, W, WV, A, AV> Metadata<N, K, L, W, WV, A, AV>

where N: Field, K: Field, L: Field, W: Field, WV: WeightValue, A: Field, AV: AnnotationValue,

pub fn as_ref<'a>(&'a self) -> MetadataRef<'a, N, K, L, W, WV, A, AV>

Create a metadata reference struct from this instance.

Trait Implementations

impl<N, K, L, W, WV, A, AV> Clone for Metadata<N, K, L, W, WV, A, AV>

where N: Field + Clone, K: Field + Clone, L: Field + Clone, W: Field + Clone, WV: WeightValue + Clone, A: Field + Clone, AV: AnnotationValue + Clone,

fn clone(&self) -> Metadata<N, K, L, W, WV, A, AV>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<N, K, L, W, WV, A, AV> Debug for Metadata<N, K, L, W, WV, A, AV>

where N: Field + Debug, K: Field + Debug, L: Field + Debug, W: Field + Debug, WV: WeightValue + Debug, A: Field + Debug, AV: AnnotationValue + Debug,

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

Formats the value using the given formatter.

impl<N, K, L, W, WV, A, AV> Default for Metadata<N, K, L, W, WV, A, AV>

where N: Field, K: Field, L: Field, W: Field, WV: WeightValue, A: Field, AV: AnnotationValue,

fn default() -> Self

Returns the “default value” for a type.

impl<'de, N, K, L, W, WV, A, AV> Deserialize<'de> for Metadata<N, K, L, W, WV, A, AV>

where N: Field + Deserialize<'de>, K: Field + Deserialize<'de>, L: Field + Deserialize<'de>, W: Field + Deserialize<'de>, WV: WeightValue + Deserialize<'de>, A: Field + Deserialize<'de>, AV: AnnotationValue + Deserialize<'de>, Metadata<N, K, L, W, WV, A, AV>: Default,

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl<N, K, L, W, WV, A, AV> PartialEq for Metadata<N, K, L, W, WV, A, AV>

where N: Field + PartialEq, K: Field + PartialEq, L: Field + PartialEq, W: Field + PartialEq, WV: WeightValue + PartialEq, A: Field + PartialEq, AV: AnnotationValue + PartialEq,

fn eq(&self, other: &Metadata<N, K, L, W, WV, A, AV>) -> 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<'a, N, K, L, W, WV, A, AV> ReadMetadata<'a, N, K, L, W, WV, A, AV> for Metadata<N, K, L, W, WV, A, AV>

where N: Field, K: Field, L: Field, W: Field, WV: WeightValue, A: Field, AV: AnnotationValue,

fn id(&'a self) -> &'a Uuid

Get the ID from metadata.

fn name(&'a self) -> Option<&'a N>

Get the name from metadata.

fn kind(&'a self) -> Option<&'a K>

Get the kind from metadata.

fn labels(&'a self) -> impl Iterator<Item = &'a L>

where L: 'a,

Get the labels from metadata.

fn weights(&'a self) -> impl Iterator<Item = (&'a W, &'a WV)>

where W: 'a, WV: 'a,

Get the weights from metadata.

fn annotations(&'a self) -> impl Iterator<Item = (&'a A, &'a AV)>

where A: 'a, AV: 'a,

Get the annotations from metadata.

impl<N, K, L, W, WV, A, AV> Serialize for Metadata<N, K, L, W, WV, A, AV>

where N: Field + Serialize, K: Field + Serialize, L: Field + Serialize, W: Field + Serialize, WV: WeightValue + Serialize, A: Field + Serialize, AV: AnnotationValue + Serialize,

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl<N, K, L, W, WV, A, AV> StructuralPartialEq for Metadata<N, K, L, W, WV, A, AV>

where N: Field, K: Field, L: Field, W: Field, WV: WeightValue, A: Field, AV: AnnotationValue,