Struct MetaMap 

pub struct MetaMap(pub BTreeMap<String, Value>);

Emitter-facing annotations attached to a Field or EndpointSchema.

Unused by endpoint-libs itself. It exists so that later releases can carry examples, JSON Schema constraints, tags, deprecation markers and protocol-binding hints into the OpenAPI/AsyncAPI emitters without a breaking change to the schema model. Unknown keys must round-trip untouched.

This is a newtype rather than a bare BTreeMap because Field derives Hash, Ord and Eq, which serde_json::Value does not implement. The manual impls below compare and hash values by their canonical JSON text.

Tuple Fields

0: BTreeMap<String, Value>

Implementations

impl MetaMap

pub fn is_empty(&self) -> bool

pub fn get(&self, key: &str) -> Option<&Value>

pub fn insert(&mut self, key: impl Into<String>, value: Value)

Trait Implementations

impl Clone for MetaMap

fn clone(&self) -> MetaMap

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for MetaMap

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

Formats the value using the given formatter.

impl Default for MetaMap

fn default() -> MetaMap

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for MetaMap

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Eq for MetaMap

impl Hash for MetaMap

Deterministic because BTreeMap iterates in key order and Value’s Display is a canonical JSON rendering.

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 Ord for MetaMap

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.

impl PartialEq for MetaMap

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

Equality operator ==.

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

Inequality operator !=.

impl PartialOrd for MetaMap

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 MetaMap

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 MetaMap