Skip to main content

ListenOptions

Struct ListenOptions 

Source
pub struct ListenOptions { /* private fields */ }
Expand description

Options set on a listening socket before bind and listen.

use net_io::{ListenOptions, TcpListener};
let options = ListenOptions::new().backlog(4096).reuse_port(cfg!(target_os = "linux"));
let listener = TcpListener::bind_with("127.0.0.1:0", options)?;
println!("effective backlog {:?}", listener.info().backlog);

Implementations§

Source§

impl ListenOptions

Source

pub fn new() -> ListenOptions

Backlog 1,024; reuse address on Unix, exclusive address use on Windows; IPv6-only; TCP_NODELAY on accepted sockets.

Source

pub fn backlog(self, n: u32) -> ListenOptions

The listen backlog (capped by the OS; the effective value is in ListenerInfo).

Source

pub fn reuse_address(self, on: bool) -> ListenOptions

Unix: SO_REUSEADDR. Windows: false = SO_EXCLUSIVEADDRUSE, true = SO_REUSEADDR.

Source

pub fn reuse_port(self, on: bool) -> ListenOptions

SO_REUSEPORT (Unsupported on Windows).

Source

pub fn ipv6_only(self, on: bool) -> ListenOptions

IPV6_V6ONLY for IPv6 addresses (on by default; decision D-026).

Source

pub fn send_buffer(self, bytes: u32) -> ListenOptions

SO_SNDBUF on the listener (before listen).

Source

pub fn receive_buffer(self, bytes: u32) -> ListenOptions

SO_RCVBUF on the listener (before listen, so window scaling is negotiated).

Source

pub fn tcp_options(self, options: TcpOptions) -> ListenOptions

Options applied to every accepted socket.

Trait Implementations§

Source§

impl Clone for ListenOptions

Source§

fn clone(&self) -> Self

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Copy for ListenOptions

Source§

impl Debug for ListenOptions

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Default for ListenOptions

Source§

fn default() -> ListenOptions

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

impl Eq for ListenOptions

Source§

impl PartialEq for ListenOptions

Source§

fn eq(&self, other: &Self) -> bool

Equality operator ==. Read more
1.0.0 (const: unstable) · Source§

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=. Read more
Source§

impl StructuralPartialEq for ListenOptions

Auto Trait Implementations§

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, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. 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 = !

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

fn try_from(value: U) -> Result<T, !>

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.