Struct Sv2Frame

pub struct Sv2Frame<T, B> { /* private fields */ }

Abstraction for a Sv2 frame.

Represents a regular Sv2 frame, used for all communication outside of the Noise protocol handshake process. It contains a Header and a message payload, which can be serialized for encoding and transmission or decoded and deserialized upon receipt.

Implementations

impl<T, B> Sv2Frame<T, B>

where T: Encodable + GetSize, B: AsMut<[u8]> + AsRef<[u8]>,

pub fn serialize(self, dst: &mut [u8]) -> Result<(), Error>

Writes the serialized Sv2Frame into dst.

This operation when called on an already serialized frame is very cheap. When called on a non serialized frame, it is not so cheap (because it serializes it).

pub fn payload(&mut self) -> &mut [u8]

Returns the message payload.

self can be either serialized (self.serialized is Some()) or deserialized (self.serialized is None, self.payload is Some()).

This function is only intended as a fast way to get a reference to an already serialized payload. If the frame has not yet been serialized, this function should never be used (it will panic).

pub fn get_header(&self) -> Option<Header>

Sv2Frame always returns Some(self.header).

pub fn from_bytes(bytes: B) -> Result<Sv2Frame<T, B>, isize>

Tries to build a Sv2Frame from raw bytes.

It assumes the raw bytes represent a serialized Sv2Frame frame (Self.serialized). Returns a Sv2Frame on success, or the number of the bytes needed to complete the frame as an error. Self.serialized is Some, but nothing is assumed or checked about the correctness of the payload.

pub fn from_bytes_unchecked(bytes: B) -> Sv2Frame<T, B>

Constructs an Sv2Frame from raw bytes without performing byte content validation.

pub fn size_hint(bytes: &[u8]) -> isize

After parsing bytes into a Header, this function helps to determine if the msg_length field is correctly representing the size of the frame.

• Returns 0 if the byte slice is of the expected size according to the header.
• Returns a negative value if the byte slice is shorter than expected; this value represents how many bytes are missing.
• Returns a positive value if the byte slice is longer than expected; this value indicates the surplus of bytes beyond the expected size.

pub fn encoded_length(&self) -> usize

If Sv2Frame is serialized, returns the length of self.serialized, otherwise, returns the length of self.payload.

pub fn from_message( message: T, message_type: u8, extension_type: u16, channel_msg: bool, ) -> Option<Sv2Frame<T, B>>

Tries to build a Sv2Frame from a non-serialized payload.

Returns a Sv2Frame if the size of the payload fits in the frame, None otherwise.

impl<A, B> Sv2Frame<A, B>

pub fn map<C>(self, fun: fn(A) -> C) -> Sv2Frame<C, B>

Maps a Sv2Frame<A, B> to Sv2Frame<C, B> by applying fun, which is assumed to be a closure that converts A to C

Trait Implementations

impl<T, B> Clone for Sv2Frame<T, B>

where T: Clone, B: Clone,

fn clone(&self) -> Sv2Frame<T, B>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<T, B> Debug for Sv2Frame<T, B>

where T: Debug, B: Debug,

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

Formats the value using the given formatter.

impl<T, B> From<Sv2Frame<T, B>> for Frame<T, B>

fn from(v: Sv2Frame<T, B>) -> Frame<T, B>

Converts to this type from the input type.

impl<T, B> TryFrom<Frame<T, B>> for Sv2Frame<T, B>

type Error = Error

The type returned in the event of a conversion error.

fn try_from(v: Frame<T, B>) -> Result<Sv2Frame<T, B>, Error>

Performs the conversion.