Struct RawSocket 

pub struct RawSocket<'d> { /* private fields */ }

An Raw socket.

Implementations

impl<'d> RawSocket<'d>

pub fn new( stack: Stack<'d>, ip_version: Option<IpVersion>, ip_protocol: Option<IpProtocol>, ) -> Result<Self, Full>

Create a new raw socket using the provided stack, receiving IP packets of the given version and protocol (None for any).

Errors:

• Full if the stack has no room for another raw socket. The limit is set by the raw-socket-count-N feature of xarxa.

pub fn new_unbound(stack: Stack<'d>) -> Result<Self, Full>

Create a new raw socket using the provided stack, without binding it.

Errors:

• Full if the stack has no room for another raw socket. The limit is set by the raw-socket-count-N feature of xarxa.

pub fn bind(&mut self, mode: RawMode) -> Result<(), BindError>

Bind the socket to the given mode.

pub fn bind_to_iface( &mut self, iface: Option<IfaceHandle>, ) -> Result<(), BindError>

Bind the socket to an interface, or unbind it with None.

A socket bound to an interface only sends and receives packets on it.

The socket must be closed. The binding is kept across close, so a socket stays bound to its interface when it is bound again.

Returns Err(BindError::InvalidState) if the socket is open.

pub fn bound_iface(&self) -> Option<IfaceHandle>

Return the interface the socket is bound to, or None.

See bind_to_iface.

pub fn wait_recv_ready(&self) -> impl Future<Output = ()> + '_

Wait until the socket becomes readable.

A socket is readable when a packet has been received, or when there are queued packets in the buffer.

pub fn poll_recv_ready(&self, cx: &mut Context<'_>) -> Poll<()>

Wait until a packet can be read.

pub fn recv<'s>( &'s self, buf: &'s mut [u8], ) -> impl Future<Output = Result<usize, RecvError>> + 's

Receive a packet, copying it into the given buffer.

This method will wait until a packet is received.

If the socket is not bound, this method will return Err(RecvError::InvalidState).

Returns the number of bytes received.

pub fn try_recv(&self, buf: &mut [u8]) -> Result<usize, TryError<RecvError>>

Receive a packet, copying it into the given buffer.

This method will not wait for a packet to be received.

If no packet is available, this method will return Err(TryError::WouldBlock).

pub fn poll_recv( &self, buf: &mut [u8], cx: &mut Context<'_>, ) -> Poll<Result<usize, RecvError>>

Receive a packet, copying it into the given buffer.

pub async fn recv_packet(&self) -> Result<PacketBuf, RecvError>

Receive a packet, taking ownership of its buffer.

This method will wait until a packet is received.

If the socket is not bound, this method will return Err(RecvError::InvalidState).

pub async fn recv_with<F, R>(&mut self, f: F) -> Result<R, RecvError>

where F: FnOnce(&[u8], PacketMeta) -> R,

Receive a packet with a zero-copy function.

This method will wait until a packet is received.

pub fn wait_send_ready(&self) -> impl Future<Output = ()> + '_

Wait until the socket becomes writable.

pub fn poll_send_ready(&self, cx: &mut Context<'_>) -> Poll<()>

Wait until a packet can be sent.

pub async fn send(&self, buf: &[u8]) -> Result<(), SendError>

Send a packet.

This method will wait until the packet has been sent.

pub async fn send_with_meta( &self, buf: &[u8], meta: PacketMeta, ) -> Result<(), SendError>

Send a packet with the given metadata attached.

This method will wait until the packet has been sent.

pub fn try_send(&self, buf: &[u8]) -> Result<(), TryError<SendError>>

Send a packet.

This method will not wait for a packet buffer or device room to become free.

pub fn poll_send_with_meta( &self, buf: &[u8], meta: PacketMeta, cx: &mut Context<'_>, ) -> Poll<Result<(), SendError>>

Send a packet with the given metadata attached.

pub async fn send_with<F, R>( &mut self, max_size: usize, f: F, ) -> Result<R, SendError>

where F: FnOnce(&mut [u8]) -> (usize, R),

Send a packet with a zero-copy function.

This method will wait until a packet buffer is available before passing it to the closure. The closure returns the number of bytes written into the buffer.

pub fn is_open(&self) -> bool

Returns whether the socket is bound.

pub fn close(&mut self)

Close the socket.

Trait Implementations

impl Drop for RawSocket<'_>

fn drop(&mut self)

Executes the destructor for this type.

fn pin_drop(self: Pin<&mut Self>)

🔬This is a nightly-only experimental API. (pin_ergonomics)

Execute the destructor for this type, but different to Drop::drop, it requires self to be pinned.