Struct codec_sv2::Sv2Frame

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

Trait Implementations

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

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

Formats the value using the given formatter.

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

pub fn default() -> Sv2Frame<T, B>

Returns the “default value” for a type.

impl<'a, T, B> Frame<'a, T> for Sv2Frame<T, B> where
    T: Encodable + GetSize,
    B: AsMut<[u8]>, 

pub fn serialize(
    self,
    dst: &mut <Sv2Frame<T, B> as Frame<'a, T>>::Buffer
) -> Result<(), Error>

Serialize the frame into dst if the frame is already serialized it just swap dst with itself

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

If is an Sv2 frame return the Some(header) if it is a noise frame return None

pub fn from_bytes(
    bytes: <Sv2Frame<T, B> as Frame<'a, T>>::Buffer
) -> Result<Sv2Frame<T, B>, isize>

Try to build a Frame frame from raw bytes. It return the frame or the number of the bytes needed to complete the frame The resulting frame is just a header plus a payload with the right number of bytes nothing is said about the correctness of the payload

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

Try to build an Frame frame from a serializable payload. It return a Frame if the size of the payload fit in the frame, if not it return None

type Buffer = B

type Deserialized = B

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

fn deserialize(&’a mut self) -> Result<Self::Deserialized, serde_sv2::Error>;

pub fn from_bytes_unchecked(
    bytes: <Sv2Frame<T, B> as Frame<'a, T>>::Buffer
) -> Sv2Frame<T, B>

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

pub fn encoded_length(&self) -> usize

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

type Error = ()

The type returned in the event of a conversion error.

pub fn try_from(
    v: EitherFrame<T, B>
) -> Result<Sv2Frame<T, B>, <Sv2Frame<T, B> as TryFrom<EitherFrame<T, B>>>::Error>

Performs the conversion.