Struct quilkin::metadata::MetadataView

#[non_exhaustive]
pub struct MetadataView<T: Default> {
    pub known: T,
    pub unknown: Map<String, Value>,
}

Represents a view into the metadata object attached to another object. T represents metadata known to Quilkin under quilkin.dev (available under the KEY constant.)

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.

known: T

Known Quilkin metadata.

unknown: Map<String, Value>

User created metadata.

Implementations

impl<T: Default> MetadataView<T>

pub fn new(known: impl Into<T>) -> Self

pub fn with_unknown(known: impl Into<T>, unknown: Map<String, Value>) -> Self

Trait Implementations

impl<T: Clone + Default> Clone for MetadataView<T>

fn clone(&self) -> MetadataView<T>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<T: Debug + Default> Debug for MetadataView<T>

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

Formats the value using the given formatter.

impl<T: Default + Default> Default for MetadataView<T>

fn default() -> MetadataView<T>

Returns the “default value” for a type.

impl<'de, T: Default> Deserialize<'de> for MetadataView<T>where
    T: Deserialize<'de>,
    T: Default,

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>where
    __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl<T: Into<Struct> + Default> From<MetadataView<T>> for ProtoMetadata

fn from(metadata: MetadataView<T>) -> Self

Converts to this type from the input type.

impl<T, E> From<T> for MetadataView<T>where
    T: TryFrom<Struct, Error = E> + Default,

fn from(known: T) -> Self

Converts to this type from the input type.

impl<T: Default + JsonSchema> JsonSchema for MetadataView<T>

fn schema_name() -> String

The name of the generated JSON Schema.

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

Generates a JSON Schema for this type.

fn is_referenceable() -> bool

Whether JSON Schemas generated for this type should be re-used where possible using the $ref keyword.

impl<T: PartialEq + Default> PartialEq<MetadataView<T>> for MetadataView<T>

fn eq(&self, other: &MetadataView<T>) -> bool

This method tests for self and other values to be equal, and is used by ==.

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

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl<T: Default> Serialize for MetadataView<T>where
    T: Serialize,

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

Serialize this value into the given Serde serializer.

impl<T, E> TryFrom<Metadata> for MetadataView<T>where
    T: TryFrom<Struct, Error = E> + Default,

type Error = E

The type returned in the event of a conversion error.

fn try_from(value: ProtoMetadata) -> Result<Self, Self::Error>

Performs the conversion.

impl<T: Eq + Default> Eq for MetadataView<T>

impl<T: Default> StructuralEq for MetadataView<T>

impl<T: Default> StructuralPartialEq for MetadataView<T>