Struct relay_protocol::Annotated

pub struct Annotated<T>(pub Option<T>, pub Meta);

Wrapper for data fields with optional meta data.

Tuple Fields

0: Option<T>

1: Meta

Implementations

impl<T> Annotated<T>

pub fn new(value: T) -> Self

Creates a new annotated value without meta data.

pub fn empty() -> Self

Creates an empty annotated value without meta data.

pub fn from_error<E>(err: E, value: Option<Value>) -> Self

where E: Into<Error>,

Creates an empty annotated value with error attached.

pub fn value(&self) -> Option<&T>

Returns a reference to the value.

Returns None if this value is not initialized, missing, or invalid.

pub fn value_mut(&mut self) -> &mut Option<T>

Returns a mutable reference to the value.

Returns None if this value is not initialized, missing, or invalid.

pub fn set_value(&mut self, value: Option<T>)

Replaces the stored value.

pub fn meta(&self) -> &Meta

Returns a reference to the meta data attached to this value.

pub fn meta_mut(&mut self) -> &mut Meta

Returns a mutable reference to the meta data attached to this value.

pub fn into_value(self) -> Option<T>

Returns the stored value and drops all meta data.

pub fn and_then<F, U, R>(self, f: F) -> Annotated<U>

where F: FnOnce(T) -> R, R: Into<Annotated<U>>,

Calls f with the stored value if available and merges meta data into the result.

pub fn map_value<U, F>(self, f: F) -> Annotated<U>

where F: FnOnce(T) -> U,

Maps an Annotated<T> to an Annotated<U> and keeps the original meta data.

pub fn get_or_insert_with<F>(&mut self, f: F) -> &mut T

where F: FnOnce() -> T,

Inserts a value computed from f into the value if it is None, then returns a mutable reference to the contained value.

impl<T> Annotated<T>

where T: AsRef<str>,

pub fn as_str(&self) -> Option<&str>

Returns a reference to the string value if set.

impl Annotated<Value>

pub fn as_str(&self) -> Option<&str>

Returns a reference to the string value if this value is a string and it is set.

impl<T> Annotated<T>

where T: Empty,

pub fn skip_serialization(&self, behavior: SkipSerialization) -> bool

Returns whether this value should be skipped during serialization.

An Annotated<T> is always serialized if it has meta data. Otherwise, serialization depends on the behavior. For SkipSerialization::Empty, the Empty trait is used to determine emptiness of the contained value and defaults to false for no value.

impl<T> Annotated<T>

where T: FromValue,

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

Deserializes an annotated from a deserializer

pub fn from_json(s: &str) -> Result<Self, Error>

Deserializes an annotated from a JSON string.

pub fn from_json_bytes(b: &[u8]) -> Result<Self, Error>

Deserializes an annotated from JSON bytes.

impl<T> Annotated<T>

where T: IntoValue,

pub fn serialize_with_meta<S: Serializer>( &self, serializer: S ) -> Result<S::Ok, S::Error>

Serializes an annotated value into a serializer.

pub fn to_json(&self) -> Result<String, Error>

Serializes an annotated value into a JSON string.

pub fn to_json_pretty(&self) -> Result<String, Error>

Serializes an annotated value into a pretty JSON string.

pub fn payload_to_json(&self) -> Result<String, Error>

Serializes an annotated value into a JSON string.

pub fn payload_to_json_pretty(&self) -> Result<String, Error>

Serializes an annotated value into a pretty JSON string.

Trait Implementations

impl<T: Clone> Clone for Annotated<T>

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

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<T: Debug> Debug for Annotated<T>

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

Formats the value using the given formatter.

impl<T> Default for Annotated<T>

fn default() -> Annotated<T>

Returns the “default value” for a type.

impl<T> Empty for Annotated<T>

where T: Empty,

Checks whether annotated data contains either a value or meta data.

fn is_empty(&self) -> bool

Returns if this object contains data to be serialized.

Caution: This has different behavior than annotated.value().is_empty()! Annotated is not empty if there is meta data that needs to be serialized. This is in line with the derived implementation of Empty on structs, which calls Annotated::is_empty on every child.

To check if a value is missing or empty, use Option::is_empty on the value instead.

fn is_deep_empty(&self) -> bool

Returns if this object contains nested data to be serialized.

impl From<Annotated<Value>> for Value

fn from(value: Annotated<Value>) -> Value

Converts to this type from the input type.

impl<T> From<Option<T>> for Annotated<T>

fn from(option: Option<T>) -> Self

Converts to this type from the input type.

impl<T> From<T> for Annotated<T>

fn from(t: T) -> Self

Converts to this type from the input type.

impl From<Value> for Annotated<Value>

fn from(value: Value) -> Annotated<Value>

Converts to this type from the input type.

impl<T> JsonSchema for Annotated<T>

where T: JsonSchema,

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> PartialEq for Annotated<T>

fn eq(&self, other: &Annotated<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> StructuralPartialEq for Annotated<T>