Crate correspondent

Crate correspondent 

Source
Expand description

§Overview

correspondent is a high-level networking library which facilitates a non-hierarchical network of peers to send messages.

correspondent uses DNS-SD to discover peers on the local network.

correspondent uses Quinn, an implementation of the QUIC protocol, as a transport layer. These docs may assume some familiarity with Quinn’s API.

See examples/chat.rs for a simple example application.

§Supported Services

Operating SystemService
Windows 10Dnsapi.dll
LinuxAvahi (via dbus)

Structs§

CertificateResponse
Type to return from CertificateSigner::sign_certificate.
Events
Stream of events happening on the correspondent Socket
PeerId
Unique identifier for a connection.
PeerNotConnected
Error returned by Socket::connect if an error happens when connecting to a peer.
Socket
A socket represents an endpoint and other state correspondent uses to connect to peers.
SocketBuilder
Options for configuring the creation of a socket.
SocketCertificate
Required information correspondent uses to verify the identity of peers

Enums§

Event
A network event on the correspondent Socket

Traits§

CertificateSigner
Used by SocketBuilder::with_new_certificate to sign the newly generated certificate.
IdentityCanonicalizer
A correspondent socket must be created with a specific identity.