Struct EncodedAction 

pub struct EncodedAction {
    pub type_id: String,
    pub payload: Vec<u8>,
}

A serialized action ready to cross a process/network boundary: the registry type_id plus the JSON payload the matching decoder reconstructs it from.

Fields

type_id: String

payload: Vec<u8>

Implementations

impl EncodedAction

pub fn encode<A>( type_id: impl Into<String>, action: &A, ) -> Result<EncodedAction, ActionError>

where A: Action + Serialize,

Serialize a concrete action under a registry type_id.

Errors

Returns ActionError::Encode if action fails to serialize.

pub fn written(type_id: String, payload: Vec<u8>) -> EncodedAction

An action of type_id whose payload is payload, a group’s written with what its members share once (crate::group_form).

pub fn encode_operation<T>( type_id: impl Into<String>, payload: &T, ) -> Result<EncodedAction, ActionError>

where T: Serialize,

Serialize a non-document operation payload. Unlike Self::encode, this intentionally requires no Action implementation: effects and views are handled by the owning application, not replayed into a CRDT.

Errors

Returns ActionError::Encode if payload fails to serialize.

impl EncodedAction

pub fn with_content_parts( &self, threshold: usize, ) -> Result<(EncodedAction, ContentParts), ActionError>

This action with every text or byte run of at least threshold bytes kept as content: the recorded form, and the content to keep.

Errors

A payload that is not JSON, or that already uses the reserved key.

pub fn content_parts(&self) -> Vec<String>

The content this recorded action names, in payload order.

pub fn resolve_content( &self, read: &dyn Fn(&str) -> Option<Vec<u8>>, ) -> Result<Result<EncodedAction, MissingContent>, ActionError>

The action as it ran, with every content reference replaced by the content read returns for it, checked against its hash.

Errors

The first content that read does not have (or returns other bytes for), or a payload that is not JSON.

Trait Implementations

impl Clone for EncodedAction

fn clone(&self) -> EncodedAction

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for EncodedAction

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for EncodedAction

fn deserialize<__D>( __deserializer: __D, ) -> Result<EncodedAction, <__D as Deserializer<'de>>::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for EncodedAction

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

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl Eq for EncodedAction

impl StructuralPartialEq for EncodedAction