Struct cap_std::net::Pool

source ·
pub struct Pool { /* private fields */ }
Expand description

A pool of network addresses.

This does not directly correspond to anything in std, however its methods correspond to the several functions in std::net.

Pool implements Clone, which creates new independent entities that carry the full authority of the originals. This means that in a borrow of a Pool, the scope of the authority is not necessarily limited to the scope of the borrow.

Similarly, the cap_net_ext::PoolExt class allows creating “binder” and “connecter” objects which represent capabilities to bind and connect to addresses.

Implementations§

source§

impl Pool

source

pub fn new() -> Self

Construct a new empty pool.

source

pub fn insert<A: ToSocketAddrs>( &mut self, addrs: A, ambient_authority: AmbientAuthority, ) -> Result<()>

Add addresses to the pool.

§Ambient Authority

This function allows ambient access to any IP address.

source

pub fn insert_socket_addr( &mut self, addr: SocketAddr, ambient_authority: AmbientAuthority, )

Add a specific net::SocketAddr to the pool.

§Ambient Authority

This function allows ambient access to any IP address.

source

pub fn insert_ip_net_port_any( &mut self, ip_net: IpNet, ambient_authority: AmbientAuthority, )

Add a range of network addresses, accepting any port, to the pool.

Unlike insert_ip_net, this function grants access to any requested port.

§Ambient Authority

This function allows ambient access to any IP address.

source

pub fn insert_ip_net_port_range( &mut self, ip_net: IpNet, ports_start: u16, ports_end: Option<u16>, ambient_authority: AmbientAuthority, )

Add a range of network addresses, accepting a range of ports, to the pool.

This grants access to the port range starting at ports_start and, if ports_end is provided, ending before ports_end.

§Ambient Authority

This function allows ambient access to any IP address.

source

pub fn insert_ip_net( &mut self, ip_net: IpNet, port: u16, ambient_authority: AmbientAuthority, )

Add a range of network addresses with a specific port to the pool.

§Ambient Authority

This function allows ambient access to any IP address.

source

pub fn bind_tcp_listener<A: ToSocketAddrs>( &self, addr: A, ) -> Result<TcpListener>

Creates a new TcpListener which will be bound to the specified address.

This corresponds to std::net::TcpListener::bind.

source

pub fn connect_tcp_stream<A: ToSocketAddrs>(&self, addr: A) -> Result<TcpStream>

Opens a TCP connection to a remote host.

This corresponds to std::net::TcpStream::connect.

source

pub fn connect_timeout_tcp_stream( &self, addr: &SocketAddr, timeout: Duration, ) -> Result<TcpStream>

Opens a TCP connection to a remote host with a timeout.

This corresponds to std::net::TcpStream::connect_timeout.

source

pub fn bind_udp_socket<A: ToSocketAddrs>(&self, addr: A) -> Result<UdpSocket>

Creates a UDP socket from the given address.

This corresponds to std::net::UdpSocket::bind.

source

pub fn send_to_udp_socket_addr<A: ToSocketAddrs>( &self, udp_socket: &UdpSocket, buf: &[u8], addr: A, ) -> Result<usize>

Sends data on the socket to the given address. On success, returns the number of bytes written.

This corresponds to std::net::UdpSocket::send_to.

source

pub fn connect_udp_socket<A: ToSocketAddrs>( &self, udp_socket: &UdpSocket, addr: A, ) -> Result<()>

Connects this UDP socket to a remote address, allowing the send and recv syscalls to be used to send data and also applies filters to only receive data from the specified address.

This corresponds to std::net::UdpSocket::connect.

Trait Implementations§

source§

impl Clone for Pool

source§

fn clone(&self) -> Pool

Returns a copy of the value. Read more
1.0.0 · source§

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

Performs copy-assignment from source. Read more
source§

impl Default for Pool

source§

fn default() -> Pool

Returns the “default value” for a type. Read more

Auto Trait Implementations§

§

impl Freeze for Pool

§

impl RefUnwindSafe for Pool

§

impl Send for Pool

§

impl Sync for Pool

§

impl Unpin for Pool

§

impl UnwindSafe for Pool

Blanket Implementations§

source§

impl<T> Any for T
where T: 'static + ?Sized,

source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
source§

impl<T> Borrow<T> for T
where T: ?Sized,

source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
source§

impl<T> CloneToUninit for T
where T: Clone,

source§

unsafe fn clone_to_uninit(&self, dst: *mut T)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dst. Read more
source§

impl<T> From<T> for T

source§

fn from(t: T) -> T

Returns the argument unchanged.

source§

impl<T, U> Into<U> for T
where U: From<T>,

source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

source§

impl<T> ToOwned for T
where T: Clone,

source§

type Owned = T

The resulting type after obtaining ownership.
source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

source§

type Error = Infallible

The type returned in the event of a conversion error.
source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.