Struct OutgoingBso

pub struct OutgoingBso {
    pub envelope: OutgoingEnvelope,
    pub payload: String,
}

Fields

envelope: OutgoingEnvelope

payload: String

Implementations

impl OutgoingBso

pub fn into_encrypted(self, key: &KeyBundle) -> Result<OutgoingEncryptedBso>

impl OutgoingBso

pub fn new_tombstone(envelope: OutgoingEnvelope) -> Self

Creates a new tombstone record. Not all collections expect tombstones.

pub fn from_content_with_id<T>(record: T) -> Result<Self, Error>

where T: Serialize,

Creates a outgoing record from some , which can be made into a JSON object with a valid id. This is the most convenient way to create an outgoing item from a when the default envelope is suitable. Will panic if there’s no good id in the json.

pub fn from_content<T>( envelope: OutgoingEnvelope, record: T, ) -> Result<Self, Error>

where T: Serialize,

Create an Outgoing record with an explicit envelope. Will panic if the payload has an ID but it doesn’t match the envelope.

impl OutgoingBso

Tests often want an IncomingBso to test, and the easiest way is often to create an OutgoingBso convert it back to an incoming.

pub fn to_test_incoming(&self) -> IncomingBso

When a test has an OutgoingBso and wants it as an IncomingBso

pub fn to_test_incoming_ts(&self, ts: ServerTimestamp) -> IncomingBso

When a test has an OutgoingBso and wants it as an IncomingBso with a specific timestamp.

pub fn to_test_incoming_t<T: for<'de> Deserialize<'de>>(&self) -> T

When a test has an OutgoingBso and wants it as an IncomingBso with a specific T.

impl OutgoingBso

pub fn new<T: Serialize>( envelope: OutgoingEnvelope, val: &T, ) -> Result<Self, Error>

Most consumers will use self.from_content and self.from_content_with_id but this exists for the few consumers for whom that doesn’t make sense.

Trait Implementations

impl Debug for OutgoingBso

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

Formats the value using the given formatter.

impl Serialize for OutgoingBso

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

where __S: Serializer,

Serialize this value into the given Serde serializer.