Enum SessionMessage

pub enum SessionMessage<const C: usize> {
    Segment(Segment),
    Request(SegmentRequest<C>),
    Acknowledge(FrameAcknowledgements<C>),
}

Contains all messages of the Session sub-protocol.

The maximum size of the Session sub-protocol message is given by C.

Variants

Segment(Segment)

Represents a message containing a segment.

Request(SegmentRequest<C>)

Represents a message containing a request for segments.

Acknowledge(FrameAcknowledgements<C>)

Represents a message containing frame acknowledgements.

Implementations

impl<const C: usize> SessionMessage<C>

pub fn try_as_segment(self) -> Option<Segment>

pub const fn try_as_segment_ref(&self) -> Option<&Segment>

pub fn try_as_segment_mut(&mut self) -> Option<&mut Segment>

pub fn try_as_request(self) -> Option<SegmentRequest<C>>

pub const fn try_as_request_ref(&self) -> Option<&SegmentRequest<C>>

pub fn try_as_request_mut(&mut self) -> Option<&mut SegmentRequest<C>>

pub fn try_as_acknowledge(self) -> Option<FrameAcknowledgements<C>>

pub const fn try_as_acknowledge_ref(&self) -> Option<&FrameAcknowledgements<C>>

pub fn try_as_acknowledge_mut( &mut self, ) -> Option<&mut FrameAcknowledgements<C>>

impl<const C: usize> SessionMessage<C>

pub const HEADER_SIZE: usize = 4usize

Header size of the session message. This is currently the version byte, the size of SessionMessageDiscriminants representation and two bytes for the message length.

pub const SEGMENT_OVERHEAD: usize = 10usize

Size of the overhead that’s added to the raw payload of each Segment.

This amounts to SessionMessage::HEADER_SIZE + Segment::HEADER_SIZE.

pub const MAX_MESSAGE_SIZE: usize = 1_482usize

Maximum size of the Session protocol message.

This is equal to the typical Ethernet MTU size minus Self::SEGMENT_OVERHEAD.

pub const VERSION: u8 = 1u8

Current version of the protocol.

pub const MAX_SEGMENTS_PER_FRAME: usize = 8usize

Maximum number of segments per frame.

pub fn minimum_message_size() -> usize

Returns the minimum size of a SessionMessage.

pub fn into_encoded(self) -> Box<[u8]>

Convenience method to encode the session message.

Trait Implementations

impl<const C: usize> Clone for SessionMessage<C>

fn clone(&self) -> SessionMessage<C>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<const C: usize> Debug for SessionMessage<C>

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

Formats the value using the given formatter.

impl<const C: usize> Display for SessionMessage<C>

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

Formats the value using the given formatter.

impl<'_enum, const C: usize> From<&'_enum SessionMessage<C>> for SessionMessageDiscriminants

fn from(val: &'_enum SessionMessage<C>) -> SessionMessageDiscriminants

Converts to this type from the input type.

impl<const C: usize> From<SessionMessage<C>> for SessionMessageDiscriminants

fn from(val: SessionMessage<C>) -> SessionMessageDiscriminants

Converts to this type from the input type.

impl<const C: usize> From<SessionMessage<C>> for Vec<u8>

fn from(value: SessionMessage<C>) -> Self

Converts to this type from the input type.

impl<const C: usize> PartialEq for SessionMessage<C>

fn eq(&self, other: &SessionMessage<C>) -> 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<const C: usize> Sink<SessionMessage<C>> for SessionState<C>

type Error = NetworkTypeError

The type of value produced by the sink when an error occurs.

fn poll_ready( self: Pin<&mut Self>, _: &mut Context<'_>, ) -> Poll<Result<(), Self::Error>>

Attempts to prepare the Sink to receive a value.

fn start_send( self: Pin<&mut Self>, item: SessionMessage<C>, ) -> Result<(), Self::Error>

Begin the process of sending a value to the sink. Each call to this function must be preceded by a successful call to poll_ready which returned Poll::Ready(Ok(())).

fn poll_flush( self: Pin<&mut Self>, _: &mut Context<'_>, ) -> Poll<Result<(), Self::Error>>

Flush any remaining output from this sink.

fn poll_close( self: Pin<&mut Self>, _: &mut Context<'_>, ) -> Poll<Result<(), Self::Error>>

Flush any remaining output and close this sink, if necessary.

impl<const C: usize> TryFrom<&[u8]> for SessionMessage<C>

type Error = SessionError

The type returned in the event of a conversion error.

fn try_from(value: &[u8]) -> Result<Self, Self::Error>

Performs the conversion.

impl<const C: usize> Eq for SessionMessage<C>

impl<const C: usize> StructuralPartialEq for SessionMessage<C>