Enum Protocol 

pub enum Protocol {
    NewStream {
        full: Bytes,
        pub_key: Bytes,
        base_msg: Bytes,
        header: Bytes,
    },
    Message {
        full: Bytes,
        pub_key: Bytes,
        base_msg: Bytes,
        message: Bytes,
    },
    RequestNewStream {
        full: Bytes,
        pub_key: Bytes,
        base_msg: Bytes,
    },
}

E2e crypto protocol enum.

The enum variant fields are all shallow clone parts of the “full” field:

• full the entire message send/recv via sbd-client.
• pub_key the pub_key peer send/recv to/from.
• base_msg the base message send/recv to/from the peer.
• ... all additional fields are broken out by enum variant.

Variants

NewStream

Message indicating a new stream state should be created along with the secretstream header for doing so.

Fields

full: Bytes

pub_key: Bytes

base_msg: Bytes

header: Bytes

Message

An encrypted message.

Fields

full: Bytes

pub_key: Bytes

base_msg: Bytes

message: Bytes

RequestNewStream

Request for a new decryption stream state.

Fields

full: Bytes

pub_key: Bytes

base_msg: Bytes

Implementations

impl Protocol

pub fn from_full(full: Bytes) -> Option<Self>

Parse a protocol message from complete message bytes. If None, this message should be ignored.

pub fn new_stream(pub_key: &[u8], header: &[u8]) -> Self

Create a “NewStream” message type. Panics if the pub_key is not 32 bytes or the header is not 24. Why not take a &[u8; N] you ask? It’s just a lot harder to work with in rust…

pub fn message(pub_key: &[u8], message: &[u8]) -> Self

Create a “Message” message type. Panics if the pub_key is not 32 bytes. Why not take a &[u8; N] you ask? It’s just a lot harder to work with in rust…

pub fn request_new_stream(pub_key: &[u8]) -> Self

Create a “RequestNewStream” message type. Panics if the pub_key is not 32 bytes. Why not take a &[u8; N] you ask? It’s just a lot harder to work with in rust…

pub fn full(&self) -> &Bytes

Get the full bytes of this protocol message.

pub fn pub_key(&self) -> &Bytes

Get the pub_key bytes of this protocol message.

pub fn base_msg(&self) -> &Bytes

Get the base_msg bytes of this protocol message.

Trait Implementations

impl Debug for Protocol

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

Formats the value using the given formatter.

impl PartialEq for Protocol

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