Enum Type 

#[repr(i32)]
pub enum Type {
    Unknown = 0,
    DoubleRatchet = 1,
    PrekeyMessage = 3,
    ServerDeliveryReceipt = 5,
    UnidentifiedSender = 6,
    PlaintextContent = 8,
}

Variants

Unknown = 0

DoubleRatchet = 1

A double-ratchet message represents a “normal,” “unsealed-sender” message encrypted using the Double Ratchet within an established Signal session. Double-ratchet messages include sender information in the plaintext portion of the Envelope.

content => (version byte | SignalMessage{Content})

PrekeyMessage = 3

A prekey message begins a new Signal session. The content of a prekey message is a superset of a double-ratchet message’s content and contains the sender’s identity public key and information identifying the pre-keys used in the message’s ciphertext. Like double-ratchet messages, prekey messages contain sender information in the plaintext portion of the Envelope.

content => (version byte | PreKeySignalMessage{Content})

ServerDeliveryReceipt = 5

Server delivery receipts are generated by the server when “unsealed-sender” messages are delivered to and acknowledged by the destination device. Server delivery receipts identify the sender in the plaintext portion of the Envelope and have no content. Note that receipts for sealed-sender messages are generated by clients as UNIDENTIFIED_SENDER messages.

Note that, with server delivery receipts, the “client timestamp” on the envelope refers to the timestamp of the original message (i.e. the message the server just delivered) and not to the time of delivery. The “server timestamp” refers to the time of delivery.

content => []

UnidentifiedSender = 6

An unidentified sender message represents a message with no sender information in the plaintext portion of the Envelope. Unidentified sender messages always contain an additional subtype in their content. They may or may not be part of an existing Signal session (i.e. an unidentified sender message may have a “prekey message” subtype or may indicate an encryption error).

content => ((version byte | UnidentifiedSenderMessage) OR (version byte | Multi-Recipient Sealed Sender Format))

PlaintextContent = 8

A plaintext message is used solely to convey encryption error receipts and never contains encrypted message content. Encryption error receipts must be delivered in plaintext because, encryption/decryption of a prior message failed and there is no reason to believe that encryption/decryption of subsequent messages with the same key material would succeed.

Critically, plaintext messages never have “real” message content generated by users. Plaintext messages include sender information.

content => (marker byte | Content)

Implementations

impl Type

pub const fn is_valid(value: i32) -> bool

Returns true if value is a variant of Type.

pub fn from_i32(value: i32) -> Option<Type>

👎Deprecated:

Use the TryFrom<i32> implementation instead

Converts an i32 to a Type, or None if value is not a valid variant.

impl Type

pub fn as_str_name(&self) -> &'static str

String value of the enum field names used in the ProtoBuf definition.

The values are not transformed in any way and thus are considered stable (if the ProtoBuf definition does not change) and safe for programmatic use.

pub fn from_str_name(value: &str) -> Option<Self>

Creates an enum from field names used in the ProtoBuf definition.

Trait Implementations

impl Clone for Type

fn clone(&self) -> Type

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Type

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

Formats the value using the given formatter.

impl Default for Type

fn default() -> Type

Returns the “default value” for a type.

impl From<Type> for i32

fn from(value: Type) -> i32

Converts to this type from the input type.

impl Hash for Type

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl Ord for Type

fn cmp(&self, other: &Type) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized,

Restrict a value to a certain interval.

impl PartialEq for Type

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

fn partial_cmp(&self, other: &Type) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

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

Tests less than (for self and other) and is used by the < operator.

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

Tests less than or equal to (for self and other) and is used by the <= operator.

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

Tests greater than (for self and other) and is used by the > operator.

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

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl TryFrom<i32> for Type

type Error = UnknownEnumValue

The type returned in the event of a conversion error.

fn try_from(value: i32) -> Result<Type, UnknownEnumValue>

Performs the conversion.

impl Copy for Type

impl Eq for Type

impl StructuralPartialEq for Type