Struct MetadataTextMatch 

#[non_exhaustive]
pub struct MetadataTextMatch {
    pub path: String,
    pub value: String,
}

Value shape for the text-matching metadata filter conditions (draft-ietf-jmap-metadata-04 §3.6).

Used as the value of the metadataTextContains, privateMetadataTextContains, metadataTextEquals, and privateMetadataTextEquals fields on per-type FilterCondition objects.

Wire example (from §6.7)

{
  "path": "acme.example.com/memo",
  "value": "follow up"
}

Path syntax

draft-ietf-jmap-metadata-04 §3.6: the path is “a namespace identifier, optionally followed by a JSON Pointer [RFC6901] into the namespace value (for example, <namespace>, <namespace>/<key> or <namespace>/<key>/<subkey>)”. / and ~ inside a key are escaped as ~1 and ~0 per RFC 6901. Object members are addressed by name; a path that would traverse an array or a scalar addresses no value. A server rejects a path with an invalid ~ escape with invalidArguments. Same syntax as the string value of metadataExists.

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

path: String

Path within the metadata object to match against.

Form: <namespace>, optionally followed by an RFC 6901 JSON Pointer into the namespace value, such as <namespace>/<key> or <namespace>/<key>/<subkey>.

value: String

The string to search for at path. Interpretation (substring containment vs exact equality) depends on which filter condition field carries this MetadataTextMatch.

Implementations

impl MetadataTextMatch

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

Create a MetadataTextMatch for path and value.

Trait Implementations

impl Clone for MetadataTextMatch

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 MetadataTextMatch

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for MetadataTextMatch

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Eq for MetadataTextMatch

impl PartialEq for MetadataTextMatch

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

Equality operator ==.

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

Inequality operator !=.

impl Serialize for MetadataTextMatch

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 MetadataTextMatch