Struct Display 

#[non_exhaustive]
pub struct Display {
    pub output: Option<Value>,
    pub errors: Option<Value>,
}

A rendered JSON blob based on an on-chain template.

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.

output: Option<Value>

Output for all successfully substituted display fields. Unsuccessful fields will be null, and will be accompanied by a field in errors, explaining the error.

errors: Option<Value>

If any fields failed to render, this will contain a mapping from failed field names to error messages. If all fields succeed, this will either be null or not set.

Implementations

impl Display

pub const OUTPUT_FIELD: &'static MessageField

pub const ERRORS_FIELD: &'static MessageField

impl Display

pub fn path_builder() -> DisplayFieldPathBuilder

impl Display

pub const fn const_default() -> Self

pub fn output_opt_mut(&mut self) -> Option<&mut Value>

If output is set, returns Some with a mutable reference to the value; otherwise returns None.

pub fn output_mut(&mut self) -> &mut Value

Returns a mutable reference to output. If the field is unset, it is first initialized with the default value.

pub fn output_opt(&self) -> Option<&Value>

If output is set, returns Some with the value; otherwise returns None.

pub fn set_output<T: Into<Value>>(&mut self, field: T)

Sets output with the provided value.

pub fn with_output<T: Into<Value>>(self, field: T) -> Self

Sets output with the provided value.

pub fn errors_opt_mut(&mut self) -> Option<&mut Value>

If errors is set, returns Some with a mutable reference to the value; otherwise returns None.

pub fn errors_mut(&mut self) -> &mut Value

Returns a mutable reference to errors. If the field is unset, it is first initialized with the default value.

pub fn errors_opt(&self) -> Option<&Value>

If errors is set, returns Some with the value; otherwise returns None.

pub fn set_errors<T: Into<Value>>(&mut self, field: T)

Sets errors with the provided value.

pub fn with_errors<T: Into<Value>>(self, field: T) -> Self

Sets errors with the provided value.

Trait Implementations

impl Clone for Display

fn clone(&self) -> Display

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Display

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

Formats the value using the given formatter.

impl Default for Display

fn default() -> Self

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for Display

fn deserialize<D>(deserializer: D) -> Result<Self, D::Error>

where D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Message for Display

fn encoded_len(&self) -> usize

Returns the encoded length of the message without a length delimiter.

fn clear(&mut self)

Clears the message, resetting all fields to their default.

fn encode(&self, buf: &mut impl BufMut) -> Result<(), EncodeError>

where Self: Sized,

Encodes the message to a buffer.

fn encode_to_vec(&self) -> Vec<u8>

where Self: Sized,

Encodes the message to a newly allocated buffer.

fn encode_length_delimited( &self, buf: &mut impl BufMut, ) -> Result<(), EncodeError>

where Self: Sized,

Encodes the message with a length-delimiter to a buffer.

fn encode_length_delimited_to_vec(&self) -> Vec<u8>

where Self: Sized,

Encodes the message with a length-delimiter to a newly allocated buffer.

fn decode(buf: impl Buf) -> Result<Self, DecodeError>

where Self: Default,

Decodes an instance of the message from a buffer.

fn decode_length_delimited(buf: impl Buf) -> Result<Self, DecodeError>

where Self: Default,

Decodes a length-delimited instance of the message from the buffer.

fn merge(&mut self, buf: impl Buf) -> Result<(), DecodeError>

where Self: Sized,

Decodes an instance of the message from a buffer, and merges it into self.

fn merge_length_delimited(&mut self, buf: impl Buf) -> Result<(), DecodeError>

where Self: Sized,

Decodes a length-delimited instance of the message from buffer, and merges it into self.

impl MessageFields for Display

const FIELDS: &'static [&'static MessageField]

impl PartialEq for Display

fn eq(&self, other: &Display) -> 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 Display

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 Display