Struct ClientConfig 

pub struct ClientConfig { /* private fields */ }

What a client offers a server, before anything is negotiated.

Implementations

impl ClientConfig

pub fn new(version: ProtocolVersion, transport: TransportKind) -> Self

A client that speaks version, with nothing advertised.

pub fn speaking( versions: impl IntoIterator<Item = ProtocolVersion>, transport: TransportKind, ) -> Result<Self, ClientError>

A client that speaks several, most preferred first.

Errors

Refuses an empty list, because a client that speaks no revision cannot negotiate and would otherwise fail much later with a message about something else entirely.

pub const fn with_capabilities(self, capabilities: CapabilitySet) -> Self

Declares the capabilities the client supports.

pub fn versions(&self) -> &[ProtocolVersion]

The revisions offered, most preferred first.

pub const fn capabilities(&self) -> CapabilitySet

The capabilities this client declared.

Read by the handshake to render the initialize request, so it has to be the same set the profile will be resolved from — a handshake that advertised a different one would produce a session that claims to do something it never told the server it could.

pub const fn transport(&self) -> TransportKind

The transport the client will run over.

pub const fn negotiated_with( &self, version: ProtocolVersion, server_caps: CapabilitySet, ) -> Negotiation

The negotiation this offer produces against a server’s answer.

The one place the two halves are put together. A caller that already knows the version and the server’s capabilities — which is what a transport knows once the handshake is done — passes them here rather than leaving this type to invent a half-negotiation.

Trait Implementations

impl Clone for ClientConfig

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ClientConfig

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

Formats the value using the given formatter.

impl Eq for ClientConfig

impl PartialEq for ClientConfig

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for ClientConfig