Struct ClientConfig 

#[non_exhaustive]
pub struct ClientConfig {
    pub connect: Option<Url>,
    pub bind: SocketAddr,
    pub backend: Option<QuicBackend>,
    pub failover_delay: Option<Duration>,
    pub timeout: Option<Duration>,
    pub quic: Client,
    pub version: Vec<Version>,
    pub tls: Client,
    pub backoff: Backoff,
    pub websocket: Client,
}

Configuration for the MoQ client.

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

connect: Option<Url>

The URL to dial.

Supports WebTransport (https/http), WebSocket (ws/wss), raw QUIC (moqt/moql), qmux over tcp/unix, and iroh. The URL path is the request/auth path (e.g. /anon for a public relay) and ?jwt= supplies a token. http:// first fetches /certificate.sha256 for the (insecure) self-signed fingerprint; https:// connects directly.

bind: SocketAddr

Listen for UDP packets on the given address.

backend: Option<QuicBackend>

The QUIC backend to use. Auto-detected from compiled features if not specified.

failover_delay: Option<Duration>

Delay before also dialing the next resolved address (Happy Eyeballs).

When DNS returns multiple addresses, attempts alternate between IPv6 and IPv4, each starting this long after the previous one (or immediately when it fails), and the first connection to complete wins. 0s dials every address at once. Defaults to 250ms. Applies to the QUIC and tcp:// dials.

This staggers the attempts within one Client::connect; Self::timeout bounds that call as a whole.

timeout: Option<Duration>

Maximum time for one Client::connect, covering the dial and the MoQ handshake. Defaults to 30 seconds; set to 0 to wait forever.

This has to live above the transports rather than inside one: QUIC bounds its own dial, but the WebSocket fallback and the handshake that follows either transport have no deadline of their own, so a peer that accepts TCP and then never speaks would hang the whole connect. Client::reconnect only re-arms its backoff between attempts, so an attempt that never returns stalls the retry loop indefinitely.

quic: Client

QUIC transport tuning (--client-quic-*): stream limits, GSO, timeouts.

version: Vec<Version>

Restrict the client to specific MoQ protocol version(s).

By default, the client offers all supported versions and lets the server choose. Use this to force a specific version, e.g. --client-version moq-lite-02. Can be specified multiple times to offer a subset of versions.

Valid values: moq-lite-01, moq-lite-02, moq-lite-03, moq-transport-14, moq-transport-15, moq-transport-16, moq-transport-17

tls: Client

TLS trust and client-certificate settings (--client-tls-*).

backoff: Backoff

Retry pacing for Client::reconnect (--client-backoff-*).

websocket: Client

WebSocket fallback settings (--client-websocket-*), used when QUIC is blocked.

Implementations

impl ClientConfig

pub fn init(self) -> Result<Client>

Build the Client this config describes.

pub fn versions(&self) -> Versions

Returns the configured versions, defaulting to all if none specified.

Trait Implementations

impl Args for ClientConfig

fn group_id() -> Option<Id>

Report the ArgGroup::id for this set of arguments

fn augment_args<'b>(__clap_app: Command) -> Command

Append to Command so it can instantiate Self via FromArgMatches::from_arg_matches_mut

fn augment_args_for_update<'b>(__clap_app: Command) -> Command

Append to Command so it can instantiate self via FromArgMatches::update_from_arg_matches_mut

impl Clone for ClientConfig

fn clone(&self) -> ClientConfig

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl CommandFactory for ClientConfig

fn command<'b>() -> Command

Build a Command that can instantiate Self.

fn command_for_update<'b>() -> Command

Build a Command that can update self.

impl Debug for ClientConfig

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

Formats the value using the given formatter.

impl Default for ClientConfig

fn default() -> Self

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for ClientConfig

where ClientConfig: Default,

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl FromArgMatches for ClientConfig

fn from_arg_matches(__clap_arg_matches: &ArgMatches) -> Result<Self, Error>

Instantiate Self from ArgMatches, parsing the arguments as needed.

fn from_arg_matches_mut( __clap_arg_matches: &mut ArgMatches, ) -> Result<Self, Error>

Instantiate Self from ArgMatches, parsing the arguments as needed.

fn update_from_arg_matches( &mut self, __clap_arg_matches: &ArgMatches, ) -> Result<(), Error>

Assign values from ArgMatches to self.

fn update_from_arg_matches_mut( &mut self, __clap_arg_matches: &mut ArgMatches, ) -> Result<(), Error>

Assign values from ArgMatches to self.

impl Parser for ClientConfig

fn parse() -> Self

Parse from std::env::args_os(), exit on error.

fn try_parse() -> Result<Self, Error>

Parse from std::env::args_os(), return Err on error.

fn parse_from<I, T>(itr: I) -> Self

where I: IntoIterator<Item = T>, T: Into<OsString> + Clone,

Parse from iterator, exit on error.

fn try_parse_from<I, T>(itr: I) -> Result<Self, Error>

where I: IntoIterator<Item = T>, T: Into<OsString> + Clone,

Parse from iterator, return Err on error.

fn update_from<I, T>(&mut self, itr: I)

where I: IntoIterator<Item = T>, T: Into<OsString> + Clone,

Update from iterator, exit on error.

fn try_update_from<I, T>(&mut self, itr: I) -> Result<(), Error>

where I: IntoIterator<Item = T>, T: Into<OsString> + Clone,

Update from iterator, return Err on error.

impl Serialize for ClientConfig

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.