Struct Packet

pub struct Packet { /* private fields */ }

Gives structure to data to be sent or received from stream.

Packet is the lowest abstraction above buffer in this library.

Fields

• size – size of the whole packet in number of bytes. It is u16 so that packet can not have size over u16::MAX
• kind – kind of packet.
• content – data stored in the packet.

Implementations

impl Packet

pub fn new(kind: PacketKind, content: Bytes) -> Result<Self, Error>

Creates a new Packet.

Returns an Error if created packet would be bigger than MAX_PACKET_SIZE.

To avoid this check, use Packet::new_unchecked.

Size of packet is derived from content.

Examples

Content packet is created like that.

    let packet = Packet::new(PacketKind::End, Bytes::from([1_u8, 2_u8]))?;

pub fn new_unchecked(kind: PacketKind, content: Bytes) -> Self

Creates a new Packet without checking if resulting packet size is not bigger than MAX_PACKET_SIZE.

Size of packet is derived from content.

pub fn send(self, stream: &mut TcpStream) -> Result<(), Error>

Sends self via stream.

This takes ownership of self.

pub fn send_to<A>(self, socket: UdpSocket, address: A) -> Result<(), Error>

where A: ToSocketAddrs,

Sends self to given address on UdpSocket.

This takes ownership of self.

pub fn send_to_connected(self, socket: UdpSocket) -> Result<(), Error>

Sends self to connected UdpSocket.

This takes ownership of self.

pub fn receive(stream: &mut TcpStream) -> Result<Packet, Error>

Receives a Packet from stream.

pub fn receive_from(socket: UdpSocket) -> Result<(Packet, SocketAddr), Error>

Receives a Packet and a SocketAddr on a UdpSocket.

pub fn receive_from_connected(socket: UdpSocket) -> Result<Packet, Error>

Receives a Packet on a connected UdpSocket.

pub fn peek(stream: &mut TcpStream) -> Result<Packet, Error>

Peeks on data on TcpStream if those data are valid, Packet is created.

Since TcpStream::peek is used to retrieve data, calling this again returns the same data.

pub fn peek_from(socket: UdpSocket) -> Result<(Self, SocketAddr), Error>

Peeks on data on socket, if valid data are received a Packet is created and returned together with a SocketAddr.

Since UdpSocket::peek_from is used to retrieve data, calling this again returns the same data.

pub fn peek_from_connected(socket: UdpSocket) -> Result<Self, Error>

Peeks on data on a connected socket, if valid data are received a Packet is created.

Since UdpSocket::peek is used to retrieve data, calling this again returns the same data.

pub fn number_of_packets(length: usize) -> u32

Returns number of packets needed to send data with given byte length.

pub fn split_to_max_packet_size(buffer: Bytes) -> Vec<Bytes>

Takes Bytes and returns Vec of Bytes each with maximum length of MAX_CONTENT_SIZE.

pub fn size(&self) -> u16

Returns size.

pub fn kind(&self) -> PacketKind

Returns kind.

pub fn content(&self) -> Bytes

Returns content.

Content is cloned.

pub fn content_ref(&self) -> &Bytes

Returns a reference to content.

pub fn content_mut(&mut self) -> &mut Bytes

Returns a mutable reference to content.

pub fn content_move(self) -> Bytes

Takes ownership of self and returns content.

pub fn max_size() -> u16

Returns maximum number of bytes that can one Packet hold as u16. This is global value for every Packet that can be changed with Packet::set_max_size.

Minimum value is 5 bytes, 2 for packet size(u16), 2 for packet kind, and at least 1 for content.

This accesses a mutable static with AtomicU16 to provide global access to this data and an ability to change its value for specific needs, but since AtomicU16 is used it is capped by u16::MAX.

pub fn set_max_size(size: u16)

Sets MAX_PACKET_SIZE to size.

Minimum value is 5 bytes, 2 for packet size(u16), 2 for packet kind, and at least 1 for content.

For more information look at Packet::max_size.

pub const fn description_size() -> u16

Returns minimal number of bytes that is every packet guaranteed to have, 2 bytes are for its size and 2 for its kind as u16.

pub fn max_content_size() -> u16

Maximum amount of bytes that a Packet can use for its content, its lower than MAX_PACKET_SIZE by PACKET_DESCRIPTION_SIZE.

Trait Implementations

impl Clone for Packet

fn clone(&self) -> Packet

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Packet

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

Formats the value using the given formatter.

impl Default for Packet

fn default() -> Self

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for Packet

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl From<Packet> for Bytes

fn from(value: Packet) -> Self

Converts to this type from the input type.

impl FromRon<'_> for Packet

fn from_ron(ron: &'a str) -> Result<Self, Error>

Creates an implementor from RON.

impl PartialEq for Packet

fn eq(&self, other: &Packet) -> 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 Serialize for Packet

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl ToRon for Packet

fn to_ron(&self) -> Result<String, Error>

Returns a RON from implementor.

fn to_ron_pretty(&self, config: Option<PrettyConfig>) -> Result<String, Error>

Returns a pretty formatted RON from implementor.

impl TryFrom<&[u8]> for Packet

type Error = Error

The type returned in the event of a conversion error.

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

Performs the conversion.

impl TryFrom<&Bytes> for Packet

type Error = Error

The type returned in the event of a conversion error.

fn try_from(value: &Bytes) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<Bytes> for Packet

type Error = Error

The type returned in the event of a conversion error.

fn try_from(value: Bytes) -> Result<Self, Self::Error>

Performs the conversion.

impl StructuralPartialEq for Packet