Struct canadensis_header::RawHeader

#[repr(C)]
pub struct RawHeader { /* private fields */ }

A header, with memory layout matching the on-wire representation

This post specifies the header format.

Implementations

impl RawHeader

pub fn is_last_frame(&self) -> bool

Returns true if this is the last frame in a transfer

pub fn frame_index(&self) -> u32

Returns the index of this frame in a transfer

pub fn checksum_valid(&self) -> bool

Returns true if this header’s checksum is correct

Trait Implementations

impl AsBytes for RawHeader

fn as_bytes(&self) -> &[u8]

Gets the bytes of this value.

fn as_bytes_mut(&mut self) -> &mut [u8]where Self: FromBytes,

Gets the bytes of this value mutably.

fn write_to<B>(&self, bytes: B) -> Option<()>where B: ByteSliceMut,

Writes a copy of self to bytes.

fn write_to_prefix<B>(&self, bytes: B) -> Option<()>where B: ByteSliceMut,

Writes a copy of self to the prefix of bytes.

fn write_to_suffix<B>(&self, bytes: B) -> Option<()>where B: ByteSliceMut,

Writes a copy of self to the suffix of bytes.

impl Debug for RawHeader

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

Formats the value using the given formatter.

impl From<Header> for RawHeader

fn from(header: Header) -> Self

Encodes a validated header into a raw header for transmission

impl FromBytes for RawHeader

fn read_from<B>(bytes: B) -> Option<Self>where B: ByteSlice, Self: Sized,

Reads a copy of Self from bytes.

fn read_from_prefix<B>(bytes: B) -> Option<Self>where B: ByteSlice, Self: Sized,

Reads a copy of Self from the prefix of bytes.

fn read_from_suffix<B>(bytes: B) -> Option<Self>where B: ByteSlice, Self: Sized,

Reads a copy of Self from the suffix of bytes.

fn new_zeroed() -> Selfwhere Self: Sized,

Creates an instance of Self from zeroed bytes.

impl TryFrom<RawHeader> for Header

fn try_from(header: RawHeader) -> Result<Self, Self::Error>

Parses a validated header from a raw header

type Error = InvalidValue

The type returned in the event of a conversion error.