Struct Formats 

pub struct Formats {
    pub registry: Registry,
    pub operation: Format,
    pub response: Format,
    pub message: Format,
    pub event_value: Format,
}

The serde formats used by an application. The exact serde encoding in use must be known separately.

Fields

registry: Registry

The registry of container definitions.

operation: Format

The format of operations.

response: Format

The format of operation responses.

message: Format

The format of messages.

event_value: Format

The format of events.

Implementations

impl Formats

pub fn decode_operation(&self, bytes: &[u8]) -> Result<Value>

Decode BCS-encoded operation bytes into a JSON value.

pub fn decode_response(&self, bytes: &[u8]) -> Result<Value>

Decode BCS-encoded operation response bytes into a JSON value.

pub fn decode_message(&self, bytes: &[u8]) -> Result<Value>

Decode BCS-encoded message bytes into a JSON value.

pub fn decode_event_value(&self, bytes: &[u8]) -> Result<Value>

Decode BCS-encoded event value bytes into a JSON value.

pub fn encode_operation(&self, value: &Value) -> Result<Vec<u8>>

Encode a JSON operation value into its BCS bytes. Inverse of decode_operation.

pub fn encode_response(&self, value: &Value) -> Result<Vec<u8>>

Encode a JSON operation response value into its BCS bytes. Inverse of decode_response.

pub fn encode_message(&self, value: &Value) -> Result<Vec<u8>>

Encode a JSON message value into its BCS bytes. Inverse of decode_message.

pub fn encode_event_value(&self, value: &Value) -> Result<Vec<u8>>

Encode a JSON event value into its BCS bytes. Inverse of decode_event_value.

pub fn prune_known_primitives(&mut self) -> Result<(), PruneError>

Removes the registry entries for the well-known linera-base primitives (see KNOWN_PRIMITIVE_NAMES) so that decoding falls back to LineraEnvironment, which renders them in their human-readable form.

Before removing anything, this verifies that each such entry actually matches the canonical BCS format of the corresponding linera-base type. If any entry is present with a different format — for instance because an application defined a distinct type with a colliding name — this returns PruneError::Mismatch and leaves the registry untouched.

This is meant to be called from snapshot tests (and any other code that generates the stored Formats) so that the human-readable rendering is baked into the published formats.

Trait Implementations

impl Clone for Formats

fn clone(&self) -> Formats

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Formats

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for Formats

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for Formats

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

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 Formats

impl StructuralPartialEq for Formats