Struct Payload 

pub struct Payload(/* private fields */);

Ledger payload: a JSON object with every float refused, at construction and again on read (determinism rule 6). Keys serialize sorted (serde_json’s default BTreeMap), which is part of the canonical bytes.

Implementations

impl Payload

pub fn new(map: Map<String, Value>) -> Result<Self, AxError>

Sole constructor.

pub fn empty() -> Self

pub fn of(record: &impl Serialize) -> Result<Self, AxError>

The way in: one of the record structs in crate::event::record, encoded as the object a ledger line carries. Every writer goes through here, so the keys of a kind are spelled in exactly one place: the struct.

Errors

Refuses a record that does not encode to a JSON object, and any float inside one, for the reasons Payload::new gives.

pub fn read<T: DeserializeOwned>(&self) -> Result<T, AxError>

The way out: the record struct this payload was written from.

A field a record written by an older build may omit carries #[serde(default)] on the struct, so the tolerance is declared once per key rather than at each reader. Unknown keys pass, so a newer writer never breaks an older reader.

Deserializes from the held map by reference, so a read allocates only what T owns, never a second copy of the payload.

Errors

A payload this build cannot read as T.

pub fn as_map(&self) -> &Map<String, Value>

pub fn into_map(self) -> Map<String, Value>

The map itself, for a reader that rewrites it in place and builds a new payload from the result, so no second copy is made on the way through.

Trait Implementations

impl Clone for Payload

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Payload

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for Payload

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

Deserialize this value from the given Serde deserializer.

impl Eq for Payload

impl PartialEq for Payload

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

Equality operator ==.

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

Inequality operator !=.

impl Serialize for Payload

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 Payload