Struct de_net::OutPackage

pub struct OutPackage {
    data: Vec<u8>,
    reliability: Reliability,
    peers: Peers,
    target: SocketAddr,
}

A package to be send.

Fields

data: Vec<u8>

First HEADER_SIZE bytes are reserved for the header. Payload must follow.

reliability: Reliability

peers: Peers

target: SocketAddr

Implementations

impl OutPackage

pub fn encode_single<E>( message: &E, reliability: Reliability, peers: Peers, target: SocketAddr ) -> Result<Self, EncodeError>

where E: Encode,

Creates a package from a single message.

pub fn from_slice( data: &[u8], reliability: Reliability, peers: Peers, target: SocketAddr ) -> Self

Panics

If data is longer than MAX_PACKAGE_SIZE.

pub(super) fn new( data: Vec<u8>, reliability: Reliability, peers: Peers, target: SocketAddr ) -> Self

Arguments

• data - data to be send. The message data must start exactly at HEADER_SIZE. The initial bytes are reserved for the header. The header is not filled by the caller.

• reliability - package delivery reliability mode.

• target - package recipient.

Panics

• If data length is smaller or equal to header size..

• If data is longer than MAX_DATAGRAM_SIZE.

pub(crate) fn data(self) -> Vec<u8>

Returns package data.

The data start at HEADER_SIZE so that header may be written to the beginning of the vector.

pub(crate) fn data_slice(&self) -> &[u8]

Returns slice to the payload part (without header) of the data.

pub(crate) fn reliability(&self) -> Reliability

pub(crate) fn peers(&self) -> Peers

pub(crate) fn target(&self) -> SocketAddr