Struct connect::ConnectDatagram

pub struct ConnectDatagram { /* fields omitted */ }

A simple size-prefixed packet format containing a version tag, recipient tag, and message body.

The version tag is decided by the library version and used to maintain backwards compatibility with previous datagram formats.

Implementations

impl ConnectDatagram

pub fn new(recipient: u16, data: Vec<u8>) -> Result<Self, DatagramError>

Creates a new ConnectDatagram based on an intended recipient and message body.

The version tag is decided by the library version and used to maintain backwards compatibility with previous datagram formats.

This will return a EmptyMessage error if the data parameter contains no bytes, or in other words, when there is no message body.

This will return a TooLargeMessage error if the data parameter contains a buffer size greater than 100,000,000 (bytes), or 100MB.

pub fn version(&self) -> u16

Gets the version number of the datagram.

pub fn recipient(&self) -> u16

Gets the recipient of the datagram.

pub fn data(&self) -> Option<&Vec<u8>>

Gets the message body of the datagram.

pub fn take_data(&mut self) -> Option<Vec<u8>>

Takes ownership of the message body of the datagram.

pub fn size(&self) -> usize

Calculates the size-prefixed serialized byte-size of the datagram.

This will include the byte-size of the size-prefix.

pub fn encode(self) -> Vec<u8>

Serializes the datagram.

pub fn decode(buffer: Vec<u8>) -> Result<Self, DatagramError>

Deserializes the datagram from a buffer.

The buffer should not contain the size-prefix, and only contain the byte contents of the struct (version, recipient, and message body).

Trait Implementations

impl Clone for ConnectDatagram

fn clone(&self) -> ConnectDatagram

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Sink<ConnectDatagram> for ConnectionWriter

type Error = ConnectionWriteError

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

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

Attempts to prepare the Sink to receive a value.

fn start_send(
    self: Pin<&mut Self>,
    item: ConnectDatagram
) -> 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>,
    cx: &mut Context<'_>
) -> Poll<Result<(), Self::Error>>

Flush any remaining output from this sink.

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

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