Struct EndpointBuilder 

pub struct EndpointBuilder { /* private fields */ }

Available on crate features quic and std only.

An endpoint being built: the runtime it will live on, what it is configured with, and the socket it will bind.

Implementations

impl EndpointBuilder

pub fn new(exec: Executor) -> EndpointBuilder

Build a client endpoint whose tasks run through exec.

Unless configured otherwise, construction generates a fresh secret reset key. A random-source failure is returned when binding or attaching a socket.

pub fn maybe_with_config(self, value: Option<EndpointConfig>) -> EndpointBuilder

The endpoint configuration; when omitted, construction generates a random reset key.

pub fn maybe_set_config( &mut self, value: Option<EndpointConfig>, ) -> &mut EndpointBuilder

The endpoint configuration; when omitted, construction generates a random reset key.

pub fn with_config(self, value: EndpointConfig) -> EndpointBuilder

The endpoint configuration; when omitted, construction generates a random reset key.

pub fn set_config(&mut self, value: EndpointConfig) -> &mut EndpointBuilder

The endpoint configuration; when omitted, construction generates a random reset key.

pub fn without_config(self) -> EndpointBuilder

The endpoint configuration; when omitted, construction generates a random reset key.

pub fn unset_config(&mut self) -> &mut EndpointBuilder

The endpoint configuration; when omitted, construction generates a random reset key.

pub fn maybe_with_server_config( self, value: Option<ServerConfig>, ) -> EndpointBuilder

What this endpoint serves incoming connections with

Without a server config, the default, it is a client.

pub fn maybe_set_server_config( &mut self, value: Option<ServerConfig>, ) -> &mut EndpointBuilder

What this endpoint serves incoming connections with

Without a server config, the default, it is a client.

pub fn with_server_config(self, value: ServerConfig) -> EndpointBuilder

What this endpoint serves incoming connections with

Without a server config, the default, it is a client.

pub fn set_server_config(&mut self, value: ServerConfig) -> &mut EndpointBuilder

What this endpoint serves incoming connections with

Without a server config, the default, it is a client.

pub fn without_server_config(self) -> EndpointBuilder

What this endpoint serves incoming connections with

Without a server config, the default, it is a client.

pub fn unset_server_config(&mut self) -> &mut EndpointBuilder

What this endpoint serves incoming connections with

Without a server config, the default, it is a client.

pub fn with_shutdown_budget(self, value: Duration) -> EndpointBuilder

How long a shutdown gives the drivers before it stops waiting and forces them. Zero forces immediately.

pub fn set_shutdown_budget(&mut self, value: Duration) -> &mut EndpointBuilder

How long a shutdown gives the drivers before it stops waiting and forces them. Zero forces immediately.

pub async fn bind_address( self, address: impl Into<SocketAddress>, ) -> Result<Endpoint, DatagramError>

Bind the address, and the addresses this endpoint advertises as preferred with it.

The advertised sockets are bound before the endpoint exists, so it advertises the addresses its sockets have, including ports the platform assigned.

pub async fn bind_address_with_socket_config( self, address: impl Into<SocketAddress>, socket_config: UdpSocketConfig, ) -> Result<Endpoint, DatagramError>

Same as Self::bind_address but with custom UdpSocketConfig.

pub fn with_packet_socket( self, socket: UdpPacketSocket, ) -> Result<Endpoint, DatagramError>

Build on a packet socket the caller prepared, with its packet metadata set up and its required features validated.

This does not bind preferred-address sockets or change the supplied socket options.

pub fn with_std_socket( self, socket: UdpSocket, ) -> Result<Endpoint, DatagramError>

Build on a bound standard socket. The packet metadata a UdpSocketConfig describes is not set up here; a caller that needs it wraps the socket first and uses with_packet_socket.

Trait Implementations

impl Clone for EndpointBuilder

fn clone(&self) -> EndpointBuilder

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for EndpointBuilder

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

Formats the value using the given formatter.