Struct MetadataMatch 

pub struct MetadataMatch { /* private fields */ }

One caller-defined metadata value a task must hold.

The location is a top-level metadata key — which may itself contain dots, such as orchestrator.follow-up — and zero or more nested object keys below it. The match holds when the value there is a JSON string equal to value, case-sensitively; a number, a boolean, an array, an object, a missing key and a path through a non-object all fail it.

Neither the key nor a nested segment may be empty, which is checked wherever one is built, deserialized included, so a source handed one never has to ask what an empty location means.

Implementations

impl MetadataMatch

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

A match for value at key and the nested path under it.

Errors

Returns a message naming the location and what to write instead when the key or one of the segments is empty.

pub fn key(&self) -> &str

The top-level metadata key.

pub fn path(&self) -> &[String]

The nested object keys under key, outermost first.

pub fn value(&self) -> &str

The string the value at this location must equal.

pub fn holds(&self, metadata: &BTreeMap<String, Value>) -> bool

Whether metadata holds value as a string at this location.

Trait Implementations

impl Clone for MetadataMatch

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 MetadataMatch

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for MetadataMatch

fn deserialize<D: Deserializer<'de>>(deserializer: D) -> Result<Self, D::Error>

Deserialize this value from the given Serde deserializer.

impl Eq for MetadataMatch

impl JsonSchema for MetadataMatch

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 PartialEq for MetadataMatch

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

Equality operator ==.

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

Inequality operator !=.

impl Serialize for MetadataMatch

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 MetadataMatch