Enum vodozemac::olm::OlmMessage

source · [−]

pub enum OlmMessage {
    Normal(Message),
    PreKey(PreKeyMessage),
}

Expand description

Enum over the different Olm message types.

Olm uses two types of messages. The underlying transport protocol must provide a means for recipients to distinguish between them.

OlmMessage provides Serialize and Deserialize implementations that are compatible with Matrix.

Variants

`Normal(Message)`

A normal message, contains only the ciphertext and metadata to decrypt it.

`PreKey(PreKeyMessage)`

A pre-key message, contains metadata to establish a Session as well as a Message.

Implementations

source

impl OlmMessage

source

pub fn from_parts(
message_type: usize,
ciphertext: &str
) -> Result<Self, DecodeError>

Create a OlmMessage from a message type and a ciphertext.

source

pub fn message(&self) -> &[u8]ⓘNotable traits for &[u8]`impl<'_> Read for &[u8]impl<'_> Write for &mut [u8]`

Get the message as a byte array.

source

pub fn message_type(&self) -> MessageType

Get the type of the message.

source

pub fn to_parts(self) -> (usize, String)

Convert the OlmMessage into a message type, and base64 encoded message tuple.

Trait Implementations

source

impl Clone for OlmMessage

source

fn clone(&self) -> OlmMessage

Returns a copy of the value. Read more

1.0.0 · source

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

Performs copy-assignment from source. Read more

source

impl Debug for OlmMessage

source

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

Formats the value using the given formatter. Read more

source

impl<'de> Deserialize<'de> for OlmMessage

source

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

Deserialize this value from the given Serde deserializer. Read more

source

impl From<Message> for OlmMessage

source

fn from(m: Message) -> Self

Converts to this type from the input type.

source

impl From<PreKeyMessage> for OlmMessage

source

fn from(m: PreKeyMessage) -> Self

Converts to this type from the input type.

source

impl PartialEq<OlmMessage> for OlmMessage

source

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

This method tests for self and other values to be equal, and is used by ==. Read more

source

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

This method tests for !=.

source

impl Serialize for OlmMessage

source

fn serialize<S>(&self, serializer: S) -> Result<S::Ok, S::Error> where
S: Serializer,

Serialize this value into the given Serde serializer. Read more

source

impl Eq for OlmMessage

source

impl StructuralEq for OlmMessage

source

impl StructuralPartialEq for OlmMessage

Auto Trait Implementations

impl RefUnwindSafe for OlmMessage

impl Send for OlmMessage

impl Sync for OlmMessage

impl Unpin for OlmMessage

impl UnwindSafe for OlmMessage

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,

const: unstable · source

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

source

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

const: unstable · source

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

Mutably borrows from an owned value. Read more

source

impl<T> From<T> for T

const: unstable · source

fn from(t: T) -> T

Returns the argument unchanged.

source

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

const: unstable · 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> Same<T> for T

type Output = T

Should always be Self

source

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

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 for T where
U: Into<T>,

type Error = Infallible

The type returned in the event of a conversion error.

const: unstable · source

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

Performs the conversion.

source

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

type Error = >::Error

The type returned in the event of a conversion error.

const: unstable · source

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

Performs the conversion.

source

impl<V, T> VZip<V> for T where
V: MultiLane<T>,

source

fn vzip(self) -> V

source

Enum vodozemac::olm::OlmMessage

Variants

Normal(Message)

PreKey(PreKeyMessage)

Implementations

impl OlmMessage

pub fn from_parts( message_type: usize, ciphertext: &str) -> Result<Self, DecodeError>

pub fn message(&self) -> &[u8]ⓘNotable traits for &[u8]impl<'_> Read for &[u8]impl<'_> Write for &mut [u8]

pub fn message_type(&self) -> MessageType

pub fn to_parts(self) -> (usize, String)

Trait Implementations

impl Clone for OlmMessage

fn clone(&self) -> OlmMessage

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

impl Debug for OlmMessage

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

impl<'de> Deserialize<'de> for OlmMessage

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

impl From<Message> for OlmMessage

fn from(m: Message) -> Self

impl From<PreKeyMessage> for OlmMessage

fn from(m: PreKeyMessage) -> Self

impl PartialEq<OlmMessage> for OlmMessage

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

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

impl Serialize for OlmMessage

fn serialize<S>(&self, serializer: S) -> Result<S::Ok, S::Error> where S: Serializer,

impl Eq for OlmMessage

impl StructuralEq for OlmMessage

impl StructuralPartialEq for OlmMessage

Auto Trait Implementations

impl RefUnwindSafe for OlmMessage

impl Send for OlmMessage

impl Sync for OlmMessage

impl Unpin for OlmMessage

impl UnwindSafe for OlmMessage

Blanket Implementations

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

fn type_id(&self) -> TypeId

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

fn borrow(&self) -> &T

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

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

impl<T> From<T> for T

fn from(t: T) -> T

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

fn into(self) -> U

impl<T> Same<T> for T

type Output = T

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

type Owned = T

fn to_owned(&self) -> T

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

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

type Error = Infallible

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

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

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

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

impl<V, T> VZip<V> for T where V: MultiLane<T>,

fn vzip(self) -> V

impl<T> DeserializeOwned for T where T: for<'de> Deserialize<'de>,

`Normal(Message)`

`PreKey(PreKeyMessage)`

pub fn from_parts(
message_type: usize,
ciphertext: &str
) -> Result<Self, DecodeError>

pub fn message(&self) -> &[u8]ⓘNotable traits for &[u8]`impl<'_> Read for &[u8]impl<'_> Write for &mut [u8]`

fn serialize<S>(&self, serializer: S) -> Result<S::Ok, S::Error> where
S: Serializer,

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

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

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

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

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

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

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

impl<V, T> VZip<V> for T where
V: MultiLane<T>,

impl<T> DeserializeOwned for T where
T: for<'de> Deserialize<'de>,