Skip to main content

WireRecord

Struct WireRecord 

Source
#[non_exhaustive]
pub struct WireRecord {
Show 13 fields pub store: String, pub kind: WireRecordKind, pub primary_key: String, pub id: Option<String>, pub conversation: Option<String>, pub sender: Option<String>, pub time: Option<String>, pub message_type: Option<String>, pub name: Option<String>, pub text: Option<String>, pub payload: PayloadState, pub seq: u64, pub deleted: bool,
}
Expand description

One interpreted Wire record.

Fields absent from the source record stay None; only fields the record actually carries are populated. #[non_exhaustive] so new fields do not break consumers.

Fields (Non-exhaustive)§

This struct is marked as non-exhaustive
Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.
§store: String

The object-store name the record came from.

§kind: WireRecordKind

The Wire role of the store.

§primary_key: String

The record’s primary key, rendered as text.

§id: Option<String>

The record’s own id field, if present.

§conversation: Option<String>

The conversation id the record belongs to, if present.

§sender: Option<String>

The sender/author (from) of an event, if present.

§time: Option<String>

The event/record timestamp as stored (ISO-8601 string), if present.

§message_type: Option<String>

The Wire event type (e.g. conversation.message-add), if present.

§name: Option<String>

A human name — conversation name, user display name, or device model.

§text: Option<String>

The cleartext message body, when one was recoverable.

§payload: PayloadState

Whether the content is cleartext, encrypted, or undecodable.

§seq: u64

LevelDB sequence number (write ordering).

§deleted: bool

true if this record is a deletion tombstone recovered from the store.

Implementations§

Source§

impl WireRecord

Source

pub fn decrypted_text(&self) -> Result<&str, WireError>

The recoverable plaintext of this record’s message body.

Returns the cleartext body for a PayloadState::Cleartext record. For an encrypted or undecodable payload it fails loud with a typed error — it never fabricates plaintext.

Source

pub fn is_encrypted(&self) -> bool

Whether this record’s content is client-side encrypted and unrecoverable.

Trait Implementations§

Source§

impl Clone for WireRecord

Source§

fn clone(&self) -> WireRecord

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for WireRecord

Source§

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

Formats the value using the given formatter. Read more
Source§

impl PartialEq for WireRecord

Source§

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

Equality operator ==. Read more
1.0.0 (const: unstable) · Source§

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

Inequality operator !=. Read more
Source§

impl StructuralPartialEq for WireRecord

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.