diff --git a/pr/380/docs/iroh_quinn/all.html b/pr/380/docs/iroh_quinn/all.html index b3b910424..9b90426bd 100644 --- a/pr/380/docs/iroh_quinn/all.html +++ b/pr/380/docs/iroh_quinn/all.html @@ -1 +1 @@ -List of all items in this crate

All

List of all items

Structs

Enums

Traits

Functions

\ No newline at end of file +List of all items in this crate

All

List of all items

Structs

Enums

Traits

Functions

\ No newline at end of file diff --git a/pr/380/docs/iroh_quinn/congestion/index.html b/pr/380/docs/iroh_quinn/congestion/index.html index 9c0e9e057..bba43c8a1 100644 --- a/pr/380/docs/iroh_quinn/congestion/index.html +++ b/pr/380/docs/iroh_quinn/congestion/index.html @@ -1,2 +1,2 @@ -iroh_quinn::congestion - Rust

Module congestion

Module congestion 

Source
Expand description

Logic for controlling the rate at which data is sent

+iroh_quinn::congestion - Rust

Module congestion

Module congestion 

Source
Expand description

Logic for controlling the rate at which data is sent

Structs§

Bbr
Experimental! Use at your own risk.
BbrConfig
Configuration for the Bbr congestion controller
ControllerMetrics
Common congestion controller metrics
Cubic
The RFC8312 congestion controller, as widely used for TCP
CubicConfig
Configuration for the Cubic congestion controller
NewReno
A simple, standard congestion controller
NewRenoConfig
Configuration for the NewReno congestion controller

Traits§

Controller
Common interface for different congestion controllers
ControllerFactory
Constructs controllers on demand
\ No newline at end of file diff --git a/pr/380/docs/iroh_quinn/congestion/struct.Bbr.html b/pr/380/docs/iroh_quinn/congestion/struct.Bbr.html index 9a3a7a580..94a3604b9 100644 --- a/pr/380/docs/iroh_quinn/congestion/struct.Bbr.html +++ b/pr/380/docs/iroh_quinn/congestion/struct.Bbr.html @@ -1,4 +1,4 @@ -Bbr in iroh_quinn::congestion - Rust

Bbr

Struct Bbr 

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

Experimental! Use at your own risk.

+Bbr in iroh_quinn::congestion - Rust

Bbr

Struct Bbr 

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

Experimental! Use at your own risk.

Aims for reduced buffer bloat and improved performance over high bandwidth-delay product networks. Based on google’s quiche implementation https://source.chromium.org/chromium/chromium/src/+/master:net/third_party/quiche/src/quic/core/congestion_control/bbr_sender.cc of BBR https://datatracker.ietf.org/doc/html/draft-cardwell-iccrg-bbr-congestion-control. diff --git a/pr/380/docs/iroh_quinn/congestion/struct.BbrConfig.html b/pr/380/docs/iroh_quinn/congestion/struct.BbrConfig.html index 32f14cb1a..2ae63d0bc 100644 --- a/pr/380/docs/iroh_quinn/congestion/struct.BbrConfig.html +++ b/pr/380/docs/iroh_quinn/congestion/struct.BbrConfig.html @@ -1,4 +1,4 @@ -BbrConfig in iroh_quinn::congestion - Rust

BbrConfig

Struct BbrConfig 

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

Configuration for the Bbr congestion controller

+BbrConfig in iroh_quinn::congestion - Rust

BbrConfig

Struct BbrConfig 

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

Configuration for the Bbr congestion controller

Implementations§

Source§

impl BbrConfig

Source

pub fn initial_window(&mut self, value: u64) -> &mut BbrConfig

Default limit on the amount of outstanding data in bytes.

Recommended value: min(10 * max_datagram_size, max(2 * max_datagram_size, 14720))

Trait Implementations§

Source§

impl Clone for BbrConfig

Source§

fn clone(&self) -> BbrConfig

Returns a duplicate of the value. Read more
1.0.0 · Source§

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

Performs copy-assignment from source. Read more
Source§

impl ControllerFactory for BbrConfig

Source§

