Struct sync15_traits::bridged_engine::IncomingEnvelope

pub struct IncomingEnvelope {
    pub id: Guid,
    pub modified: ServerTimestamp,
    pub sortindex: Option<i32>,
    pub ttl: Option<u32>,
    cleartext: String,
}

An envelope for an incoming item, passed to BridgedEngine::store_incoming. Envelopes are a halfway point between BSOs, the format used for all items on the Sync server, and records, which are specific to each engine.

A BSO is a JSON object with metadata fields (id, modifed, sortindex), and a BSO payload that is itself a JSON string. For encrypted records, the BSO payload has a ciphertext, which must be decrypted to yield a cleartext. The cleartext is a JSON string (that's three levels of JSON wrapping, if you're keeping score: the BSO itself, BSO payload, and cleartext) with the actual record payload.

An envelope combines the metadata fields from the BSO, and the cleartext from the encrypted BSO payload.

Fields

id: Guid

modified: ServerTimestamp

sortindex: Option<i32>

ttl: Option<u32>

cleartext: String

Implementations

impl IncomingEnvelope

pub fn payload(&self) -> Result<Payload, PayloadError>

Parses and returns the record payload from this envelope. Returns an error if the envelope's cleartext isn't valid JSON, or the payload is invalid.

Trait Implementations

impl Clone for IncomingEnvelope

fn clone(&self) -> IncomingEnvelope

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for IncomingEnvelope

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for IncomingEnvelope

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

Deserialize this value from the given Serde deserializer.