Struct MetadataKey 

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

One caller-owned metadata key: <namespace>.<name>, at least two non-empty segments separated by dots, whose first segment is not MetadataKey::RESERVED_NAMESPACE.

Validated wherever one is built, deserialized included, so a plugin handed one never has to ask whether it names a key this product owns.

Implementations

impl MetadataKey

pub const RESERVED_NAMESPACE: &'static str = "onetaskgraph"

The namespace this product owns, and a narrow write therefore never names.

Every key the contract reserves lives under it — onetaskgraph.origin, onetaskgraph.repositories, onetaskgraph.depends_on, onetaskgraph.delivers, onetaskgraph.delivered_by, onetaskgraph.item_kind and onetaskgraph.template (Self::TEMPLATE_KEY) — and so does any key it reserves later, which is why the whole namespace is refused rather than a list.

pub const TEMPLATE_KEY: &'static str = "onetaskgraph.template"

The reserved key a task or a document rendered from a template records where it came from under: an object holding the template’s reference, the chain digest it was rendered with, and the SHA-256 of its content and of its resolved answers.

A key of this product’s own, so no MetadataKey can name it: only a rendering write — TaskSource::write_task_rendered and TaskSource::set_task_rendering and their document siblings — ever sets it, and a copy carries it like any other entry. The engine builds and reads the value; a plugin only puts it where its metadata lives.

pub fn new(key: impl Into<String>) -> Result<Self, String>

One key, once it is established it is a caller’s own dotted key.

Errors

Returns a message saying why, and what to write instead, when the key has no dot, has an empty segment, or is in Self::RESERVED_NAMESPACE.

pub fn as_str(&self) -> &str

The key as a record’s metadata map spells it.

Trait Implementations

impl Clone for MetadataKey

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for MetadataKey

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for MetadataKey

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for MetadataKey

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

Formats the value using the given formatter.

impl Eq for MetadataKey

impl From<MetadataKey> for String

fn from(key: MetadataKey) -> Self

Converts to this type from the input type.

impl Hash for MetadataKey

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

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 JsonSchema for MetadataKey

fn schema_name() -> Cow<'static, str>

The name of the generated JSON Schema.

fn schema_id() -> Cow<'static, str>

Returns a string that uniquely identifies the schema produced by this type.

fn json_schema(generator: &mut SchemaGenerator) -> Schema

Generates a JSON Schema for this type.

fn inline_schema() -> bool

Whether JSON Schemas generated for this type should be included directly in parent schemas, rather than being re-used where possible using the $ref keyword.

impl Ord for MetadataKey

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

fn clamp_to<R>(self, range: R) -> Self

where Self: Sized, R: ClampBounds<Self>,

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

Restrict a value to a certain range.

impl PartialEq for MetadataKey

fn eq(&self, other: &Self) -> bool

Equality operator ==.

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

Inequality operator !=.

impl PartialOrd for MetadataKey

fn partial_cmp(&self, other: &Self) -> 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 Serialize for MetadataKey

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for MetadataKey

impl TryFrom<String> for MetadataKey

type Error = String

The type returned in the event of a conversion error.

fn try_from(key: String) -> Result<Self, Self::Error>

Performs the conversion.