fn build( diff --git a/pr/380/docs/iroh_quinn/congestion/struct.ControllerMetrics.html b/pr/380/docs/iroh_quinn/congestion/struct.ControllerMetrics.html index a8ff3096a..f4ede9270 100644 --- a/pr/380/docs/iroh_quinn/congestion/struct.ControllerMetrics.html +++ b/pr/380/docs/iroh_quinn/congestion/struct.ControllerMetrics.html @@ -1,4 +1,4 @@ -ControllerMetrics in iroh_quinn::congestion - Rust

ControllerMetrics

Struct ControllerMetrics 

Source
#[non_exhaustive]
pub struct ControllerMetrics { +ControllerMetrics in iroh_quinn::congestion - Rust

ControllerMetrics

Struct ControllerMetrics 

Source
#[non_exhaustive]
pub struct ControllerMetrics { pub congestion_window: u64, pub ssthresh: Option<u64>, pub pacing_rate: Option<u64>, diff --git a/pr/380/docs/iroh_quinn/congestion/struct.Cubic.html b/pr/380/docs/iroh_quinn/congestion/struct.Cubic.html index e76f9ec2a..af26f94a0 100644 --- a/pr/380/docs/iroh_quinn/congestion/struct.Cubic.html +++ b/pr/380/docs/iroh_quinn/congestion/struct.Cubic.html @@ -1,4 +1,4 @@ -Cubic in iroh_quinn::congestion - Rust

Cubic

Struct Cubic 

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

The RFC8312 congestion controller, as widely used for TCP

+Cubic in iroh_quinn::congestion - Rust

Cubic

Struct Cubic 

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

The RFC8312 congestion controller, as widely used for TCP

Implementations§

Source§

impl Cubic

Source

pub fn new(config: Arc<CubicConfig>, _now: Instant, current_mtu: u16) -> Cubic

Construct a state using the given config and current time now

Trait Implementations§

Source§

impl Clone for Cubic

Source§

fn clone(&self) -> Cubic

Returns a duplicate of the value. Read more
1.0.0 · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Controller for Cubic

Source§

fn on_ack( &mut self, diff --git a/pr/380/docs/iroh_quinn/congestion/struct.CubicConfig.html b/pr/380/docs/iroh_quinn/congestion/struct.CubicConfig.html index 15e7530f0..200f73d9a 100644 --- a/pr/380/docs/iroh_quinn/congestion/struct.CubicConfig.html +++ b/pr/380/docs/iroh_quinn/congestion/struct.CubicConfig.html @@ -1,4 +1,4 @@ -CubicConfig in iroh_quinn::congestion - Rust

CubicConfig

Struct CubicConfig 

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

Configuration for the Cubic congestion controller

+CubicConfig in iroh_quinn::congestion - Rust

CubicConfig

Struct CubicConfig 

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

Configuration for the Cubic congestion controller

Implementations§

Source§

impl CubicConfig

Source

pub fn initial_window(&mut self, value: u64) -> &mut CubicConfig

Default limit on the amount of outstanding data in bytes.

Recommended value: min(10 * max_datagram_size, max(2 * max_datagram_size, 14720))

Trait Implementations§

Source§

impl Clone for CubicConfig

Source§

fn clone(&self) -> CubicConfig

Returns a duplicate of the value. Read more
1.0.0 · Source§

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

Performs copy-assignment from source. Read more
Source§

impl ControllerFactory for CubicConfig

Source§

fn build( diff --git a/pr/380/docs/iroh_quinn/congestion/struct.NewReno.html b/pr/380/docs/iroh_quinn/congestion/struct.NewReno.html index bfd882fb7..d95229378 100644 --- a/pr/380/docs/iroh_quinn/congestion/struct.NewReno.html +++ b/pr/380/docs/iroh_quinn/congestion/struct.NewReno.html @@ -1,4 +1,4 @@ -NewReno in iroh_quinn::congestion - Rust

NewReno

Struct NewReno 

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

A simple, standard congestion controller

+NewReno in iroh_quinn::congestion - Rust

NewReno

Struct NewReno 

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

A simple, standard congestion controller

Implementations§

Source§

impl NewReno

Source

pub fn new( config: Arc<NewRenoConfig>, now: Instant, diff --git a/pr/380/docs/iroh_quinn/congestion/struct.NewRenoConfig.html b/pr/380/docs/iroh_quinn/congestion/struct.NewRenoConfig.html index 780e57712..89d6dd734 100644 --- a/pr/380/docs/iroh_quinn/congestion/struct.NewRenoConfig.html +++ b/pr/380/docs/iroh_quinn/congestion/struct.NewRenoConfig.html @@ -1,4 +1,4 @@ -NewRenoConfig in iroh_quinn::congestion - Rust

NewRenoConfig

Struct NewRenoConfig 

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

Configuration for the NewReno congestion controller

+NewRenoConfig in iroh_quinn::congestion - Rust

NewRenoConfig

Struct NewRenoConfig 

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

Configuration for the NewReno congestion controller

Implementations§

Source§

impl NewRenoConfig

Source

pub fn initial_window(&mut self, value: u64) -> &mut NewRenoConfig

Default limit on the amount of outstanding data in bytes.

Recommended value: min(10 * max_datagram_size, max(2 * max_datagram_size, 14720))

Source

pub fn loss_reduction_factor(&mut self, value: f32) -> &mut NewRenoConfig

Reduction in congestion window when a new loss event is detected.

diff --git a/pr/380/docs/iroh_quinn/congestion/trait.Controller.html b/pr/380/docs/iroh_quinn/congestion/trait.Controller.html index 11dfbeb38..e0e5882dd 100644 --- a/pr/380/docs/iroh_quinn/congestion/trait.Controller.html +++ b/pr/380/docs/iroh_quinn/congestion/trait.Controller.html @@ -1,4 +1,4 @@ -Controller in iroh_quinn::congestion - Rust

Controller

Trait Controller 

Source
pub trait Controller:
+Controller in iroh_quinn::congestion - Rust

Controller

Trait Controller 

Source
pub trait Controller:
     Send
     + Sync
     + Debug {
diff --git a/pr/380/docs/iroh_quinn/congestion/trait.ControllerFactory.html b/pr/380/docs/iroh_quinn/congestion/trait.ControllerFactory.html
index 1d0dd4751..4b3d57ea9 100644
--- a/pr/380/docs/iroh_quinn/congestion/trait.ControllerFactory.html
+++ b/pr/380/docs/iroh_quinn/congestion/trait.ControllerFactory.html
@@ -1,4 +1,4 @@
-ControllerFactory in iroh_quinn::congestion - Rust

ControllerFactory

Trait ControllerFactory 

Source
pub trait ControllerFactory {
+ControllerFactory in iroh_quinn::congestion - Rust

ControllerFactory

Trait ControllerFactory 

Source
pub trait ControllerFactory {
     // Required method
     fn build(
         self: Arc<Self>,
diff --git a/pr/380/docs/iroh_quinn/crypto/index.html b/pr/380/docs/iroh_quinn/crypto/index.html
index d92daa173..615c48abe 100644
--- a/pr/380/docs/iroh_quinn/crypto/index.html
+++ b/pr/380/docs/iroh_quinn/crypto/index.html
@@ -1,4 +1,4 @@
-iroh_quinn::crypto - Rust

Module crypto

Module crypto 

Source
Expand description

Traits and implementations for the QUIC cryptography protocol

+iroh_quinn::crypto - Rust

Module crypto

Module crypto 

Source
Expand description

Traits and implementations for the QUIC cryptography protocol

The protocol logic in Quinn is contained in types that abstract over the actual cryptographic protocol used. This module contains the traits used for this abstraction layer as well as a single implementation of these traits that uses diff --git a/pr/380/docs/iroh_quinn/crypto/rustls/enum.Error.html b/pr/380/docs/iroh_quinn/crypto/rustls/enum.Error.html index 23e8f0ccf..4dbacc902 100644 --- a/pr/380/docs/iroh_quinn/crypto/rustls/enum.Error.html +++ b/pr/380/docs/iroh_quinn/crypto/rustls/enum.Error.html @@ -1,4 +1,4 @@ -Error in iroh_quinn::crypto::rustls - Rust

Error

Enum Error 

#[non_exhaustive]
pub enum Error { +Error in iroh_quinn::crypto::rustls - Rust

Error

Enum Error 

#[non_exhaustive]
pub enum Error {
Show 22 variants InappropriateMessage { expect_types: Vec<ContentType>, got_type: ContentType, diff --git a/pr/380/docs/iroh_quinn/crypto/rustls/index.html b/pr/380/docs/iroh_quinn/crypto/rustls/index.html index 2eb168f80..408115e6c 100644 --- a/pr/380/docs/iroh_quinn/crypto/rustls/index.html +++ b/pr/380/docs/iroh_quinn/crypto/rustls/index.html @@ -1,2 +1,2 @@ -iroh_quinn::crypto::rustls - Rust

Module rustls

Module rustls 

Source
Expand description

TLS interface based on rustls

+iroh_quinn::crypto::rustls - Rust

Module rustls

Module rustls 

Source
Expand description

TLS interface based on rustls

Structs§

HandshakeData
Authentication data for (rustls) TLS session
NoInitialCipherSuite
The initial cipher suite (AES-128-GCM-SHA256) is not available
QuicClientConfig
A QUIC-compatible TLS client configuration
QuicServerConfig
A QUIC-compatible TLS server configuration
TlsSession
A rustls TLS session

Enums§

Error
rustls reports protocol errors using this type.
\ No newline at end of file diff --git a/pr/380/docs/iroh_quinn/crypto/rustls/struct.HandshakeData.html b/pr/380/docs/iroh_quinn/crypto/rustls/struct.HandshakeData.html index 814b2b5c8..7c8a7b1cf 100644 --- a/pr/380/docs/iroh_quinn/crypto/rustls/struct.HandshakeData.html +++ b/pr/380/docs/iroh_quinn/crypto/rustls/struct.HandshakeData.html @@ -1,4 +1,4 @@ -HandshakeData in iroh_quinn::crypto::rustls - Rust

HandshakeData

Struct HandshakeData 

Source
pub struct HandshakeData {
+HandshakeData in iroh_quinn::crypto::rustls - Rust

HandshakeData

Struct HandshakeData 

Source
pub struct HandshakeData {
     pub protocol: Option<Vec<u8>>,
     pub server_name: Option<String>,
     pub negotiated_key_exchange_group: NamedGroup,
diff --git a/pr/380/docs/iroh_quinn/crypto/rustls/struct.NoInitialCipherSuite.html b/pr/380/docs/iroh_quinn/crypto/rustls/struct.NoInitialCipherSuite.html
index 7693826d2..1ce33bf8b 100644
--- a/pr/380/docs/iroh_quinn/crypto/rustls/struct.NoInitialCipherSuite.html
+++ b/pr/380/docs/iroh_quinn/crypto/rustls/struct.NoInitialCipherSuite.html
@@ -1,4 +1,4 @@
-NoInitialCipherSuite in iroh_quinn::crypto::rustls - Rust

NoInitialCipherSuite

Struct NoInitialCipherSuite 

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

The initial cipher suite (AES-128-GCM-SHA256) is not available

+NoInitialCipherSuite in iroh_quinn::crypto::rustls - Rust

NoInitialCipherSuite

Struct NoInitialCipherSuite 

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

The initial cipher suite (AES-128-GCM-SHA256) is not available

When the cipher suite is supplied with_initial(), it must be [CipherSuite::TLS13_AES_128_GCM_SHA256]. When the cipher suite is derived from a config’s CryptoProvider, that provider must reference a cipher suite with the same ID.

diff --git a/pr/380/docs/iroh_quinn/crypto/rustls/struct.QuicClientConfig.html b/pr/380/docs/iroh_quinn/crypto/rustls/struct.QuicClientConfig.html index 307e33042..54d06690b 100644 --- a/pr/380/docs/iroh_quinn/crypto/rustls/struct.QuicClientConfig.html +++ b/pr/380/docs/iroh_quinn/crypto/rustls/struct.QuicClientConfig.html @@ -1,4 +1,4 @@ -QuicClientConfig in iroh_quinn::crypto::rustls - Rust

QuicClientConfig

Struct QuicClientConfig 

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

A QUIC-compatible TLS client configuration

+QuicClientConfig in iroh_quinn::crypto::rustls - Rust

QuicClientConfig

Struct QuicClientConfig 

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

A QUIC-compatible TLS client configuration

Quinn implicitly constructs a QuicClientConfig with reasonable defaults within ClientConfig::with_root_certificates() and ClientConfig::try_with_platform_verifier(). Alternatively, QuicClientConfig’s TryFrom implementation can be used to wrap around a diff --git a/pr/380/docs/iroh_quinn/crypto/rustls/struct.QuicServerConfig.html b/pr/380/docs/iroh_quinn/crypto/rustls/struct.QuicServerConfig.html index ca84c3aff..a80bf2aad 100644 --- a/pr/380/docs/iroh_quinn/crypto/rustls/struct.QuicServerConfig.html +++ b/pr/380/docs/iroh_quinn/crypto/rustls/struct.QuicServerConfig.html @@ -1,4 +1,4 @@ -QuicServerConfig in iroh_quinn::crypto::rustls - Rust

QuicServerConfig

Struct QuicServerConfig 

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

A QUIC-compatible TLS server configuration

+QuicServerConfig in iroh_quinn::crypto::rustls - Rust

QuicServerConfig

Struct QuicServerConfig 

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

A QUIC-compatible TLS server configuration

Quinn implicitly constructs a QuicServerConfig with reasonable defaults within ServerConfig::with_single_cert(). Alternatively, QuicServerConfig’s TryFrom implementation or with_initial method can be used to wrap around a custom diff --git a/pr/380/docs/iroh_quinn/crypto/rustls/struct.TlsSession.html b/pr/380/docs/iroh_quinn/crypto/rustls/struct.TlsSession.html index 78ed11179..55fa0eedd 100644 --- a/pr/380/docs/iroh_quinn/crypto/rustls/struct.TlsSession.html +++ b/pr/380/docs/iroh_quinn/crypto/rustls/struct.TlsSession.html @@ -1,4 +1,4 @@ -TlsSession in iroh_quinn::crypto::rustls - Rust

TlsSession

Struct TlsSession 

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

A rustls TLS session

+TlsSession in iroh_quinn::crypto::rustls - Rust

TlsSession

Struct TlsSession 

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

A rustls TLS session

Trait Implementations§

Source§

impl Session for TlsSession

Source§

fn peer_identity(&self) -> Option<Box<dyn Any>>

For the rustls TlsSession, the Any type is Vec<rustls::pki_types::CertificateDer>

Source§

fn initial_keys(&self, dst_cid: ConnectionId, side: Side) -> Keys

Create the initial set of keys given the client’s initial destination ConnectionId
Source§

fn handshake_data(&self) -> Option<Box<dyn Any>>

Get data negotiated during the handshake, if available Read more
Source§

fn early_crypto(&self) -> Option<(Box<dyn HeaderKey>, Box<dyn PacketKey>)>

Get the 0-RTT keys if available (clients only) Read more
Source§

fn early_data_accepted(&self) -> Option<bool>

If the 0-RTT-encrypted data has been accepted by the peer
Source§

fn is_handshaking(&self) -> bool

Returns true until the connection is fully established.
Source§

fn read_handshake(&mut self, buf: &[u8]) -> Result<bool, Error>

Read bytes of handshake data Read more
Source§

fn transport_parameters(&self) -> Result<Option<TransportParameters>, Error>

The peer’s QUIC transport parameters Read more
Source§

fn write_handshake(&mut self, buf: &mut Vec<u8>) -> Option<Keys>

Writes handshake bytes into the given buffer and optionally returns the negotiated keys Read more
Source§

fn next_1rtt_keys(&mut self) -> Option<KeyPair<Box<dyn PacketKey>>>

Compute keys for the next key update
Source§

fn is_valid_retry( &self, diff --git a/pr/380/docs/iroh_quinn/crypto/struct.CryptoError.html b/pr/380/docs/iroh_quinn/crypto/struct.CryptoError.html index e64ee0338..c7e440336 100644 --- a/pr/380/docs/iroh_quinn/crypto/struct.CryptoError.html +++ b/pr/380/docs/iroh_quinn/crypto/struct.CryptoError.html @@ -1,4 +1,4 @@ -CryptoError in iroh_quinn::crypto - Rust

CryptoError

Struct CryptoError 

Source
pub struct CryptoError;
Expand description

Generic crypto errors

+CryptoError in iroh_quinn::crypto - Rust

CryptoError

Struct CryptoError 

Source
pub struct CryptoError;
Expand description

Generic crypto errors

Trait Implementations§

Source§

impl Debug for CryptoError

Source§

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

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

impl From<Unspecified> for CryptoError

Source§

fn from(_: Unspecified) -> CryptoError

Converts to this type from the input type.

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 diff --git a/pr/380/docs/iroh_quinn/crypto/struct.ExportKeyingMaterialError.html b/pr/380/docs/iroh_quinn/crypto/struct.ExportKeyingMaterialError.html index 4ebc44a52..40bed3edb 100644 --- a/pr/380/docs/iroh_quinn/crypto/struct.ExportKeyingMaterialError.html +++ b/pr/380/docs/iroh_quinn/crypto/struct.ExportKeyingMaterialError.html @@ -1,4 +1,4 @@ -ExportKeyingMaterialError in iroh_quinn::crypto - Rust

ExportKeyingMaterialError

Struct ExportKeyingMaterialError 

Source
pub struct ExportKeyingMaterialError;
Expand description

Error returned by Session::export_keying_material.

+ExportKeyingMaterialError in iroh_quinn::crypto - Rust

ExportKeyingMaterialError

Struct ExportKeyingMaterialError 

Source
pub struct ExportKeyingMaterialError;
Expand description

Error returned by Session::export_keying_material.

This error occurs if the requested output length is too large.

Trait Implementations§

Source§

impl Debug for ExportKeyingMaterialError

Source§

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

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

impl PartialEq for ExportKeyingMaterialError

Source§

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

Tests for self and other values to be equal, and is used by ==.
1.0.0 · Source§

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.
Source§

impl Eq for ExportKeyingMaterialError

Source§

impl StructuralPartialEq for ExportKeyingMaterialError

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where diff --git a/pr/380/docs/iroh_quinn/crypto/struct.KeyPair.html b/pr/380/docs/iroh_quinn/crypto/struct.KeyPair.html index 5b24bb206..20757ff04 100644 --- a/pr/380/docs/iroh_quinn/crypto/struct.KeyPair.html +++ b/pr/380/docs/iroh_quinn/crypto/struct.KeyPair.html @@ -1,4 +1,4 @@ -KeyPair in iroh_quinn::crypto - Rust

KeyPair

Struct KeyPair 

Source
pub struct KeyPair<T> {
+KeyPair in iroh_quinn::crypto - Rust

KeyPair

Struct KeyPair 

Source
pub struct KeyPair<T> {
     pub local: T,
     pub remote: T,
 }
Expand description

A pair of keys for bidirectional communication

diff --git a/pr/380/docs/iroh_quinn/crypto/struct.Keys.html b/pr/380/docs/iroh_quinn/crypto/struct.Keys.html index ea7de4c19..491208804 100644 --- a/pr/380/docs/iroh_quinn/crypto/struct.Keys.html +++ b/pr/380/docs/iroh_quinn/crypto/struct.Keys.html @@ -1,4 +1,4 @@ -Keys in iroh_quinn::crypto - Rust

Keys

Struct Keys 

Source
pub struct Keys {
+Keys in iroh_quinn::crypto - Rust

Keys

Struct Keys 

Source
pub struct Keys {
     pub header: KeyPair<Box<dyn HeaderKey>>,
     pub packet: KeyPair<Box<dyn PacketKey>>,
 }
Expand description

A complete set of keys for a certain packet space

diff --git a/pr/380/docs/iroh_quinn/crypto/struct.UnsupportedVersion.html b/pr/380/docs/iroh_quinn/crypto/struct.UnsupportedVersion.html index 2b352bf9b..6e6350375 100644 --- a/pr/380/docs/iroh_quinn/crypto/struct.UnsupportedVersion.html +++ b/pr/380/docs/iroh_quinn/crypto/struct.UnsupportedVersion.html @@ -1,4 +1,4 @@ -UnsupportedVersion in iroh_quinn::crypto - Rust

UnsupportedVersion

Struct UnsupportedVersion 

Source
pub struct UnsupportedVersion;
Expand description

Error indicating that the specified QUIC version is not supported

+UnsupportedVersion in iroh_quinn::crypto - Rust

UnsupportedVersion

Struct UnsupportedVersion 

Source
pub struct UnsupportedVersion;
Expand description

Error indicating that the specified QUIC version is not supported

Trait Implementations§

Source§

impl Debug for UnsupportedVersion

Source§

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

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

impl From<UnsupportedVersion> for ConnectError

Source§

fn from(_: UnsupportedVersion) -> ConnectError

Converts to this type from the input type.

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 diff --git a/pr/380/docs/iroh_quinn/crypto/trait.AeadKey.html b/pr/380/docs/iroh_quinn/crypto/trait.AeadKey.html index acbd35daf..c587dd06a 100644 --- a/pr/380/docs/iroh_quinn/crypto/trait.AeadKey.html +++ b/pr/380/docs/iroh_quinn/crypto/trait.AeadKey.html @@ -1,4 +1,4 @@ -AeadKey in iroh_quinn::crypto - Rust

AeadKey

Trait AeadKey 

Source
pub trait AeadKey {
+AeadKey in iroh_quinn::crypto - Rust

AeadKey

Trait AeadKey 

Source
pub trait AeadKey {
     // Required methods
     fn seal(
         &self,
diff --git a/pr/380/docs/iroh_quinn/crypto/trait.ClientConfig.html b/pr/380/docs/iroh_quinn/crypto/trait.ClientConfig.html
index fe95319b8..65375c0ab 100644
--- a/pr/380/docs/iroh_quinn/crypto/trait.ClientConfig.html
+++ b/pr/380/docs/iroh_quinn/crypto/trait.ClientConfig.html
@@ -1,4 +1,4 @@
-ClientConfig in iroh_quinn::crypto - Rust

ClientConfig

Trait ClientConfig 

Source
pub trait ClientConfig: Send + Sync {
+ClientConfig in iroh_quinn::crypto - Rust

ClientConfig

Trait ClientConfig 

Source
pub trait ClientConfig: Send + Sync {
     // Required method
     fn start_session(
         self: Arc<Self>,
diff --git a/pr/380/docs/iroh_quinn/crypto/trait.HandshakeTokenKey.html b/pr/380/docs/iroh_quinn/crypto/trait.HandshakeTokenKey.html
index 0ad0fe8f1..59f558014 100644
--- a/pr/380/docs/iroh_quinn/crypto/trait.HandshakeTokenKey.html
+++ b/pr/380/docs/iroh_quinn/crypto/trait.HandshakeTokenKey.html
@@ -1,4 +1,4 @@
-HandshakeTokenKey in iroh_quinn::crypto - Rust

HandshakeTokenKey

Trait HandshakeTokenKey 

Source
pub trait HandshakeTokenKey: Send + Sync {
+HandshakeTokenKey in iroh_quinn::crypto - Rust

HandshakeTokenKey

Trait HandshakeTokenKey 

Source
pub trait HandshakeTokenKey: Send + Sync {
     // Required method
     fn aead_from_hkdf(&self, random_bytes: &[u8]) -> Box<dyn AeadKey>;
 }
Expand description

A pseudo random key for HKDF

diff --git a/pr/380/docs/iroh_quinn/crypto/trait.HeaderKey.html b/pr/380/docs/iroh_quinn/crypto/trait.HeaderKey.html index 4a73acb6f..414ce78e4 100644 --- a/pr/380/docs/iroh_quinn/crypto/trait.HeaderKey.html +++ b/pr/380/docs/iroh_quinn/crypto/trait.HeaderKey.html @@ -1,4 +1,4 @@ -HeaderKey in iroh_quinn::crypto - Rust

HeaderKey

Trait HeaderKey 

Source
pub trait HeaderKey: Send + Sync {
+HeaderKey in iroh_quinn::crypto - Rust

HeaderKey

Trait HeaderKey 

Source
pub trait HeaderKey: Send + Sync {
     // Required methods
     fn decrypt(&self, pn_offset: usize, packet: &mut [u8]);
     fn encrypt(&self, pn_offset: usize, packet: &mut [u8]);
diff --git a/pr/380/docs/iroh_quinn/crypto/trait.HmacKey.html b/pr/380/docs/iroh_quinn/crypto/trait.HmacKey.html
index d30159d07..1a6f96b11 100644
--- a/pr/380/docs/iroh_quinn/crypto/trait.HmacKey.html
+++ b/pr/380/docs/iroh_quinn/crypto/trait.HmacKey.html
@@ -1,4 +1,4 @@
-HmacKey in iroh_quinn::crypto - Rust

HmacKey

Trait HmacKey 

Source
pub trait HmacKey: Send + Sync {
+HmacKey in iroh_quinn::crypto - Rust

HmacKey

Trait HmacKey 

Source
pub trait HmacKey: Send + Sync {
     // Required methods
     fn sign(&self, data: &[u8], signature_out: &mut [u8]);
     fn signature_len(&self) -> usize;
diff --git a/pr/380/docs/iroh_quinn/crypto/trait.PacketKey.html b/pr/380/docs/iroh_quinn/crypto/trait.PacketKey.html
index fcd862f0b..70d769abf 100644
--- a/pr/380/docs/iroh_quinn/crypto/trait.PacketKey.html
+++ b/pr/380/docs/iroh_quinn/crypto/trait.PacketKey.html
@@ -1,4 +1,4 @@
-PacketKey in iroh_quinn::crypto - Rust

PacketKey

Trait PacketKey 

Source
pub trait PacketKey: Send + Sync {
+PacketKey in iroh_quinn::crypto - Rust

PacketKey

Trait PacketKey 

Source
pub trait PacketKey: Send + Sync {
     // Required methods
     fn encrypt(
         &self,
diff --git a/pr/380/docs/iroh_quinn/crypto/trait.ServerConfig.html b/pr/380/docs/iroh_quinn/crypto/trait.ServerConfig.html
index 8a2733cae..7e75b0427 100644
--- a/pr/380/docs/iroh_quinn/crypto/trait.ServerConfig.html
+++ b/pr/380/docs/iroh_quinn/crypto/trait.ServerConfig.html
@@ -1,4 +1,4 @@
-ServerConfig in iroh_quinn::crypto - Rust

ServerConfig

Trait ServerConfig 

Source
pub trait ServerConfig: Send + Sync {
+ServerConfig in iroh_quinn::crypto - Rust

ServerConfig

Trait ServerConfig 

Source
pub trait ServerConfig: Send + Sync {
     // Required methods
     fn initial_keys(
         &self,
diff --git a/pr/380/docs/iroh_quinn/crypto/trait.Session.html b/pr/380/docs/iroh_quinn/crypto/trait.Session.html
index 8bfa5f6c9..cd1c5850c 100644
--- a/pr/380/docs/iroh_quinn/crypto/trait.Session.html
+++ b/pr/380/docs/iroh_quinn/crypto/trait.Session.html
@@ -1,4 +1,4 @@
-Session in iroh_quinn::crypto - Rust

Session

Trait Session 

Source
pub trait Session:
+Session in iroh_quinn::crypto - Rust

Session

Trait Session 

Source
pub trait Session:
     Send
     + Sync
     + 'static {
diff --git a/pr/380/docs/iroh_quinn/enum.ConfigError.html b/pr/380/docs/iroh_quinn/enum.ConfigError.html
index 4d9da292b..5ee8c912e 100644
--- a/pr/380/docs/iroh_quinn/enum.ConfigError.html
+++ b/pr/380/docs/iroh_quinn/enum.ConfigError.html
@@ -1,4 +1,4 @@
-ConfigError in iroh_quinn - Rust

ConfigError

Enum ConfigError 

Source
#[non_exhaustive]
pub enum ConfigError { +ConfigError in iroh_quinn - Rust

ConfigError

Enum ConfigError 

Source
#[non_exhaustive]
pub enum ConfigError { OutOfBounds, }
Expand description

Errors in the configuration of an endpoint

Variants (Non-exhaustive)§

This enum is marked as non-exhaustive
Non-exhaustive enums could have additional variants added in future. Therefore, when matching against variants of non-exhaustive enums, an extra wildcard arm must be added to account for any future variants.
§

OutOfBounds

Value exceeds supported bounds

diff --git a/pr/380/docs/iroh_quinn/enum.ConnectError.html b/pr/380/docs/iroh_quinn/enum.ConnectError.html index 9628f1c50..e2081e7e0 100644 --- a/pr/380/docs/iroh_quinn/enum.ConnectError.html +++ b/pr/380/docs/iroh_quinn/enum.ConnectError.html @@ -1,4 +1,4 @@ -ConnectError in iroh_quinn - Rust

ConnectError

Enum ConnectError 

Source
pub enum ConnectError {
+ConnectError in iroh_quinn - Rust

ConnectError

Enum ConnectError 

Source
pub enum ConnectError {
     EndpointStopping,
     CidsExhausted,
     InvalidServerName(String),
diff --git a/pr/380/docs/iroh_quinn/enum.ConnectionError.html b/pr/380/docs/iroh_quinn/enum.ConnectionError.html
index ac362979f..ee4dbbbe2 100644
--- a/pr/380/docs/iroh_quinn/enum.ConnectionError.html
+++ b/pr/380/docs/iroh_quinn/enum.ConnectionError.html
@@ -1,4 +1,4 @@
-ConnectionError in iroh_quinn - Rust

ConnectionError

Enum ConnectionError 

Source
pub enum ConnectionError {
+ConnectionError in iroh_quinn - Rust

ConnectionError

Enum ConnectionError 

Source
pub enum ConnectionError {
     VersionMismatch,
     TransportError(Error),
     ConnectionClosed(ConnectionClose),
@@ -20,8 +20,8 @@ and §

LocallyClosed

The local application closed the connection

§

CidsExhausted

The connection could not be created because not enough of the CID space is available

Try using longer connection IDs.

-

Trait Implementations§

Source§

impl Clone for ConnectionError

Source§

fn clone(&self) -> ConnectionError

Returns a duplicate of the value. Read more
1.0.0 · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for ConnectionError

Source§

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

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

impl Display for ConnectionError

Source§

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

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

impl Error for ConnectionError

Source§

fn source(&self) -> Option<&(dyn Error + 'static)>

Returns the lower-level source of this error, if any. Read more
1.0.0 · Source§

fn description(&self) -> &str

👎Deprecated since 1.42.0: use the Display impl or to_string()
1.0.0 · Source§

fn cause(&self) -> Option<&dyn Error>

👎Deprecated since 1.33.0: replaced by Error::source, which can support downcasting
Source§

fn provide<'a>(&'a self, request: &mut Request<'a>)

🔬This is a nightly-only experimental API. (error_generic_member_access)
Provides type-based access to context intended for error reports. Read more
Source§

impl From<Close> for ConnectionError

Source§

fn from(x: Close) -> ConnectionError

Converts to this type from the input type.
Source§

impl From<CloseReason> for ConnectionError

Source§

fn from(value: CloseReason) -> ConnectionError

Converts to this type from the input type.
Source§

impl From<ConnectionError> for ReadError

Source§

fn from(source: ConnectionError) -> Self

Converts to this type from the input type.
Source§

impl From<ConnectionError> for ResetError

Source§

fn from(source: ConnectionError) -> Self

Converts to this type from the input type.
Source§

impl From<ConnectionError> for SendDatagramError

Source§

fn from(source: ConnectionError) -> Self

Converts to this type from the input type.
Source§

impl From<ConnectionError> for StoppedError

Source§

fn from(source: ConnectionError) -> Self

Converts to this type from the input type.
Source§

impl From<ConnectionError> for WriteError

Source§

fn from(source: ConnectionError) -> Self

Converts to this type from the input type.
Source§

impl From<Error> for ConnectionError

Source§

fn from(source: Error) -> ConnectionError

Converts to this type from the input type.
Source§

impl PartialEq for ConnectionError

Source§

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

Tests for self and other values to be equal, and is used by ==.
1.0.0 · Source§

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

Tests for !=. The default implementation is almost always sufficient, -and should not be overridden without very good reason.
Source§

impl Eq for ConnectionError

Source§

impl StructuralPartialEq for ConnectionError

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where +

Trait Implementations§

Source§

impl Clone for ConnectionError

Source§

fn clone(&self) -> ConnectionError

Returns a duplicate of the value. Read more
1.0.0 · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for ConnectionError

Source§

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

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

impl Display for ConnectionError

Source§

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

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

impl Error for ConnectionError

Source§

fn source(&self) -> Option<&(dyn Error + 'static)>

Returns the lower-level source of this error, if any. Read more
1.0.0 · Source§

fn description(&self) -> &str

👎Deprecated since 1.42.0: use the Display impl or to_string()
1.0.0 · Source§

fn cause(&self) -> Option<&dyn Error>

👎Deprecated since 1.33.0: replaced by Error::source, which can support downcasting
Source§

fn provide<'a>(&'a self, request: &mut Request<'a>)

🔬This is a nightly-only experimental API. (error_generic_member_access)
Provides type-based access to context intended for error reports. Read more
Source§

impl From<Close> for ConnectionError

Source§

fn from(x: Close) -> ConnectionError

Converts to this type from the input type.
Source§

impl From<CloseReason> for ConnectionError

Source§

fn from(value: CloseReason) -> ConnectionError

Converts to this type from the input type.
Source§

impl From<ConnectionError> for ReadError

Source§

fn from(source: ConnectionError) -> Self

Converts to this type from the input type.
Source§

impl From<ConnectionError> for ResetError

Source§

fn from(source: ConnectionError) -> Self

Converts to this type from the input type.
Source§

impl From<ConnectionError> for SendDatagramError

Source§

fn from(source: ConnectionError) -> Self

Converts to this type from the input type.
Source§

impl From<ConnectionError> for StoppedError

Source§

fn from(source: ConnectionError) -> Self

Converts to this type from the input type.
Source§

impl From<ConnectionError> for WriteError

Source§

fn from(source: ConnectionError) -> Self

Converts to this type from the input type.
Source§

impl From<Error> for ConnectionError

Source§

fn from(source: Error) -> ConnectionError

Converts to this type from the input type.
Source§

impl PartialEq for ConnectionError

Source§

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

Tests for self and other values to be equal, and is used by ==.
1.0.0 · Source§

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

Tests for !=. The default implementation is almost always sufficient, +and should not be overridden without very good reason.
Source§

impl Eq for ConnectionError

Source§

impl StructuralPartialEq for ConnectionError

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 diff --git a/pr/380/docs/iroh_quinn/enum.Dir.html b/pr/380/docs/iroh_quinn/enum.Dir.html index 1a02f7ceb..620593800 100644 --- a/pr/380/docs/iroh_quinn/enum.Dir.html +++ b/pr/380/docs/iroh_quinn/enum.Dir.html @@ -1,4 +1,4 @@ -Dir in iroh_quinn - Rust

Dir

Enum Dir 

Source
pub enum Dir {
+Dir in iroh_quinn - Rust

Dir

Enum Dir 

Source
pub enum Dir {
     Bi = 0,
     Uni = 1,
 }
Expand description

Whether a stream communicates data in both directions or only from the initiator

diff --git a/pr/380/docs/iroh_quinn/enum.EcnCodepoint.html b/pr/380/docs/iroh_quinn/enum.EcnCodepoint.html index 3b7c8c6c7..0e41f2048 100644 --- a/pr/380/docs/iroh_quinn/enum.EcnCodepoint.html +++ b/pr/380/docs/iroh_quinn/enum.EcnCodepoint.html @@ -1,4 +1,4 @@ -EcnCodepoint in iroh_quinn - Rust

EcnCodepoint

Enum EcnCodepoint 

Source
#[repr(u8)]
pub enum EcnCodepoint { +EcnCodepoint in iroh_quinn - Rust

EcnCodepoint

Enum EcnCodepoint 

Source
#[repr(u8)]
pub enum EcnCodepoint { Ect0 = 2, Ect1 = 1, Ce = 3, diff --git a/pr/380/docs/iroh_quinn/enum.FrameType.html b/pr/380/docs/iroh_quinn/enum.FrameType.html index f7330d75f..10e16ff16 100644 --- a/pr/380/docs/iroh_quinn/enum.FrameType.html +++ b/pr/380/docs/iroh_quinn/enum.FrameType.html @@ -1,4 +1,4 @@ -FrameType in iroh_quinn - Rust

FrameType

Enum FrameType 

Source
pub enum FrameType {
+FrameType in iroh_quinn - Rust

FrameType

Enum FrameType 

Source
pub enum FrameType {
 
Show 44 variants Padding, Ping, Ack, diff --git a/pr/380/docs/iroh_quinn/enum.ReadError.html b/pr/380/docs/iroh_quinn/enum.ReadError.html index 5a92b7254..ce7870933 100644 --- a/pr/380/docs/iroh_quinn/enum.ReadError.html +++ b/pr/380/docs/iroh_quinn/enum.ReadError.html @@ -1,4 +1,4 @@ -ReadError in iroh_quinn - Rust

ReadError

Enum ReadError 

Source
pub enum ReadError {
+ReadError in iroh_quinn - Rust

ReadError

Enum ReadError 

Source
pub enum ReadError {
     Reset(VarInt),
     ConnectionLost(ConnectionError),
     ClosedStream,
diff --git a/pr/380/docs/iroh_quinn/enum.ReadExactError.html b/pr/380/docs/iroh_quinn/enum.ReadExactError.html
index b2d757b3c..597fd7ec6 100644
--- a/pr/380/docs/iroh_quinn/enum.ReadExactError.html
+++ b/pr/380/docs/iroh_quinn/enum.ReadExactError.html
@@ -1,4 +1,4 @@
-ReadExactError in iroh_quinn - Rust

ReadExactError

Enum ReadExactError 

Source
pub enum ReadExactError {
+ReadExactError in iroh_quinn - Rust

ReadExactError

Enum ReadExactError 

Source
pub enum ReadExactError {
     FinishedEarly(usize),
     ReadError(ReadError),
 }
Expand description

Errors that arise from reading from a stream.

diff --git a/pr/380/docs/iroh_quinn/enum.ReadToEndError.html b/pr/380/docs/iroh_quinn/enum.ReadToEndError.html index 4a4d027ae..766ff1519 100644 --- a/pr/380/docs/iroh_quinn/enum.ReadToEndError.html +++ b/pr/380/docs/iroh_quinn/enum.ReadToEndError.html @@ -1,4 +1,4 @@ -ReadToEndError in iroh_quinn - Rust

ReadToEndError

Enum ReadToEndError 

Source
pub enum ReadToEndError {
+ReadToEndError in iroh_quinn - Rust

ReadToEndError

Enum ReadToEndError 

Source
pub enum ReadToEndError {
     Read(ReadError),
     TooLong,
 }
Expand description

Errors from RecvStream::read_to_end

diff --git a/pr/380/docs/iroh_quinn/enum.ResetError.html b/pr/380/docs/iroh_quinn/enum.ResetError.html index ae4b859ab..fc4b3323a 100644 --- a/pr/380/docs/iroh_quinn/enum.ResetError.html +++ b/pr/380/docs/iroh_quinn/enum.ResetError.html @@ -1,4 +1,4 @@ -ResetError in iroh_quinn - Rust

ResetError

Enum ResetError 

Source
pub enum ResetError {
+ResetError in iroh_quinn - Rust

ResetError

Enum ResetError 

Source
pub enum ResetError {
     ConnectionLost(ConnectionError),
     ZeroRttRejected,
 }
Expand description

Errors that arise while waiting for a stream to be reset

diff --git a/pr/380/docs/iroh_quinn/enum.SendDatagramError.html b/pr/380/docs/iroh_quinn/enum.SendDatagramError.html index 77490f206..3e3339088 100644 --- a/pr/380/docs/iroh_quinn/enum.SendDatagramError.html +++ b/pr/380/docs/iroh_quinn/enum.SendDatagramError.html @@ -1,4 +1,4 @@ -SendDatagramError in iroh_quinn - Rust

SendDatagramError

Enum SendDatagramError 

Source
pub enum SendDatagramError {
+SendDatagramError in iroh_quinn - Rust

SendDatagramError

Enum SendDatagramError 

Source
pub enum SendDatagramError {
     UnsupportedByPeer,
     Disabled,
     TooLarge,
@@ -10,8 +10,8 @@
 

Indicates that the path MTU minus overhead or the limit advertised by the peer has been exceeded.

§

ConnectionLost(ConnectionError)

The connection was lost

-

Trait Implementations§

Source§

impl Clone for SendDatagramError

Source§

fn clone(&self) -> SendDatagramError

Returns a duplicate of the value. Read more
1.0.0 · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for SendDatagramError

Source§

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

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

impl Display for SendDatagramError

Source§

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

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

impl Error for SendDatagramError

Source§

fn source(&self) -> Option<&(dyn Error + 'static)>

Returns the lower-level source of this error, if any. Read more
1.0.0 · Source§

fn description(&self) -> &str

👎Deprecated since 1.42.0: use the Display impl or to_string()
1.0.0 · Source§

fn cause(&self) -> Option<&dyn Error>

👎Deprecated since 1.33.0: replaced by Error::source, which can support downcasting
Source§

fn provide<'a>(&'a self, request: &mut Request<'a>)

🔬This is a nightly-only experimental API. (error_generic_member_access)
Provides type-based access to context intended for error reports. Read more
Source§

impl From<ConnectionError> for SendDatagramError

Source§

fn from(source: ConnectionError) -> Self

Converts to this type from the input type.
Source§

impl PartialEq for SendDatagramError

Source§

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

Tests for self and other values to be equal, and is used by ==.
1.0.0 · Source§

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

Tests for !=. The default implementation is almost always sufficient, -and should not be overridden without very good reason.
Source§

impl Eq for SendDatagramError

Source§

impl StructuralPartialEq for SendDatagramError

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where +

Trait Implementations§

Source§

impl Clone for SendDatagramError

Source§

fn clone(&self) -> SendDatagramError

Returns a duplicate of the value. Read more
1.0.0 · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for SendDatagramError

Source§

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

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

impl Display for SendDatagramError

Source§

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

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

impl Error for SendDatagramError

Source§

fn source(&self) -> Option<&(dyn Error + 'static)>

Returns the lower-level source of this error, if any. Read more
1.0.0 · Source§

fn description(&self) -> &str

👎Deprecated since 1.42.0: use the Display impl or to_string()
1.0.0 · Source§

fn cause(&self) -> Option<&dyn Error>

👎Deprecated since 1.33.0: replaced by Error::source, which can support downcasting
Source§

fn provide<'a>(&'a self, request: &mut Request<'a>)

🔬This is a nightly-only experimental API. (error_generic_member_access)
Provides type-based access to context intended for error reports. Read more
Source§

impl From<ConnectionError> for SendDatagramError

Source§

fn from(source: ConnectionError) -> Self

Converts to this type from the input type.
Source§

impl PartialEq for SendDatagramError

Source§

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

Tests for self and other values to be equal, and is used by ==.
1.0.0 · Source§

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

Tests for !=. The default implementation is almost always sufficient, +and should not be overridden without very good reason.
Source§

impl Eq for SendDatagramError

Source§

impl StructuralPartialEq for SendDatagramError

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 diff --git a/pr/380/docs/iroh_quinn/enum.Side.html b/pr/380/docs/iroh_quinn/enum.Side.html index a1c896a84..323768e71 100644 --- a/pr/380/docs/iroh_quinn/enum.Side.html +++ b/pr/380/docs/iroh_quinn/enum.Side.html @@ -1,4 +1,4 @@ -Side in iroh_quinn - Rust

Side

Enum Side 

Source
pub enum Side {
+Side in iroh_quinn - Rust

Side

Enum Side 

Source
pub enum Side {
     Client = 0,
     Server = 1,
 }
Expand description

Whether an endpoint was the initiator of a connection

diff --git a/pr/380/docs/iroh_quinn/enum.StoppedError.html b/pr/380/docs/iroh_quinn/enum.StoppedError.html index d999eee2a..b6dd1d97d 100644 --- a/pr/380/docs/iroh_quinn/enum.StoppedError.html +++ b/pr/380/docs/iroh_quinn/enum.StoppedError.html @@ -1,4 +1,4 @@ -StoppedError in iroh_quinn - Rust

StoppedError

Enum StoppedError 

Source
pub enum StoppedError {
+StoppedError in iroh_quinn - Rust

StoppedError

Enum StoppedError 

Source
pub enum StoppedError {
     ConnectionLost(ConnectionError),
     ZeroRttRejected,
 }
Expand description

Errors that arise while monitoring for a send stream stop from the peer

diff --git a/pr/380/docs/iroh_quinn/enum.WriteError.html b/pr/380/docs/iroh_quinn/enum.WriteError.html index 09cc3b7ad..2366c22c2 100644 --- a/pr/380/docs/iroh_quinn/enum.WriteError.html +++ b/pr/380/docs/iroh_quinn/enum.WriteError.html @@ -1,4 +1,4 @@ -WriteError in iroh_quinn - Rust

WriteError

Enum WriteError 

Source
pub enum WriteError {
+WriteError in iroh_quinn - Rust

WriteError

Enum WriteError 

Source
pub enum WriteError {
     Stopped(VarInt),
     ConnectionLost(ConnectionError),
     ClosedStream,
diff --git a/pr/380/docs/iroh_quinn/fn.default_runtime.html b/pr/380/docs/iroh_quinn/fn.default_runtime.html
index cc1298911..064be3430 100644
--- a/pr/380/docs/iroh_quinn/fn.default_runtime.html
+++ b/pr/380/docs/iroh_quinn/fn.default_runtime.html
@@ -1,4 +1,4 @@
-default_runtime in iroh_quinn - Rust

default_runtime

Function default_runtime 

Source
pub fn default_runtime() -> Option<Arc<dyn Runtime>>
Expand description

Automatically select an appropriate runtime from those enabled at compile time

+default_runtime in iroh_quinn - Rust

default_runtime

Function default_runtime 

Source
pub fn default_runtime() -> Option<Arc<dyn Runtime>>
Expand description

Automatically select an appropriate runtime from those enabled at compile time

If runtime-tokio is enabled and this function is called from within a Tokio runtime context, then TokioRuntime is returned. Otherwise, if runtime-smol is enabled, SmolRuntime is returned. Otherwise, None is returned.

diff --git a/pr/380/docs/iroh_quinn/index.html b/pr/380/docs/iroh_quinn/index.html index 104bb13c5..43f26c78c 100644 --- a/pr/380/docs/iroh_quinn/index.html +++ b/pr/380/docs/iroh_quinn/index.html @@ -1,4 +1,4 @@ -iroh_quinn - Rust

Crate iroh_quinn

Crate iroh_quinn 

Source
Expand description

QUIC transport protocol implementation

+iroh_quinn - Rust

Crate iroh_quinn

Crate iroh_quinn 

Source
Expand description

QUIC transport protocol implementation

QUIC is a modern transport protocol addressing shortcomings of TCP, such as head-of-line blocking, poor security, slow handshakes, and inefficient congestion control. This crate provides a portable userspace implementation. It diff --git a/pr/380/docs/iroh_quinn/struct.Accept.html b/pr/380/docs/iroh_quinn/struct.Accept.html index 905a29d81..0cef1610b 100644 --- a/pr/380/docs/iroh_quinn/struct.Accept.html +++ b/pr/380/docs/iroh_quinn/struct.Accept.html @@ -1,4 +1,4 @@ -Accept in iroh_quinn - Rust

Accept

Struct Accept 

Source
pub struct Accept<'a> { /* private fields */ }
Expand description

Future produced by Endpoint::accept

+Accept in iroh_quinn - Rust

Accept

Struct Accept 

Source
pub struct Accept<'a> { /* private fields */ }
Expand description

Future produced by Endpoint::accept

Trait Implementations§

Source§

impl Future for Accept<'_>

Source§

type Output = Option<Incoming>

The type of value produced on completion.
Source§

fn poll(self: Pin<&mut Self>, ctx: &mut Context<'_>) -> Poll<Self::Output>

Attempts to resolve the future to a final value, registering the current task for wakeup if the value is not yet available. Read more
Source§

impl<'__pin, 'a> Unpin for Accept<'a>
where PinnedFieldsOf<__Origin<'__pin, 'a>>: Unpin,

Auto Trait Implementations§

§

impl<'a> !Freeze for Accept<'a>

§

impl<'a> !RefUnwindSafe for Accept<'a>

§

impl<'a> Send for Accept<'a>

§

impl<'a> Sync for Accept<'a>

§

impl<'a> !UnwindSafe for Accept<'a>

Blanket Implementations§

Source§

impl<T> Any for T
where diff --git a/pr/380/docs/iroh_quinn/struct.AcceptBi.html b/pr/380/docs/iroh_quinn/struct.AcceptBi.html index 1b7ecba2d..85b92603a 100644 --- a/pr/380/docs/iroh_quinn/struct.AcceptBi.html +++ b/pr/380/docs/iroh_quinn/struct.AcceptBi.html @@ -1,6 +1,6 @@ -AcceptBi in iroh_quinn - Rust

AcceptBi

Struct AcceptBi 

Source
pub struct AcceptBi<'a> { /* private fields */ }
Expand description

Future produced by Connection::accept_bi

-

Trait Implementations§

Source§

impl Future for AcceptBi<'_>

Source§

type Output = Result<(SendStream, RecvStream), ConnectionError>

The type of value produced on completion.
Source§

fn poll(self: Pin<&mut Self>, ctx: &mut Context<'_>) -> Poll<Self::Output>

Attempts to resolve the future to a final value, registering -the current task for wakeup if the value is not yet available. Read more
Source§

impl<'__pin, 'a> Unpin for AcceptBi<'a>
where +AcceptBi in iroh_quinn - Rust

AcceptBi

Struct AcceptBi 

Source
pub struct AcceptBi<'a> { /* private fields */ }
Expand description

Future produced by Connection::accept_bi

+

Trait Implementations§

Source§

impl Future for AcceptBi<'_>

Source§

type Output = Result<(SendStream, RecvStream), ConnectionError>

The type of value produced on completion.
Source§

fn poll(self: Pin<&mut Self>, ctx: &mut Context<'_>) -> Poll<Self::Output>

Attempts to resolve the future to a final value, registering +the current task for wakeup if the value is not yet available. Read more
Source§

impl<'__pin, 'a> Unpin for AcceptBi<'a>
where PinnedFieldsOf<__Origin<'__pin, 'a>>: Unpin,

Auto Trait Implementations§

§

impl<'a> !Freeze for AcceptBi<'a>

§

impl<'a> !RefUnwindSafe for AcceptBi<'a>

§

impl<'a> Send for AcceptBi<'a>

§

impl<'a> Sync for AcceptBi<'a>

§

impl<'a> !UnwindSafe for AcceptBi<'a>

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 diff --git a/pr/380/docs/iroh_quinn/struct.AcceptUni.html b/pr/380/docs/iroh_quinn/struct.AcceptUni.html index 12ada28f4..e27354dee 100644 --- a/pr/380/docs/iroh_quinn/struct.AcceptUni.html +++ b/pr/380/docs/iroh_quinn/struct.AcceptUni.html @@ -1,6 +1,6 @@ -AcceptUni in iroh_quinn - Rust

AcceptUni

Struct AcceptUni 

Source
pub struct AcceptUni<'a> { /* private fields */ }
Expand description

Future produced by Connection::accept_uni

-

Trait Implementations§

Source§

impl Future for AcceptUni<'_>

Source§

type Output = Result<RecvStream, ConnectionError>

The type of value produced on completion.
Source§

fn poll(self: Pin<&mut Self>, ctx: &mut Context<'_>) -> Poll<Self::Output>

Attempts to resolve the future to a final value, registering -the current task for wakeup if the value is not yet available. Read more
Source§

impl<'__pin, 'a> Unpin for AcceptUni<'a>
where +AcceptUni in iroh_quinn - Rust

AcceptUni

Struct AcceptUni 

Source
pub struct AcceptUni<'a> { /* private fields */ }
Expand description

Future produced by Connection::accept_uni

+

Trait Implementations§

Source§

impl Future for AcceptUni<'_>

Source§

type Output = Result<RecvStream, ConnectionError>

The type of value produced on completion.
Source§

fn poll(self: Pin<&mut Self>, ctx: &mut Context<'_>) -> Poll<Self::Output>

Attempts to resolve the future to a final value, registering +the current task for wakeup if the value is not yet available. Read more
Source§

impl<'__pin, 'a> Unpin for AcceptUni<'a>
where PinnedFieldsOf<__Origin<'__pin, 'a>>: Unpin,

Auto Trait Implementations§

§

impl<'a> !Freeze for AcceptUni<'a>

§

impl<'a> !RefUnwindSafe for AcceptUni<'a>

§

impl<'a> Send for AcceptUni<'a>

§

impl<'a> Sync for AcceptUni<'a>

§

impl<'a> !UnwindSafe for AcceptUni<'a>

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 diff --git a/pr/380/docs/iroh_quinn/struct.AckFrequencyConfig.html b/pr/380/docs/iroh_quinn/struct.AckFrequencyConfig.html index 769b46b26..8af0205c6 100644 --- a/pr/380/docs/iroh_quinn/struct.AckFrequencyConfig.html +++ b/pr/380/docs/iroh_quinn/struct.AckFrequencyConfig.html @@ -1,4 +1,4 @@ -AckFrequencyConfig in iroh_quinn - Rust

AckFrequencyConfig

Struct AckFrequencyConfig 

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

Parameters for controlling the peer’s acknowledgement frequency

+AckFrequencyConfig in iroh_quinn - Rust

AckFrequencyConfig

Struct AckFrequencyConfig 

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

Parameters for controlling the peer’s acknowledgement frequency

The parameters provided in this config will be sent to the peer at the beginning of the connection, so it can take them into account when sending acknowledgements (see each parameter’s description for details on how it influences acknowledgement frequency).

diff --git a/pr/380/docs/iroh_quinn/struct.AddressDiscovery.html b/pr/380/docs/iroh_quinn/struct.AddressDiscovery.html index 77e8ebfb9..3c59b81e7 100644 --- a/pr/380/docs/iroh_quinn/struct.AddressDiscovery.html +++ b/pr/380/docs/iroh_quinn/struct.AddressDiscovery.html @@ -1,4 +1,4 @@ -AddressDiscovery in iroh_quinn - Rust

AddressDiscovery

Struct AddressDiscovery 

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

Stream produced by Path::observed_external_addr

+AddressDiscovery in iroh_quinn - Rust

AddressDiscovery

Struct AddressDiscovery 

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

Stream produced by Path::observed_external_addr

This will always return the external address most recently reported by the remote over this path. If the extension is not negotiated, this stream will never return.

Trait Implementations§

Source§

impl Stream for AddressDiscovery

Source§

type Item = SocketAddr

Values yielded by the stream.
Source§

fn poll_next( diff --git a/pr/380/docs/iroh_quinn/struct.ApplicationClose.html b/pr/380/docs/iroh_quinn/struct.ApplicationClose.html index 2c7727f4d..390c99703 100644 --- a/pr/380/docs/iroh_quinn/struct.ApplicationClose.html +++ b/pr/380/docs/iroh_quinn/struct.ApplicationClose.html @@ -1,4 +1,4 @@ -ApplicationClose in iroh_quinn - Rust

ApplicationClose

Struct ApplicationClose 

Source
pub struct ApplicationClose {
+ApplicationClose in iroh_quinn - Rust

ApplicationClose

Struct ApplicationClose 

Source
pub struct ApplicationClose {
     pub error_code: VarInt,
     pub reason: Bytes,
 }
Expand description

Reason given by an application for closing the connection

diff --git a/pr/380/docs/iroh_quinn/struct.BloomTokenLog.html b/pr/380/docs/iroh_quinn/struct.BloomTokenLog.html index 2e8e5c341..254d486ab 100644 --- a/pr/380/docs/iroh_quinn/struct.BloomTokenLog.html +++ b/pr/380/docs/iroh_quinn/struct.BloomTokenLog.html @@ -1,4 +1,4 @@ -BloomTokenLog in iroh_quinn - Rust

BloomTokenLog

Struct BloomTokenLog 

Source
pub struct BloomTokenLog(/* private fields */);
Expand description

Bloom filter-based TokenLog

+BloomTokenLog in iroh_quinn - Rust

BloomTokenLog

Struct BloomTokenLog 

Source
pub struct BloomTokenLog(/* private fields */);
Expand description

Bloom filter-based TokenLog

Parameterizable over an approximate maximum number of bytes to allocate. Starts out by storing used tokens in a hash set. Once the hash set becomes too large, converts it to a bloom filter. This achieves a memory profile of linear growth with an upper bound.

diff --git a/pr/380/docs/iroh_quinn/struct.Chunk.html b/pr/380/docs/iroh_quinn/struct.Chunk.html index e9611b70c..fe76d959e 100644 --- a/pr/380/docs/iroh_quinn/struct.Chunk.html +++ b/pr/380/docs/iroh_quinn/struct.Chunk.html @@ -1,4 +1,4 @@ -Chunk in iroh_quinn - Rust

Chunk

Struct Chunk 

Source
pub struct Chunk {
+Chunk in iroh_quinn - Rust

Chunk

Struct Chunk 

Source
pub struct Chunk {
     pub offset: u64,
     pub bytes: Bytes,
 }
Expand description

A chunk of data from the receive stream

diff --git a/pr/380/docs/iroh_quinn/struct.ClientConfig.html b/pr/380/docs/iroh_quinn/struct.ClientConfig.html index 6ed4a4260..eb0720862 100644 --- a/pr/380/docs/iroh_quinn/struct.ClientConfig.html +++ b/pr/380/docs/iroh_quinn/struct.ClientConfig.html @@ -1,4 +1,4 @@ -ClientConfig in iroh_quinn - Rust

ClientConfig

Struct ClientConfig 

Source
#[non_exhaustive]
pub struct ClientConfig { /* private fields */ }
Expand description

Configuration for outgoing connections

+ClientConfig in iroh_quinn - Rust

ClientConfig

Struct ClientConfig 

Source
#[non_exhaustive]
pub struct ClientConfig { /* private fields */ }
Expand description

Configuration for outgoing connections

Default values should be suitable for most internet applications.

Implementations§

Source§

impl ClientConfig

Source

pub fn new(crypto: Arc<dyn ClientConfig>) -> ClientConfig

Create a default config with a particular cryptographic config

Source

pub fn initial_dst_cid_provider( diff --git a/pr/380/docs/iroh_quinn/struct.ClosePath.html b/pr/380/docs/iroh_quinn/struct.ClosePath.html index 1053e5bd1..471d42d6b 100644 --- a/pr/380/docs/iroh_quinn/struct.ClosePath.html +++ b/pr/380/docs/iroh_quinn/struct.ClosePath.html @@ -1,4 +1,4 @@ -ClosePath in iroh_quinn - Rust

ClosePath

Struct ClosePath 

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

Future produced by Path::close

+ClosePath in iroh_quinn - Rust

ClosePath

Struct ClosePath 

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

Future produced by Path::close

Trait Implementations§

Source§

impl Future for ClosePath

Source§

type Output = Result<VarInt, ConnectionError>

The type of value produced on completion.
Source§

fn poll(self: Pin<&mut Self>, ctx: &mut Context<'_>) -> Poll<Self::Output>

Attempts to resolve the future to a final value, registering the current task for wakeup if the value is not yet available. Read more

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 diff --git a/pr/380/docs/iroh_quinn/struct.ClosedStream.html b/pr/380/docs/iroh_quinn/struct.ClosedStream.html index acf9ec613..eb725b4bb 100644 --- a/pr/380/docs/iroh_quinn/struct.ClosedStream.html +++ b/pr/380/docs/iroh_quinn/struct.ClosedStream.html @@ -1,4 +1,4 @@ -ClosedStream in iroh_quinn - Rust

ClosedStream

Struct ClosedStream 

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

Error indicating that a stream has not been opened or has already been finished or reset

+ClosedStream in iroh_quinn - Rust

ClosedStream

Struct ClosedStream 

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

Error indicating that a stream has not been opened or has already been finished or reset

Trait Implementations§

Source§

impl Clone for ClosedStream

Source§

fn clone(&self) -> ClosedStream

Returns a duplicate of the value. Read more
1.0.0 · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for ClosedStream

Source§

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

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

impl Default for ClosedStream

Source§

fn default() -> ClosedStream

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

impl Display for ClosedStream

Source§

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

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

impl Error for ClosedStream

1.30.0 · Source§

fn source(&self) -> Option<&(dyn Error + 'static)>

Returns the lower-level source of this error, if any. Read more
1.0.0 · Source§

fn description(&self) -> &str

👎Deprecated since 1.42.0: use the Display impl or to_string()
1.0.0 · Source§

fn cause(&self) -> Option<&dyn Error>

👎Deprecated since 1.33.0: replaced by Error::source, which can support downcasting
Source§

fn provide<'a>(&'a self, request: &mut Request<'a>)

🔬This is a nightly-only experimental API. (error_generic_member_access)
Provides type-based access to context intended for error reports. Read more
Source§

impl From<ClosedStream> for WriteError

Source§

fn from(_: ClosedStream) -> Self

Converts to this type from the input type.
Source§

impl PartialEq for ClosedStream

Source§

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

Tests for self and other values to be equal, and is used by ==.
1.0.0 · Source§

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.
Source§

impl Eq for ClosedStream

Source§

impl StructuralPartialEq for ClosedStream

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 diff --git a/pr/380/docs/iroh_quinn/struct.Connecting.html b/pr/380/docs/iroh_quinn/struct.Connecting.html index e57273930..be02cffcf 100644 --- a/pr/380/docs/iroh_quinn/struct.Connecting.html +++ b/pr/380/docs/iroh_quinn/struct.Connecting.html @@ -1,4 +1,4 @@ -Connecting in iroh_quinn - Rust

Connecting

Struct Connecting 

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

In-progress connection attempt future

+Connecting in iroh_quinn - Rust

Connecting

Struct Connecting 

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

In-progress connection attempt future

Implementations§

Source§

impl Connecting

Source

pub fn into_0rtt(self) -> Result<(Connection, ZeroRttAccepted), Self>

Convert into a 0-RTT or 0.5-RTT connection at the cost of weakened security

Returns Ok immediately if the local endpoint is able to attempt sending 0/0.5-RTT data. If so, the returned Connection can be used to send application data without waiting for diff --git a/pr/380/docs/iroh_quinn/struct.Connection.html b/pr/380/docs/iroh_quinn/struct.Connection.html index 7548dbb84..5c48cc006 100644 --- a/pr/380/docs/iroh_quinn/struct.Connection.html +++ b/pr/380/docs/iroh_quinn/struct.Connection.html @@ -1,4 +1,4 @@ -Connection in iroh_quinn - Rust

Connection

Struct Connection 

Source
pub struct Connection(/* private fields */);
Expand description

A QUIC connection.

+Connection in iroh_quinn - Rust

Connection

Struct Connection 

Source
pub struct Connection(/* private fields */);
Expand description

A QUIC connection.

If all references to a connection (including every clone of the Connection handle, streams of incoming streams, and the various stream types) have been dropped, then the connection will be automatically closed with an error_code of 0 and an empty reason. You can also close the @@ -8,7 +8,7 @@ receiving CONNECTION_CLOSE the peer may drop any stream data not yet de application. Connection::close() describes in more detail how to gracefully close a connection without losing application data.

May be cloned to obtain another handle to the same connection.

-

Implementations§

Source§

impl Connection

Source

pub fn weak_handle(&self) -> WeakConnectionHandle

Returns a weak reference to the inner connection struct.

+

Implementations§

Source§

impl Connection

Source

pub fn weak_handle(&self) -> WeakConnectionHandle

Returns a weak reference to the inner connection struct.

Source

pub fn open_uni(&self) -> OpenUni<'_> ⓘ

Initiate a new outgoing unidirectional stream.

Streams are cheap and instantaneous to open unless blocked by flow control. As a consequence, the peer won’t be notified that a stream has been opened until the stream is @@ -52,16 +52,16 @@ later, a Despite the return type’s name, closed connections are often not an error condition at the application layer. Cases that might be routine include ConnectionError::LocallyClosed and ConnectionError::ApplicationClosed.

-
Source

pub fn on_closed(&self) -> OnClosed ⓘ

Wait for the connection to be closed without keeping a strong reference to the connection

+
Source

pub fn on_closed(&self) -> OnClosed ⓘ

Wait for the connection to be closed without keeping a strong reference to the connection

Returns a future that resolves, once the connection is closed, to a tuple of (ConnectionError, ConnectionStats).

Calling Self::closed keeps the connection alive until it is either closed locally via Connection::close or closed by the remote peer. This function instead does not keep the connection itself alive, so if all other clones of the connection are dropped, the connection will be closed implicitly even if there are futures returned from this function still being awaited.

-
Source

pub fn close_reason(&self) -> Option<ConnectionError>

If the connection is closed, the reason why.

+
Source

pub fn close_reason(&self) -> Option<ConnectionError>

If the connection is closed, the reason why.

Returns None if the connection is still open.

-
Source

pub fn close(&self, error_code: VarInt, reason: &[u8])

Close the connection immediately.

+
Source

pub fn close(&self, error_code: VarInt, reason: &[u8])

Close the connection immediately.

Pending operations will fail immediately with ConnectionError::LocallyClosed. No more data is sent to the peer and the peer may drop buffered data upon receiving the CONNECTION_CLOSE frame.

@@ -82,7 +82,7 @@ endpoint. Once the local side sends a CONNECTION_CLOSE frame in response to call close() the remote endpoint may drop any data it received but is as yet undelivered to the application, including data that was acknowledged as received to the local endpoint.

-
Source

pub async fn handshake_confirmed(&self) -> Result<(), ConnectionError>

Wait for the handshake to be confirmed.

+
Source

pub async fn handshake_confirmed(&self) -> Result<(), ConnectionError>

Wait for the handshake to be confirmed.

As a server, who must be authenticated by clients, this happens when the handshake completes upon receiving a TLS Finished message from the client. @@ -90,56 +90,56 @@ In return, the server send a HANDSHAKE_DONE frame.

As a client, this happens when receiving a HANDSHAKE_DONE frame. At this point, the server has either accepted our authentication, or, if client authentication is not required, accepted our lack of authentication.

-
Source

pub fn send_datagram(&self, data: Bytes) -> Result<(), SendDatagramError>

Transmit data as an unreliable, unordered application datagram

+
Source

pub fn send_datagram(&self, data: Bytes) -> Result<(), SendDatagramError>

Transmit data as an unreliable, unordered application datagram

Application datagrams are a low-level primitive. They may be lost or delivered out of order, and data must both fit inside a single QUIC packet and be smaller than the maximum dictated by the peer.

Previously queued datagrams which are still unsent may be discarded to make space for this datagram, in order of oldest to newest.

-
Source

pub fn send_datagram_wait(&self, data: Bytes) -> SendDatagram<'_> ⓘ

Transmit data as an unreliable, unordered application datagram

+
Source

pub fn send_datagram_wait(&self, data: Bytes) -> SendDatagram<'_> ⓘ

Transmit data as an unreliable, unordered application datagram

Unlike send_datagram(), this method will wait for buffer space during congestion conditions, which effectively prioritizes old datagrams over new datagrams.

See send_datagram() for details.

-
Source

pub fn max_datagram_size(&self) -> Option<usize>

Compute the maximum size of datagrams that may be passed to send_datagram().

+
Source

pub fn max_datagram_size(&self) -> Option<usize>

Compute the maximum size of datagrams that may be passed to send_datagram().

Returns None if datagrams are unsupported by the peer or disabled locally.

This may change over the lifetime of a connection according to variation in the path MTU estimate. The peer can also enforce an arbitrarily small fixed limit, but if the peer’s limit is large this is guaranteed to be a little over a kilobyte at minimum.

Not necessarily the maximum size of received datagrams.

-
Source

pub fn datagram_send_buffer_space(&self) -> usize

Bytes available in the outgoing datagram buffer

+
Source

pub fn datagram_send_buffer_space(&self) -> usize

Bytes available in the outgoing datagram buffer

When greater than zero, calling send_datagram() with a datagram of at most this size is guaranteed not to cause older datagrams to be dropped.

-
Source

pub fn side(&self) -> Side

The side of the connection (client or server)

-
Source

pub fn remote_address(&self) -> SocketAddr

The peer’s UDP address

+
Source

pub fn side(&self) -> Side

The side of the connection (client or server)

+
Source

pub fn remote_address(&self) -> SocketAddr

The peer’s UDP address

If ServerConfig::migration is true, clients may change addresses at will, e.g. when switching to a cellular internet connection.

If multipath is enabled this will return the address of any path, and may not be consistent. Prefer Path::remote_address instead.

-
Source

pub fn local_ip(&self) -> Option<IpAddr>

The local IP address which was used when the peer established +

Source

pub fn local_ip(&self) -> Option<IpAddr>

The local IP address which was used when the peer established the connection

This can be different from the address the endpoint is bound to, in case the endpoint is bound to a wildcard address like 0.0.0.0 or ::.

This will return None for clients, or when the platform does not expose this information. See quinn_udp::RecvMeta::dst_ip for a list of supported platforms when using quinn_udp for I/O, which is the default.

-
Source

pub fn rtt(&self, path_id: PathId) -> Option<Duration>

Current best estimate of this connection’s latency (round-trip-time)

-
Source

pub fn stats(&self) -> ConnectionStats

Returns connection statistics

-
Source

pub fn path_stats(&self, path_id: PathId) -> Option<PathStats>

Returns path statistics

-
Source

pub fn congestion_state(&self, path_id: PathId) -> Option<Box<dyn Controller>>

Current state of the congestion control algorithm, for debugging purposes

-
Source

pub fn handshake_data(&self) -> Option<Box<dyn Any>>

Parameters negotiated during the handshake

+
Source

pub fn rtt(&self, path_id: PathId) -> Option<Duration>

Current best estimate of this connection’s latency (round-trip-time)

+
Source

pub fn stats(&self) -> ConnectionStats

Returns connection statistics

+
Source

pub fn path_stats(&self, path_id: PathId) -> Option<PathStats>

Returns path statistics

+
Source

pub fn congestion_state(&self, path_id: PathId) -> Option<Box<dyn Controller>>

Current state of the congestion control algorithm, for debugging purposes

+
Source

pub fn handshake_data(&self) -> Option<Box<dyn Any>>

Parameters negotiated during the handshake

Guaranteed to return Some on fully established connections or after Connecting::handshake_data() succeeds. See that method’s documentations for details on the returned value.

-
Source

pub fn peer_identity(&self) -> Option<Box<dyn Any>>

Cryptographic identity of the peer

+
Source

pub fn peer_identity(&self) -> Option<Box<dyn Any>>

Cryptographic identity of the peer

The dynamic type returned is determined by the configured Session. For the default rustls session, the return value can be downcast to a Vec<[rustls::pki_types::CertificateDer]>

-
Source

pub fn stable_id(&self) -> usize

A stable identifier for this connection

+
Source

pub fn stable_id(&self) -> usize

A stable identifier for this connection

Peer addresses and connection IDs can change, but this value will remain fixed for the lifetime of the connection.

-
Source

pub fn force_key_update(&self)

Update traffic keys spontaneously

+
Source

pub fn force_key_update(&self)

Update traffic keys spontaneously

This primarily exists for testing purposes.

-
Source

pub fn export_keying_material( +

Source

pub fn export_keying_material( &self, output: &mut [u8], label: &[u8], @@ -150,17 +150,17 @@ arguments and output buffers of equal length, they will get the same sequence of bytes in output. These bytes are cryptographically strong and pseudorandom, and are suitable for use as keying material.

See RFC5705 for more information.

-

Source

pub fn set_max_concurrent_uni_streams(&self, count: VarInt)

Modify the number of remotely initiated unidirectional streams that may be concurrently open

+
Source

pub fn set_max_concurrent_uni_streams(&self, count: VarInt)

Modify the number of remotely initiated unidirectional streams that may be concurrently open

No streams may be opened by the peer unless fewer than count are already open. Large counts increase both minimum and worst-case memory consumption.

-
Source

pub fn set_send_window(&self, send_window: u64)

Source

pub fn set_receive_window(&self, receive_window: VarInt)

Source

pub fn set_max_concurrent_bi_streams(&self, count: VarInt)

Modify the number of remotely initiated bidirectional streams that may be concurrently open

+
Source

pub fn set_send_window(&self, send_window: u64)

Source

pub fn set_receive_window(&self, receive_window: VarInt)

Source

pub fn set_max_concurrent_bi_streams(&self, count: VarInt)

Modify the number of remotely initiated bidirectional streams that may be concurrently open

No streams may be opened by the peer unless fewer than count are already open. Large counts increase both minimum and worst-case memory consumption.

-
Source

pub fn observed_external_addr(&self) -> Receiver<Option<SocketAddr>>

Track changed on our external address as reported by the peer.

-
Source

pub fn is_multipath_enabled(&self) -> bool

Is multipath enabled?

-
Source

pub fn add_nat_traversal_address( +

Source

pub fn observed_external_addr(&self) -> Receiver<Option<SocketAddr>>

Track changed on our external address as reported by the peer.

+
Source

pub fn is_multipath_enabled(&self) -> bool

Is multipath enabled?

+
Source

pub fn add_nat_traversal_address( &self, address: SocketAddr, ) -> Result<(), Error>

Registers one address at which this endpoint might be reachable

@@ -168,7 +168,7 @@ strong and pseudorandom, and are suitable for use as keying material.

ADD_ADDRESS frames. This allows clients to obtain server address candidates to initiate NAT traversal attempts. Clients provide their own reachable addresses in REACH_OUT frames when Self::initiate_nat_traversal_round is called.

-
Source

pub fn remove_nat_traversal_address( +

Source

pub fn remove_nat_traversal_address( &self, address: SocketAddr, ) -> Result<(), Error>

Removes one or more addresses from the set of addresses at which this endpoint is reachable

@@ -177,13 +177,13 @@ clients in REMOVE_ADDRESS frames. This allows clients to stop using server address candidates that are no longer valid for NAT traversal.

For clients, removed addresses will no longer be advertised in REACH_OUT frames.

Addresses not present in the set will be silently ignored.

-
Source

pub fn get_local_nat_traversal_addresses( +

Source

pub fn get_local_nat_traversal_addresses( &self, ) -> Result<Vec<SocketAddr>, Error>

Get the current local nat traversal addresses

-
Source

pub fn get_remote_nat_traversal_addresses( +

Source

pub fn get_remote_nat_traversal_addresses( &self, ) -> Result<Vec<SocketAddr>, Error>

Get the currently advertised nat traversal addresses by the server

-
Source

pub fn initiate_nat_traversal_round(&self) -> Result<Vec<SocketAddr>, Error>

Initiates a new nat traversal round

+
Source

pub fn initiate_nat_traversal_round(&self) -> Result<Vec<SocketAddr>, Error>

Initiates a new nat traversal round

A nat traversal round involves advertising the client’s local addresses in REACH_OUT frames, and initiating probing of the known remote addresses. When a new round is initiated, the previous one is cancelled, and paths that have not been opened are closed.

diff --git a/pr/380/docs/iroh_quinn/struct.ConnectionClose.html b/pr/380/docs/iroh_quinn/struct.ConnectionClose.html index 6b8fe19dc..b635063b0 100644 --- a/pr/380/docs/iroh_quinn/struct.ConnectionClose.html +++ b/pr/380/docs/iroh_quinn/struct.ConnectionClose.html @@ -1,4 +1,4 @@ -ConnectionClose in iroh_quinn - Rust

ConnectionClose

Struct ConnectionClose 

Source
pub struct ConnectionClose {
+ConnectionClose in iroh_quinn - Rust

ConnectionClose

Struct ConnectionClose 

Source
pub struct ConnectionClose {
     pub error_code: Code,
     pub frame_type: MaybeFrame,
     pub reason: Bytes,
diff --git a/pr/380/docs/iroh_quinn/struct.ConnectionId.html b/pr/380/docs/iroh_quinn/struct.ConnectionId.html
index 3c62a1b15..1c1c574cf 100644
--- a/pr/380/docs/iroh_quinn/struct.ConnectionId.html
+++ b/pr/380/docs/iroh_quinn/struct.ConnectionId.html
@@ -1,4 +1,4 @@
-ConnectionId in iroh_quinn - Rust

ConnectionId

Struct ConnectionId 

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

Protocol-level identifier for a connection.

+ConnectionId in iroh_quinn - Rust

ConnectionId

Struct ConnectionId 

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

Protocol-level identifier for a connection.

Mainly useful for identifying this connection’s packets on the wire with tools like Wireshark.

Implementations§

Source§

impl ConnectionId

Source

pub fn new(bytes: &[u8]) -> ConnectionId

Construct cid from byte array

Source

pub fn from_buf(buf: &mut (impl Buf + ?Sized), len: usize) -> ConnectionId

Constructs cid by reading len bytes from a Buf

diff --git a/pr/380/docs/iroh_quinn/struct.ConnectionStats.html b/pr/380/docs/iroh_quinn/struct.ConnectionStats.html index fcf928807..5d8c9f040 100644 --- a/pr/380/docs/iroh_quinn/struct.ConnectionStats.html +++ b/pr/380/docs/iroh_quinn/struct.ConnectionStats.html @@ -1,4 +1,4 @@ -ConnectionStats in iroh_quinn - Rust

ConnectionStats

Struct ConnectionStats 

Source
#[non_exhaustive]
pub struct ConnectionStats { +ConnectionStats in iroh_quinn - Rust

ConnectionStats

Struct ConnectionStats 

Source
#[non_exhaustive]
pub struct ConnectionStats { pub udp_tx: UdpStats, pub udp_rx: UdpStats, pub frame_tx: FrameStats, diff --git a/pr/380/docs/iroh_quinn/struct.Endpoint.html b/pr/380/docs/iroh_quinn/struct.Endpoint.html index 98ab0a693..403216a87 100644 --- a/pr/380/docs/iroh_quinn/struct.Endpoint.html +++ b/pr/380/docs/iroh_quinn/struct.Endpoint.html @@ -1,4 +1,4 @@ -Endpoint in iroh_quinn - Rust

Endpoint

Struct Endpoint 

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

A QUIC endpoint.

+Endpoint in iroh_quinn - Rust

Endpoint

Struct Endpoint 

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

A QUIC endpoint.

An endpoint corresponds to a single UDP socket, may host many connections, and may act as both client and server for different connections.

May be cloned to obtain another handle to the same endpoint.

diff --git a/pr/380/docs/iroh_quinn/struct.EndpointConfig.html b/pr/380/docs/iroh_quinn/struct.EndpointConfig.html index f189b9128..a79e13637 100644 --- a/pr/380/docs/iroh_quinn/struct.EndpointConfig.html +++ b/pr/380/docs/iroh_quinn/struct.EndpointConfig.html @@ -1,4 +1,4 @@ -EndpointConfig in iroh_quinn - Rust

EndpointConfig

Struct EndpointConfig 

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

Global configuration for the endpoint, affecting all connections

+EndpointConfig in iroh_quinn - Rust

EndpointConfig

Struct EndpointConfig 

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

Global configuration for the endpoint, affecting all connections

Default values should be suitable for most internet applications.

Implementations§

Source§

impl EndpointConfig

Source

pub fn new(reset_key: Arc<dyn HmacKey>) -> EndpointConfig

Create a default config with a particular reset_key

Source

pub fn cid_generator<F>(&mut self, factory: F) -> &mut EndpointConfig
where diff --git a/pr/380/docs/iroh_quinn/struct.EndpointStats.html b/pr/380/docs/iroh_quinn/struct.EndpointStats.html index 90f0406ff..19310ee19 100644 --- a/pr/380/docs/iroh_quinn/struct.EndpointStats.html +++ b/pr/380/docs/iroh_quinn/struct.EndpointStats.html @@ -1,4 +1,4 @@ -EndpointStats in iroh_quinn - Rust

EndpointStats

Struct EndpointStats 

Source
#[non_exhaustive]
pub struct EndpointStats { +EndpointStats in iroh_quinn - Rust

EndpointStats

Struct EndpointStats 

Source
#[non_exhaustive]
pub struct EndpointStats { pub accepted_handshakes: u64, pub outgoing_handshakes: u64, pub refused_handshakes: u64, diff --git a/pr/380/docs/iroh_quinn/struct.FrameStats.html b/pr/380/docs/iroh_quinn/struct.FrameStats.html index cdf7c94e2..a2980fad6 100644 --- a/pr/380/docs/iroh_quinn/struct.FrameStats.html +++ b/pr/380/docs/iroh_quinn/struct.FrameStats.html @@ -1,4 +1,4 @@ -FrameStats in iroh_quinn - Rust

FrameStats

Struct FrameStats 

Source
#[non_exhaustive]
pub struct FrameStats {
Show 37 fields +FrameStats in iroh_quinn - Rust

FrameStats

Struct FrameStats 

Source
#[non_exhaustive]
pub struct FrameStats {
Show 37 fields pub acks: u64, pub path_acks: u64, pub ack_frequency: u64, diff --git a/pr/380/docs/iroh_quinn/struct.IdleTimeout.html b/pr/380/docs/iroh_quinn/struct.IdleTimeout.html index 597f55233..3036a6878 100644 --- a/pr/380/docs/iroh_quinn/struct.IdleTimeout.html +++ b/pr/380/docs/iroh_quinn/struct.IdleTimeout.html @@ -1,4 +1,4 @@ -IdleTimeout in iroh_quinn - Rust

IdleTimeout

Struct IdleTimeout 

Source
pub struct IdleTimeout(/* private fields */);
Expand description

Maximum duration of inactivity to accept before timing out the connection

+IdleTimeout in iroh_quinn - Rust

IdleTimeout

Struct IdleTimeout 

Source
pub struct IdleTimeout(/* private fields */);
Expand description

Maximum duration of inactivity to accept before timing out the connection

This wraps an underlying VarInt, representing the duration in milliseconds. Values can be constructed by converting directly from VarInt, or using TryFrom<Duration>.

diff --git a/pr/380/docs/iroh_quinn/struct.Incoming.html b/pr/380/docs/iroh_quinn/struct.Incoming.html index 3b63276db..2d7afbe0b 100644 --- a/pr/380/docs/iroh_quinn/struct.Incoming.html +++ b/pr/380/docs/iroh_quinn/struct.Incoming.html @@ -1,4 +1,4 @@ -Incoming in iroh_quinn - Rust

Incoming

Struct Incoming 

Source
pub struct Incoming(/* private fields */);
Expand description

An incoming connection for which the server has not yet begun its part of the handshake

+Incoming in iroh_quinn - Rust

Incoming

Struct Incoming 

Source
pub struct Incoming(/* private fields */);
Expand description

An incoming connection for which the server has not yet begun its part of the handshake

Implementations§

Source§

impl Incoming

Source

pub fn accept(self) -> Result<Connecting, ConnectionError>

Attempt to accept this incoming connection (an error may still occur)

Source

pub fn accept_with( self, diff --git a/pr/380/docs/iroh_quinn/struct.IncomingFuture.html b/pr/380/docs/iroh_quinn/struct.IncomingFuture.html index 6285bcc14..e607068ec 100644 --- a/pr/380/docs/iroh_quinn/struct.IncomingFuture.html +++ b/pr/380/docs/iroh_quinn/struct.IncomingFuture.html @@ -1,4 +1,4 @@ -IncomingFuture in iroh_quinn - Rust

IncomingFuture

Struct IncomingFuture 

Source
pub struct IncomingFuture(/* private fields */);
Expand description

Basic adapter to let Incoming be await-ed like a Connecting

+IncomingFuture in iroh_quinn - Rust

IncomingFuture

Struct IncomingFuture 

Source
pub struct IncomingFuture(/* private fields */);
Expand description

Basic adapter to let Incoming be await-ed like a Connecting

Trait Implementations§

Source§

impl Debug for IncomingFuture

Source§

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

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

impl Future for IncomingFuture

Source§

type Output = Result<Connection, ConnectionError>

The type of value produced on completion.
Source§

fn poll(self: Pin<&mut Self>, cx: &mut Context<'_>) -> Poll<Self::Output>

Attempts to resolve the future to a final value, registering the current task for wakeup if the value is not yet available. Read more

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 diff --git a/pr/380/docs/iroh_quinn/struct.InvalidCid.html b/pr/380/docs/iroh_quinn/struct.InvalidCid.html index 28727e258..214b681a3 100644 --- a/pr/380/docs/iroh_quinn/struct.InvalidCid.html +++ b/pr/380/docs/iroh_quinn/struct.InvalidCid.html @@ -1,4 +1,4 @@ -InvalidCid in iroh_quinn - Rust

InvalidCid

Struct InvalidCid 

Source
pub struct InvalidCid;
Expand description

The connection ID was not recognized by the ConnectionIdGenerator

+InvalidCid in iroh_quinn - Rust

InvalidCid

Struct InvalidCid 

Source
pub struct InvalidCid;
Expand description

The connection ID was not recognized by the ConnectionIdGenerator

Trait Implementations§

Source§

impl Clone for InvalidCid

Source§

fn clone(&self) -> InvalidCid

Returns a duplicate of the value. Read more
1.0.0 · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for InvalidCid

Source§

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

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

impl Copy for InvalidCid

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 diff --git a/pr/380/docs/iroh_quinn/struct.MtuDiscoveryConfig.html b/pr/380/docs/iroh_quinn/struct.MtuDiscoveryConfig.html index 44b82e066..0ff38acf8 100644 --- a/pr/380/docs/iroh_quinn/struct.MtuDiscoveryConfig.html +++ b/pr/380/docs/iroh_quinn/struct.MtuDiscoveryConfig.html @@ -1,4 +1,4 @@ -MtuDiscoveryConfig in iroh_quinn - Rust

MtuDiscoveryConfig

Struct MtuDiscoveryConfig 

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

Parameters governing MTU discovery.

+MtuDiscoveryConfig in iroh_quinn - Rust

MtuDiscoveryConfig

Struct MtuDiscoveryConfig 

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

Parameters governing MTU discovery.

§The why of MTU discovery

By design, QUIC ensures during the handshake that the network path between the client and the server is able to transmit unfragmented UDP packets with a body of 1200 bytes. In other words, diff --git a/pr/380/docs/iroh_quinn/struct.NoneTokenLog.html b/pr/380/docs/iroh_quinn/struct.NoneTokenLog.html index cff373346..aa526d6a8 100644 --- a/pr/380/docs/iroh_quinn/struct.NoneTokenLog.html +++ b/pr/380/docs/iroh_quinn/struct.NoneTokenLog.html @@ -1,4 +1,4 @@ -NoneTokenLog in iroh_quinn - Rust

NoneTokenLog

Struct NoneTokenLog 

Source
pub struct NoneTokenLog;
Expand description

Null implementation of TokenLog, which never accepts tokens

+NoneTokenLog in iroh_quinn - Rust

NoneTokenLog

Struct NoneTokenLog 

Source
pub struct NoneTokenLog;
Expand description

Null implementation of TokenLog, which never accepts tokens

Trait Implementations§

Source§

impl TokenLog for NoneTokenLog

Source§

fn check_and_insert( &self, _: u128, diff --git a/pr/380/docs/iroh_quinn/struct.NoneTokenStore.html b/pr/380/docs/iroh_quinn/struct.NoneTokenStore.html index 88d1ddf66..450968c06 100644 --- a/pr/380/docs/iroh_quinn/struct.NoneTokenStore.html +++ b/pr/380/docs/iroh_quinn/struct.NoneTokenStore.html @@ -1,4 +1,4 @@ -NoneTokenStore in iroh_quinn - Rust

NoneTokenStore

Struct NoneTokenStore 

Source
pub struct NoneTokenStore;
Expand description

Null implementation of TokenStore, which does not store any tokens

+NoneTokenStore in iroh_quinn - Rust

NoneTokenStore

Struct NoneTokenStore 

Source
pub struct NoneTokenStore;
Expand description

Null implementation of TokenStore, which does not store any tokens

Trait Implementations§

Source§

impl TokenStore for NoneTokenStore

Source§

fn insert(&self, _: &str, _: Bytes)

Potentially store a token for later one-time use Read more
Source§

fn take(&self, _: &str) -> Option<Bytes>

Try to find and take a token that was stored with the given server name Read more

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 diff --git a/pr/380/docs/iroh_quinn/struct.OnClosed.html b/pr/380/docs/iroh_quinn/struct.OnClosed.html index 392a513c9..7ac10f873 100644 --- a/pr/380/docs/iroh_quinn/struct.OnClosed.html +++ b/pr/380/docs/iroh_quinn/struct.OnClosed.html @@ -1,6 +1,6 @@ -OnClosed in iroh_quinn - Rust

OnClosed

Struct OnClosed 

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

Future returned by Connection::on_closed

+OnClosed in iroh_quinn - Rust

OnClosed

Struct OnClosed 

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

Future returned by Connection::on_closed

Resolves to a tuple of (ConnectionError, ConnectionStats).

-

Trait Implementations§

Source§

impl Drop for OnClosed

Source§

fn drop(&mut self)

Executes the destructor for this type. Read more
Source§

impl Future for OnClosed

Source§

type Output = (ConnectionError, ConnectionStats)

The type of value produced on completion.
Source§

fn poll(self: Pin<&mut Self>, cx: &mut Context<'_>) -> Poll<Self::Output>

Attempts to resolve the future to a final value, registering +

Trait Implementations§

Source§

impl Drop for OnClosed

Source§

fn drop(&mut self)

Executes the destructor for this type. Read more
Source§

impl Future for OnClosed

Source§

type Output = (ConnectionError, ConnectionStats)

The type of value produced on completion.
Source§

fn poll(self: Pin<&mut Self>, cx: &mut Context<'_>) -> Poll<Self::Output>

Attempts to resolve the future to a final value, registering the current task for wakeup if the value is not yet available. Read more

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 diff --git a/pr/380/docs/iroh_quinn/struct.OpenBi.html b/pr/380/docs/iroh_quinn/struct.OpenBi.html index 46b2971a6..02274d2c3 100644 --- a/pr/380/docs/iroh_quinn/struct.OpenBi.html +++ b/pr/380/docs/iroh_quinn/struct.OpenBi.html @@ -1,6 +1,6 @@ -OpenBi in iroh_quinn - Rust

OpenBi

Struct OpenBi 

Source
pub struct OpenBi<'a> { /* private fields */ }
Expand description

Future produced by Connection::open_bi

-

Trait Implementations§

Source§

impl Future for OpenBi<'_>

Source§

type Output = Result<(SendStream, RecvStream), ConnectionError>

The type of value produced on completion.
Source§

fn poll(self: Pin<&mut Self>, ctx: &mut Context<'_>) -> Poll<Self::Output>

Attempts to resolve the future to a final value, registering -the current task for wakeup if the value is not yet available. Read more
Source§

impl<'__pin, 'a> Unpin for OpenBi<'a>
where +OpenBi in iroh_quinn - Rust

OpenBi

Struct OpenBi 

Source
pub struct OpenBi<'a> { /* private fields */ }
Expand description

Future produced by Connection::open_bi

+

Trait Implementations§

Source§

impl Future for OpenBi<'_>

Source§

type Output = Result<(SendStream, RecvStream), ConnectionError>

The type of value produced on completion.
Source§

fn poll(self: Pin<&mut Self>, ctx: &mut Context<'_>) -> Poll<Self::Output>

Attempts to resolve the future to a final value, registering +the current task for wakeup if the value is not yet available. Read more
Source§

impl<'__pin, 'a> Unpin for OpenBi<'a>
where PinnedFieldsOf<__Origin<'__pin, 'a>>: Unpin,

Auto Trait Implementations§

§

impl<'a> !Freeze for OpenBi<'a>

§

impl<'a> !RefUnwindSafe for OpenBi<'a>

§

impl<'a> Send for OpenBi<'a>

§

impl<'a> Sync for OpenBi<'a>

§

impl<'a> !UnwindSafe for OpenBi<'a>

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 diff --git a/pr/380/docs/iroh_quinn/struct.OpenPath.html b/pr/380/docs/iroh_quinn/struct.OpenPath.html index 8ea8ae4fb..a60407291 100644 --- a/pr/380/docs/iroh_quinn/struct.OpenPath.html +++ b/pr/380/docs/iroh_quinn/struct.OpenPath.html @@ -1,4 +1,4 @@ -OpenPath in iroh_quinn - Rust

OpenPath

Struct OpenPath 

Source
pub struct OpenPath(/* private fields */);
Expand description

Future produced by crate::Connection::open_path

+OpenPath in iroh_quinn - Rust

OpenPath

Struct OpenPath 

Source
pub struct OpenPath(/* private fields */);
Expand description

Future produced by crate::Connection::open_path

Implementations§

Source§

impl OpenPath

Source

pub fn path_id(&self) -> Option<PathId>

Returns the path ID of the new path being opened.

If an error occurred before a path ID was allocated, None is returned. In this case the future is ready and polling it will immediately yield the error.

diff --git a/pr/380/docs/iroh_quinn/struct.OpenUni.html b/pr/380/docs/iroh_quinn/struct.OpenUni.html index 4c15d94d9..a13245ede 100644 --- a/pr/380/docs/iroh_quinn/struct.OpenUni.html +++ b/pr/380/docs/iroh_quinn/struct.OpenUni.html @@ -1,6 +1,6 @@ -OpenUni in iroh_quinn - Rust

OpenUni

Struct OpenUni 

Source
pub struct OpenUni<'a> { /* private fields */ }
Expand description

Future produced by Connection::open_uni

-

Trait Implementations§

Source§

impl Future for OpenUni<'_>

Source§

type Output = Result<SendStream, ConnectionError>

The type of value produced on completion.
Source§

fn poll(self: Pin<&mut Self>, ctx: &mut Context<'_>) -> Poll<Self::Output>

Attempts to resolve the future to a final value, registering -the current task for wakeup if the value is not yet available. Read more
Source§

impl<'__pin, 'a> Unpin for OpenUni<'a>
where +OpenUni in iroh_quinn - Rust

OpenUni

Struct OpenUni 

Source
pub struct OpenUni<'a> { /* private fields */ }
Expand description

Future produced by Connection::open_uni

+

Trait Implementations§

Source§

impl Future for OpenUni<'_>

Source§

type Output = Result<SendStream, ConnectionError>

The type of value produced on completion.
Source§

fn poll(self: Pin<&mut Self>, ctx: &mut Context<'_>) -> Poll<Self::Output>

Attempts to resolve the future to a final value, registering +the current task for wakeup if the value is not yet available. Read more
Source§

impl<'__pin, 'a> Unpin for OpenUni<'a>
where PinnedFieldsOf<__Origin<'__pin, 'a>>: Unpin,

Auto Trait Implementations§

§

impl<'a> !Freeze for OpenUni<'a>

§

impl<'a> !RefUnwindSafe for OpenUni<'a>

§

impl<'a> Send for OpenUni<'a>

§

impl<'a> Sync for OpenUni<'a>

§

impl<'a> !UnwindSafe for OpenUni<'a>

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 diff --git a/pr/380/docs/iroh_quinn/struct.Path.html b/pr/380/docs/iroh_quinn/struct.Path.html index a9fdba39e..24b4f477d 100644 --- a/pr/380/docs/iroh_quinn/struct.Path.html +++ b/pr/380/docs/iroh_quinn/struct.Path.html @@ -1,4 +1,4 @@ -Path in iroh_quinn - Rust

Path

Struct Path 

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

An open (Multi)Path

+Path in iroh_quinn - Rust

Path

Struct Path 

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

An open (Multi)Path

Implementations§

Source§

impl Path

Source

pub fn id(&self) -> PathId

The PathId of this path.

Source

pub fn status(&self) -> Result<PathStatus, ClosedPath>

The current local PathStatus of this path.

Source

pub fn set_status(&self, status: PathStatus) -> Result<(), SetPathStatusError>

Sets the PathStatus of this path.

diff --git a/pr/380/docs/iroh_quinn/struct.PathId.html b/pr/380/docs/iroh_quinn/struct.PathId.html index 35ebeca22..2759c307d 100644 --- a/pr/380/docs/iroh_quinn/struct.PathId.html +++ b/pr/380/docs/iroh_quinn/struct.PathId.html @@ -1,4 +1,4 @@ -PathId in iroh_quinn - Rust

PathId

Struct PathId 

Source
pub struct PathId(/* private fields */);
Expand description

Id representing different paths when using multipath extension

+PathId in iroh_quinn - Rust

PathId

Struct PathId 

Source
pub struct PathId(/* private fields */);
Expand description

Id representing different paths when using multipath extension

Implementations§

Source§

impl PathId

Source

pub const MAX: PathId

The maximum path ID allowed.

Source

pub const ZERO: PathId

The 0 path id.

Source

pub fn saturating_add(self, rhs: impl Into<PathId>) -> PathId

Saturating integer addition. Computes self + rhs, saturating at the numeric bounds instead diff --git a/pr/380/docs/iroh_quinn/struct.PathStats.html b/pr/380/docs/iroh_quinn/struct.PathStats.html index 3575d6bb5..4b2bc0b01 100644 --- a/pr/380/docs/iroh_quinn/struct.PathStats.html +++ b/pr/380/docs/iroh_quinn/struct.PathStats.html @@ -1,4 +1,4 @@ -PathStats in iroh_quinn - Rust

PathStats

Struct PathStats 

Source
#[non_exhaustive]
pub struct PathStats { +PathStats in iroh_quinn - Rust

PathStats

Struct PathStats 

Source
#[non_exhaustive]
pub struct PathStats { pub rtt: Duration, pub udp_tx: UdpStats, pub udp_rx: UdpStats, diff --git a/pr/380/docs/iroh_quinn/struct.QlogConfig.html b/pr/380/docs/iroh_quinn/struct.QlogConfig.html index 70f047a9c..bef1e4dcf 100644 --- a/pr/380/docs/iroh_quinn/struct.QlogConfig.html +++ b/pr/380/docs/iroh_quinn/struct.QlogConfig.html @@ -1,4 +1,4 @@ -QlogConfig in iroh_quinn - Rust

QlogConfig

Struct QlogConfig 

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

Configuration for qlog trace logging.

+QlogConfig in iroh_quinn - Rust

QlogConfig

Struct QlogConfig 

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

Configuration for qlog trace logging.

This struct is returned from QlogFactory::for_connection if qlog logging should be enabled for a connection. It allows to set metadata for the qlog trace.

The trace will be written to the provided writer in the [JSON-SEQ format] defined in the qlog spec.

diff --git a/pr/380/docs/iroh_quinn/struct.QlogFileFactory.html b/pr/380/docs/iroh_quinn/struct.QlogFileFactory.html index 3974e6b24..ec814cda1 100644 --- a/pr/380/docs/iroh_quinn/struct.QlogFileFactory.html +++ b/pr/380/docs/iroh_quinn/struct.QlogFileFactory.html @@ -1,4 +1,4 @@ -QlogFileFactory in iroh_quinn - Rust

QlogFileFactory

Struct QlogFileFactory 

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

Enables writing qlog traces to a directory.

+QlogFileFactory in iroh_quinn - Rust

QlogFileFactory

Struct QlogFileFactory 

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

Enables writing qlog traces to a directory.

Implementations§

Source§

impl QlogFileFactory

Source

pub fn new(dir: PathBuf) -> QlogFileFactory

Creates a new qlog factory that writes files into the specified directory.

Source

pub fn from_env() -> QlogFileFactory

Creates a new qlog factory that writes files into QLOGDIR, if set.

If the environment variable QLOGDIR is set, qlog traces for all connections handled diff --git a/pr/380/docs/iroh_quinn/struct.ReadDatagram.html b/pr/380/docs/iroh_quinn/struct.ReadDatagram.html index 0eaeef0a6..fc318ee0c 100644 --- a/pr/380/docs/iroh_quinn/struct.ReadDatagram.html +++ b/pr/380/docs/iroh_quinn/struct.ReadDatagram.html @@ -1,6 +1,6 @@ -ReadDatagram in iroh_quinn - Rust

ReadDatagram

Struct ReadDatagram 

Source
pub struct ReadDatagram<'a> { /* private fields */ }
Expand description

Future produced by Connection::read_datagram

-

Trait Implementations§

Source§

impl Future for ReadDatagram<'_>

Source§

type Output = Result<Bytes, ConnectionError>

The type of value produced on completion.
Source§

fn poll(self: Pin<&mut Self>, ctx: &mut Context<'_>) -> Poll<Self::Output>

Attempts to resolve the future to a final value, registering -the current task for wakeup if the value is not yet available. Read more
Source§

impl<'__pin, 'a> Unpin for ReadDatagram<'a>
where +ReadDatagram in iroh_quinn - Rust

ReadDatagram

Struct ReadDatagram 

Source
pub struct ReadDatagram<'a> { /* private fields */ }
Expand description

Future produced by Connection::read_datagram

+

Trait Implementations§

Source§

impl Future for ReadDatagram<'_>

Source§

type Output = Result<Bytes, ConnectionError>

The type of value produced on completion.
Source§

fn poll(self: Pin<&mut Self>, ctx: &mut Context<'_>) -> Poll<Self::Output>

Attempts to resolve the future to a final value, registering +the current task for wakeup if the value is not yet available. Read more
Source§

impl<'__pin, 'a> Unpin for ReadDatagram<'a>
where PinnedFieldsOf<__Origin<'__pin, 'a>>: Unpin,

Auto Trait Implementations§

§

impl<'a> !Freeze for ReadDatagram<'a>

§

impl<'a> !RefUnwindSafe for ReadDatagram<'a>

§

impl<'a> Send for ReadDatagram<'a>

§

impl<'a> Sync for ReadDatagram<'a>

§

impl<'a> !UnwindSafe for ReadDatagram<'a>

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 diff --git a/pr/380/docs/iroh_quinn/struct.RecvStream.html b/pr/380/docs/iroh_quinn/struct.RecvStream.html index 4f047eb4b..11810c6e9 100644 --- a/pr/380/docs/iroh_quinn/struct.RecvStream.html +++ b/pr/380/docs/iroh_quinn/struct.RecvStream.html @@ -1,4 +1,4 @@ -RecvStream in iroh_quinn - Rust

RecvStream

Struct RecvStream 

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

A stream that can only be used to receive data

+RecvStream in iroh_quinn - Rust

RecvStream

Struct RecvStream 

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

A stream that can only be used to receive data

stop(0) is implicitly called on drop unless: