Struct reserve_port::ReservedPort

pub struct ReservedPort { /* private fields */ }

A port, that at the time of creation, is guaranteed to be free for use by the OS. This also guarantees not to clash with other ReservedPort objects.

The motivation of this library is to allow one to reserve many ports, ensure they don’t clash with each other, and then let them go when they are no longer needed.

Implementations

impl ReservedPort

pub fn random_with_tcp<I>(ip: I) -> Result<(Self, TcpListener)>

where I: Into<IpAddr>,

pub fn random_permanently_reserved_tcp<I>( ip: I ) -> Result<(TcpListener, SocketAddr)>

where I: Into<IpAddr>,

pub fn random() -> Result<Self>

pub fn random_permanently_reserved() -> Result<u16>

pub fn reserve_port(port: u16) -> Result<()>

Permanently reserves the given port as being offlimits (for this library).

This is useful if you have connected to a socket yourself, and wish to avoid clashing with this library.

pub fn port(&self) -> u16

Trait Implementations

impl Debug for ReservedPort

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

Formats the value using the given formatter.

impl Drop for ReservedPort

fn drop(&mut self)

Executes the destructor for this type.