Struct nardol::Packet

source · [−]

pub struct Packet { /* private fields */ }

Expand description

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

source

impl Packet

source

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]))?;

source

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.

source

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

Sends self via stream.

This takes ownership of self.

source

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.

source

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

Sends self to connected UdpSocket.

This takes ownership of self.

source

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

Receives a Packet from stream.

source

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

Receives a Packet and a SocketAddr on a UdpSocket.

source

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

Receives a Packet on a connected UdpSocket.

source

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.

source

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.

source

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.

source

pub fn number_of_packets(length: usize) -> u32

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

source

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.

source

pub fn size(&self) -> u16

Returns size.

source

pub fn kind(&self) -> PacketKind

Returns kind.

source

pub fn content(&self) -> Bytes

Returns content.

Content is cloned.

source

pub fn content_ref(&self) -> &Bytes

Returns a reference to content.

source

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

Returns a mutable reference to content.

source

pub fn content_move(self) -> Bytes

Takes ownership of self and returns content.

source

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.

source