Struct SurfaceMetadata 

pub struct SurfaceMetadata {
    pub labels: BTreeMap<String, String>,
    pub app_context: Option<Value>,
}

Opaque caller-owned metadata shared across public surfaces.

Fields

labels: BTreeMap<String, String>

Caller-owned labels for filtering and projection.

app_context: Option<Value>

Caller-owned opaque application context.

Implementations

impl SurfaceMetadata

pub fn from_optional_parts( labels: Option<BTreeMap<String, String>>, app_context: Option<Value>, ) -> Self

Build metadata from the existing optional create-surface fields.

pub fn is_empty(&self) -> bool

Return whether this metadata is empty.

pub fn validate_public(&self) -> Result<(), SurfaceMetadataError>

Validate caller-supplied metadata against Meerkat-owned keys.

Trait Implementations

impl Clone for SurfaceMetadata

fn clone(&self) -> SurfaceMetadata

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for SurfaceMetadata

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

Formats the value using the given formatter.

impl Default for SurfaceMetadata

fn default() -> SurfaceMetadata

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for SurfaceMetadata

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl From<SurfaceMetadata> for RuntimeMetadata

fn from(surface: SurfaceMetadata) -> Self

Converts to this type from the input type.

impl JsonSchema for SurfaceMetadata

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 SurfaceMetadata

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

Tests for self and other values to be equal, and is used by ==.

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

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

impl Serialize for SurfaceMetadata

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl Eq for SurfaceMetadata

impl StructuralPartialEq for SurfaceMetadata