pub(crate) struct ClientStats {
pub(crate) upload_stats: Stats,
pub(crate) download_stats: Stats,
-}Fields§
§upload_stats: Stats§download_stats: StatsImplementations§
Trait Implementations§
Source§impl Default for ClientStats
impl Default for ClientStats
Source§fn default() -> ClientStats
fn default() -> ClientStats
Auto Trait Implementations§
impl Freeze for ClientStats
impl RefUnwindSafe for ClientStats
impl Send for ClientStats
impl Sync for ClientStats
impl Unpin for ClientStats
impl UnwindSafe for ClientStats
Blanket Implementations§
Source§impl<T> Any for Twhere
+}Fields§
§upload_stats: Stats§download_stats: StatsImplementations§
Trait Implementations§
Source§impl Default for ClientStats
Source§fn default() -> ClientStats
Returns the “default value” for a type. Read moreAuto Trait Implementations§
§impl Freeze for ClientStats
§impl RefUnwindSafe for ClientStats
§impl Send for ClientStats
§impl Sync for ClientStats
§impl Unpin for ClientStats
§impl UnwindSafe for ClientStats
Blanket Implementations§
Source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
Source§fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read moreSource§impl<T> From<T> for T
Source§fn from(t: T) -> T
Returns the argument unchanged.
diff --git a/pr/255/docs/iroh_quinn/all.html b/pr/255/docs/iroh_quinn/all.html
index 9efe65aca..4ca955f58 100644
--- a/pr/255/docs/iroh_quinn/all.html
+++ b/pr/255/docs/iroh_quinn/all.html
@@ -1 +1 @@
-List of all items in this crate All
List of all items
Structs
- Accept
- AcceptBi
- AcceptUni
- AckFrequencyConfig
- ApplicationClose
- BloomTokenLog
- Chunk
- ClientConfig
- ClosedStream
- Connecting
- Connection
- ConnectionClose
- ConnectionId
- ConnectionStats
- Endpoint
- EndpointConfig
- EndpointStats
- FrameStats
- IdleTimeout
- Incoming
- IncomingFuture
- MtuDiscoveryConfig
- NoneTokenLog
- NoneTokenStore
- OnClosed
- OpenBi
- OpenPath
- OpenUni
- Path
- PathId
- PathStats
- QlogConfig
- QlogFileFactory
- ReadDatagram
- RecvStream
- RetryError
- SendDatagram
- SendStream
- ServerConfig
- SmolRuntime
- StdSystemTime
- StreamId
- TokenMemoryCache
- TokenReuseError
- TokioRuntime
- Transmit
- TransportConfig
- TransportErrorCode
- UdpStats
- UnorderedRecvStream
- ValidationTokenConfig
- VarInt
- VarIntBoundsExceeded
- WeakConnectionHandle
- Written
- ZeroRttAccepted
- congestion::Bbr
- congestion::BbrConfig
- congestion::ControllerMetrics
- congestion::Cubic
- congestion::CubicConfig
- congestion::NewReno
- congestion::NewRenoConfig
- crypto::CryptoError
- crypto::ExportKeyingMaterialError
- crypto::KeyPair
- crypto::Keys
- crypto::UnsupportedVersion
- crypto::rustls::HandshakeData
- crypto::rustls::NoInitialCipherSuite
- crypto::rustls::QuicClientConfig
- crypto::rustls::QuicServerConfig
- crypto::rustls::TlsSession
Enums
- ConfigError
- ConnectError
- ConnectionError
- Dir
- EcnCodepoint
- FrameType
- ReadError
- ReadExactError
- ReadToEndError
- ResetError
- SendDatagramError
- Side
- StoppedError
- WriteError
- crypto::rustls::Error
Traits
- AsyncTimer
- AsyncUdpSocket
- ConnectionIdGenerator
- QlogFactory
- Runtime
- TimeSource
- TokenLog
- TokenStore
- UdpSender
- congestion::Controller
- congestion::ControllerFactory
- crypto::AeadKey
- crypto::ClientConfig
- crypto::HandshakeTokenKey
- crypto::HeaderKey
- crypto::HmacKey
- crypto::PacketKey
- crypto::ServerConfig
- crypto::Session
Functions
\ No newline at end of file
+List of all items in this crate All
List of all items
Structs
- Accept
- AcceptBi
- AcceptUni
- AckFrequencyConfig
- AddressDiscovery
- ApplicationClose
- BloomTokenLog
- Chunk
- ClientConfig
- ClosePath
- ClosedStream
- Connecting
- Connection
- ConnectionClose
- ConnectionId
- ConnectionStats
- Endpoint
- EndpointConfig
- EndpointStats
- FrameStats
- IdleTimeout
- Incoming
- IncomingFuture
- InvalidCid
- MtuDiscoveryConfig
- NoneTokenLog
- NoneTokenStore
- OnClosed
- OpenBi
- OpenPath
- OpenUni
- Path
- PathId
- PathStats
- QlogConfig
- QlogFileFactory
- ReadDatagram
- RecvStream
- RetryError
- SendDatagram
- SendStream
- ServerConfig
- SmolRuntime
- StdSystemTime
- StreamId
- TokenMemoryCache
- TokenReuseError
- TokioRuntime
- Transmit
- TransportConfig
- TransportErrorCode
- UdpStats
- UnorderedRecvStream
- ValidationTokenConfig
- VarInt
- VarIntBoundsExceeded
- WeakConnectionHandle
- Written
- ZeroRttAccepted
- congestion::Bbr
- congestion::BbrConfig
- congestion::ControllerMetrics
- congestion::Cubic
- congestion::CubicConfig
- congestion::NewReno
- congestion::NewRenoConfig
- crypto::CryptoError
- crypto::ExportKeyingMaterialError
- crypto::KeyPair
- crypto::Keys
- crypto::UnsupportedVersion
- crypto::rustls::HandshakeData
- crypto::rustls::NoInitialCipherSuite
- crypto::rustls::QuicClientConfig
- crypto::rustls::QuicServerConfig
- crypto::rustls::TlsSession
Enums
- ConfigError
- ConnectError
- ConnectionError
- Dir
- EcnCodepoint
- FrameType
- ReadError
- ReadExactError
- ReadToEndError
- ResetError
- SendDatagramError
- Side
- StoppedError
- WriteError
- crypto::rustls::Error
Traits
- AsyncTimer
- AsyncUdpSocket
- ConnectionIdGenerator
- QlogFactory
- Runtime
- TimeSource
- TokenLog
- TokenStore
- UdpSender
- congestion::Controller
- congestion::ControllerFactory
- crypto::AeadKey
- crypto::ClientConfig
- crypto::HandshakeTokenKey
- crypto::HeaderKey
- crypto::HmacKey
- crypto::PacketKey
- crypto::ServerConfig
- crypto::Session
Functions
\ No newline at end of file
diff --git a/pr/255/docs/iroh_quinn/congestion/index.html b/pr/255/docs/iroh_quinn/congestion/index.html
index 2216af227..8873423fc 100644
--- a/pr/255/docs/iroh_quinn/congestion/index.html
+++ b/pr/255/docs/iroh_quinn/congestion/index.html
@@ -1,2 +1,2 @@
-iroh_quinn::congestion - Rust Module congestion
Expand description
Logic for controlling the rate at which data is sent
+iroh_quinn::congestion - Rust Module congestion
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 - Controller
Metrics - Common congestion controller metrics
- Cubic
- The RFC8312 congestion controller, as widely used for TCP
- Cubic
Config - Configuration for the
Cubic congestion controller - NewReno
- A simple, standard congestion controller
- NewReno
Config - Configuration for the
NewReno congestion controller
Traits§
- Controller
- Common interface for different congestion controllers
- Controller
Factory - Constructs controllers on demand
\ No newline at end of file
diff --git a/pr/255/docs/iroh_quinn/congestion/struct.Bbr.html b/pr/255/docs/iroh_quinn/congestion/struct.Bbr.html
index 630fc0fa4..a2f2eaedc 100644
--- a/pr/255/docs/iroh_quinn/congestion/struct.Bbr.html
+++ b/pr/255/docs/iroh_quinn/congestion/struct.Bbr.html
@@ -4,27 +4,27 @@ Based on google’s quiche implementation https://datatracker.ietf.org/doc/html/draft-cardwell-iccrg-bbr-congestion-control.
More discussion and links at https://groups.google.com/g/bbr-dev.
Implementations§
Trait Implementations§
Trait Implementations§
Source§impl Controller for Bbr
Source§fn on_sent(&mut self, now: Instant, bytes: u64, last_packet_number: u64)
One or more packets were just sentSource§fn on_ack(
&mut self,
now: Instant,
sent: Instant,
bytes: u64,
app_limited: bool,
rtt: &RttEstimator,
-)
Packet deliveries were confirmed Read moreSource§fn on_end_acks(
+)
Packet deliveries were confirmed Read moreSource§fn on_end_acks(
&mut self,
now: Instant,
in_flight: u64,
app_limited: bool,
largest_packet_num_acked: Option<u64>,
-)
Packets are acked in batches, all with the same now argument. This indicates one of those batches has completed.Source§fn on_congestion_event(
+)
Packets are acked in batches, all with the same now argument. This indicates one of those batches has completed.Source§fn on_congestion_event(
&mut self,
_now: Instant,
_sent: Instant,
_is_persistent_congestion: bool,
_is_ecn: bool,
lost_bytes: u64,
-)
Packets were deemed lost or marked congested Read moreSource§fn on_mtu_update(&mut self, new_mtu: u16)
The known MTU for the current network path has been updatedSource§fn metrics(&self) -> ControllerMetrics
Retrieve implementation-specific metrics used to populate qlog traces when they are enabledSource§fn clone_box(&self) -> Box<dyn Controller>
Duplicate the controller’s stateSource§fn initial_window(&self) -> u64
Initial congestion windowSource§fn into_any(self: Box<Bbr>) -> Box<dyn Any>
Returns Self for use in down-casting to extract implementation detailsSource§fn on_spurious_congestion_event(&mut self)
Packets were incorrectly deemed lost Read moreAuto Trait Implementations§
§impl Freeze for Bbr
§impl RefUnwindSafe for Bbr
§impl Send for Bbr
§impl Sync for Bbr
§impl Unpin for Bbr
§impl UnwindSafe for Bbr
Blanket Implementations§
Source§impl<T> Any for Twhere
+)Packets were deemed lost or marked congested Read moreSource§fn on_mtu_update(&mut self, new_mtu: u16)
The known MTU for the current network path has been updatedSource§fn metrics(&self) -> ControllerMetrics
Retrieve implementation-specific metrics used to populate qlog traces when they are enabledSource§fn clone_box(&self) -> Box<dyn Controller>
Duplicate the controller’s stateSource§fn initial_window(&self) -> u64
Initial congestion windowSource§fn into_any(self: Box<Bbr>) -> Box<dyn Any>
Returns Self for use in down-casting to extract implementation detailsSource§fn on_spurious_congestion_event(&mut self)
Packets were incorrectly deemed lost Read more
Auto Trait Implementations§
§impl Freeze for Bbr
§impl RefUnwindSafe for Bbr
§impl Send for Bbr
§impl Sync for Bbr
§impl Unpin for Bbr
§impl UnwindSafe for Bbr
Blanket Implementations§
Source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
Source§fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read moreSource§impl<T> CloneToUninit for Twhere
diff --git a/pr/255/docs/iroh_quinn/congestion/struct.BbrConfig.html b/pr/255/docs/iroh_quinn/congestion/struct.BbrConfig.html
index f340fb3e2..c931fff20 100644
--- a/pr/255/docs/iroh_quinn/congestion/struct.BbrConfig.html
+++ b/pr/255/docs/iroh_quinn/congestion/struct.BbrConfig.html
@@ -1,11 +1,11 @@
-BbrConfig in iroh_quinn::congestion - Rust BbrConfig
pub struct BbrConfig { /* private fields */ }
Expand description
Configuration for the Bbr congestion controller
-Implementations§
Source§impl BbrConfig
Sourcepub fn initial_window(&mut self, value: u64) -> &mut BbrConfig
Default limit on the amount of outstanding data in bytes.
+BbrConfig in iroh_quinn::congestion - Rust BbrConfig
pub struct BbrConfig { /* private fields */ }
Expand description
Configuration for the Bbr congestion controller
+Implementations§
Trait Implementations§
Trait Implementations§
Source§impl ControllerFactory for BbrConfig
Auto Trait Implementations§
§impl Freeze for BbrConfig
§impl RefUnwindSafe for BbrConfig
§impl Send for BbrConfig
§impl Sync for BbrConfig
§impl Unpin for BbrConfig
§impl UnwindSafe for BbrConfig
Blanket Implementations§
Auto Trait Implementations§
§impl Freeze for BbrConfig
§impl RefUnwindSafe for BbrConfig
§impl Send for BbrConfig
§impl Sync for BbrConfig
§impl Unpin for BbrConfig
§impl UnwindSafe for BbrConfig
Blanket Implementations§
Source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
Source§fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read moreSource§impl<T> CloneToUninit for Twhere
diff --git a/pr/255/docs/iroh_quinn/congestion/trait.Controller.html b/pr/255/docs/iroh_quinn/congestion/trait.Controller.html
index 6fd6a4943..c582370df 100644
--- a/pr/255/docs/iroh_quinn/congestion/trait.Controller.html
+++ b/pr/255/docs/iroh_quinn/congestion/trait.Controller.html
@@ -76,4 +76,4 @@ application data prior to receiving these acknowledgements.
This function is called when all packets that were deemed lost (for instance because
of packet reordering) are acknowledged after the congestion event was raised.
Sourcefn metrics(&self) -> ControllerMetrics
Retrieve implementation-specific metrics used to populate qlog traces when they are enabled
-Implementors§
\ No newline at end of file
+Implementors§
\ No newline at end of file
diff --git a/pr/255/docs/iroh_quinn/congestion/trait.ControllerFactory.html b/pr/255/docs/iroh_quinn/congestion/trait.ControllerFactory.html
index 056571893..5f8ab4fc4 100644
--- a/pr/255/docs/iroh_quinn/congestion/trait.ControllerFactory.html
+++ b/pr/255/docs/iroh_quinn/congestion/trait.ControllerFactory.html
@@ -7,4 +7,4 @@
) -> Box<dyn Controller>;
}Expand description
Constructs controllers on demand
Required Methods§
Implementors§
Source§impl ControllerFactory for BbrConfig
Source§impl ControllerFactory for CubicConfig
Source§impl ControllerFactory for NewRenoConfig
\ No newline at end of file
+
Implementors§
Source§impl ControllerFactory for BbrConfig
Source§impl ControllerFactory for CubicConfig
Source§impl ControllerFactory for NewRenoConfig
\ No newline at end of file
diff --git a/pr/255/docs/iroh_quinn/crypto/rustls/struct.QuicClientConfig.html b/pr/255/docs/iroh_quinn/crypto/rustls/struct.QuicClientConfig.html
index 00fbff019..228863942 100644
--- a/pr/255/docs/iroh_quinn/crypto/rustls/struct.QuicClientConfig.html
+++ b/pr/255/docs/iroh_quinn/crypto/rustls/struct.QuicClientConfig.html
@@ -1,6 +1,6 @@
QuicClientConfig in iroh_quinn::crypto::rustls - Rust QuicClientConfig
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::with_platform_verifier().
+ClientConfig::with_root_certificates() and ClientConfig::try_with_platform_verifier().
Alternatively, QuicClientConfig’s TryFrom implementation can be used to wrap around a
custom [rustls::ClientConfig], in which case care should be taken around certain points:
diff --git a/pr/255/docs/iroh_quinn/enum.ConfigError.html b/pr/255/docs/iroh_quinn/enum.ConfigError.html
index f0a6f72ec..ce5f3a366 100644
--- a/pr/255/docs/iroh_quinn/enum.ConfigError.html
+++ b/pr/255/docs/iroh_quinn/enum.ConfigError.html
@@ -1,9 +1,9 @@
-ConfigError in iroh_quinn - Rust ConfigError
#[non_exhaustive]pub enum ConfigError {
+ConfigError in iroh_quinn - Rust ConfigError
#[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
-Trait Implementations§
Source§impl Clone for ConfigError
Source§fn clone(&self) -> ConfigError
Returns a duplicate of the value. Read more1.0.0 · Source§fn clone_from(&mut self, source: &Self)
Performs copy-assignment from source. Read moreSource§impl Debug for ConfigError
Source§impl Display for ConfigError
Source§impl Error for ConfigError
1.30.0 · Source§fn source(&self) -> Option<&(dyn Error + 'static)>
Returns the lower-level source of this error, if any. Read more1.0.0 · Source§fn description(&self) -> &str
👎Deprecated since 1.42.0: use the Display impl or to_string()Source§impl From<TryFromIntError> for ConfigError
Source§fn from(_: TryFromIntError) -> ConfigError
Converts to this type from the input type.Source§impl From<VarIntBoundsExceeded> for ConfigError
Source§fn from(_: VarIntBoundsExceeded) -> ConfigError
Converts to this type from the input type.Source§impl PartialEq for ConfigError
Source§impl Eq for ConfigError
Source§impl StructuralPartialEq for ConfigError
Auto Trait Implementations§
§impl Freeze for ConfigError
§impl RefUnwindSafe for ConfigError
§impl Send for ConfigError
§impl Sync for ConfigError
§impl Unpin for ConfigError
§impl UnwindSafe for ConfigError
Blanket Implementations§
Trait Implementations§
Source§impl Clone for ConfigError
Source§fn clone(&self) -> ConfigError
Returns a duplicate of the value. Read more1.0.0 · Source§fn clone_from(&mut self, source: &Self)
Performs copy-assignment from source. Read moreSource§impl Debug for ConfigError
Source§impl Display for ConfigError
Source§impl Error for ConfigError
1.30.0 · Source§fn source(&self) -> Option<&(dyn Error + 'static)>
Returns the lower-level source of this error, if any. Read more1.0.0 · Source§fn description(&self) -> &str
👎Deprecated since 1.42.0: use the Display impl or to_string()Source§impl From<TryFromIntError> for ConfigError
Source§fn from(_: TryFromIntError) -> ConfigError
Converts to this type from the input type.Source§impl From<VarIntBoundsExceeded> for ConfigError
Source§fn from(_: VarIntBoundsExceeded) -> ConfigError
Converts to this type from the input type.Source§impl PartialEq for ConfigError
Source§impl Eq for ConfigError
Source§impl StructuralPartialEq for ConfigError
Auto Trait Implementations§
§impl Freeze for ConfigError
§impl RefUnwindSafe for ConfigError
§impl Send for ConfigError
§impl Sync for ConfigError
§impl Unpin for ConfigError
§impl UnwindSafe for ConfigError
Blanket Implementations§
Source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
Source§fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read moreSource§impl<T> CloneToUninit for Twhere
diff --git a/pr/255/docs/iroh_quinn/enum.ConnectError.html b/pr/255/docs/iroh_quinn/enum.ConnectError.html
index cbdd09bd8..4238be063 100644
--- a/pr/255/docs/iroh_quinn/enum.ConnectError.html
+++ b/pr/255/docs/iroh_quinn/enum.ConnectError.html
@@ -1,4 +1,4 @@
-ConnectError in iroh_quinn - Rust ConnectError
pub enum ConnectError {
+ConnectError in iroh_quinn - Rust ConnectError
pub enum ConnectError {
EndpointStopping,
CidsExhausted,
InvalidServerName(String),
@@ -17,8 +17,8 @@
§NoDefaultClientConfig
No default client configuration was set up
Use Endpoint::connect_with to specify a client configuration.
§UnsupportedVersion
The local endpoint does not support the QUIC version specified in the client configuration
-
Trait Implementations§
Source§impl Clone for ConnectError
Source§fn clone(&self) -> ConnectError
Returns a duplicate of the value. Read more1.0.0 · Source§fn clone_from(&mut self, source: &Self)
Performs copy-assignment from source. Read moreSource§impl Debug for ConnectError
Source§impl Display for ConnectError
Source§impl Error for ConnectError
1.30.0 · Source§fn source(&self) -> Option<&(dyn Error + 'static)>
Returns the lower-level source of this error, if any. Read more1.0.0 · Source§fn description(&self) -> &str
👎Deprecated since 1.42.0: use the Display impl or to_string()Source§impl From<UnsupportedVersion> for ConnectError
Source§fn from(_: UnsupportedVersion) -> ConnectError
Converts to this type from the input type.Source§impl PartialEq for ConnectError
Source§impl Eq for ConnectError
Source§impl StructuralPartialEq for ConnectError
Auto Trait Implementations§
§impl Freeze for ConnectError
§impl RefUnwindSafe for ConnectError
§impl Send for ConnectError
§impl Sync for ConnectError
§impl Unpin for ConnectError
§impl UnwindSafe for ConnectError
Blanket Implementations§
Trait Implementations§
Source§impl Clone for ConnectError
Source§fn clone(&self) -> ConnectError
Returns a duplicate of the value. Read more1.0.0 · Source§fn clone_from(&mut self, source: &Self)
Performs copy-assignment from source. Read moreSource§impl Debug for ConnectError
Source§impl Display for ConnectError
Source§impl Error for ConnectError
1.30.0 · Source§fn source(&self) -> Option<&(dyn Error + 'static)>
Returns the lower-level source of this error, if any. Read more1.0.0 · Source§fn description(&self) -> &str
👎Deprecated since 1.42.0: use the Display impl or to_string()Source§impl From<UnsupportedVersion> for ConnectError
Source§fn from(_: UnsupportedVersion) -> ConnectError
Converts to this type from the input type.Source§impl PartialEq for ConnectError
Source§impl Eq for ConnectError
Source§impl StructuralPartialEq for ConnectError
Auto Trait Implementations§
§impl Freeze for ConnectError
§impl RefUnwindSafe for ConnectError
§impl Send for ConnectError
§impl Sync for ConnectError
§impl Unpin for ConnectError
§impl UnwindSafe for ConnectError
Blanket Implementations§
Source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
Source§fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read moreSource§impl<T> CloneToUninit for Twhere
diff --git a/pr/255/docs/iroh_quinn/enum.ConnectionError.html b/pr/255/docs/iroh_quinn/enum.ConnectionError.html
index 088a81850..99006f4cd 100644
--- a/pr/255/docs/iroh_quinn/enum.ConnectionError.html
+++ b/pr/255/docs/iroh_quinn/enum.ConnectionError.html
@@ -1,4 +1,4 @@
-ConnectionError in iroh_quinn - Rust ConnectionError
pub enum ConnectionError {
+ConnectionError in iroh_quinn - Rust ConnectionError
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 more1.0.0 · Source§fn clone_from(&mut self, source: &Self)
Performs copy-assignment from source. Read moreSource§impl Debug for ConnectionError
Source§impl Display for ConnectionError
Source§impl Error for ConnectionError
Source§fn source(&self) -> Option<&(dyn Error + 'static)>
Returns the lower-level source of this error, if any. Read more1.0.0 · Source§fn description(&self) -> &str
👎Deprecated since 1.42.0: use the Display impl or to_string()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§impl Eq for ConnectionError
Source§impl StructuralPartialEq for ConnectionError
Auto Trait Implementations§
§impl !Freeze for ConnectionError
§impl !RefUnwindSafe for ConnectionError
§impl Send for ConnectionError
§impl Sync for ConnectionError
§impl Unpin for ConnectionError
§impl !UnwindSafe for ConnectionError
Blanket Implementations§
Trait Implementations§
Source§impl Clone for ConnectionError
Source§fn clone(&self) -> ConnectionError
Returns a duplicate of the value. Read more1.0.0 · Source§fn clone_from(&mut self, source: &Self)
Performs copy-assignment from source. Read moreSource§impl Debug for ConnectionError
Source§impl Display for ConnectionError
Source§impl Error for ConnectionError
Source§fn source(&self) -> Option<&(dyn Error + 'static)>
Returns the lower-level source of this error, if any. Read more1.0.0 · Source§fn description(&self) -> &str
👎Deprecated since 1.42.0: use the Display impl or to_string()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§impl Eq for ConnectionError
Source§impl StructuralPartialEq for ConnectionError
Auto Trait Implementations§
§impl !Freeze for ConnectionError
§impl !RefUnwindSafe for ConnectionError
§impl Send for ConnectionError
§impl Sync for ConnectionError
§impl Unpin for ConnectionError
§impl !UnwindSafe for ConnectionError
Blanket Implementations§
Source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
Source§fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read moreSource§impl<T> CloneToUninit for Twhere
diff --git a/pr/255/docs/iroh_quinn/enum.Dir.html b/pr/255/docs/iroh_quinn/enum.Dir.html
index efbb040b3..59802f8a6 100644
--- a/pr/255/docs/iroh_quinn/enum.Dir.html
+++ b/pr/255/docs/iroh_quinn/enum.Dir.html
@@ -1,25 +1,25 @@
-Dir in iroh_quinn - Rust Dir
pub enum Dir {
+Dir in iroh_quinn - Rust Dir
pub enum Dir {
Bi = 0,
Uni = 1,
}
Expand description
Whether a stream communicates data in both directions or only from the initiator
Variants§
Trait Implementations§
Source§impl<'arbitrary> Arbitrary<'arbitrary> for Dir
Source§fn arbitrary(u: &mut Unstructured<'arbitrary>) -> Result<Dir, Error>
Generate an arbitrary value of Self from the given unstructured data. Read moreTrait Implementations§
Source§impl<'arbitrary> Arbitrary<'arbitrary> for Dir
Source§fn arbitrary(u: &mut Unstructured<'arbitrary>) -> Result<Dir, Error>
Generate an arbitrary value of Self from the given unstructured data. Read moreSource§fn arbitrary_take_rest(u: Unstructured<'arbitrary>) -> Result<Dir, Error>
Generate an arbitrary value of Self from the entirety of the given
+unstructured data. Read moreSource§impl Ord for Dir
Source§impl PartialOrd for Dir
Source§impl PartialOrd for Dir
Source§impl Copy for Dir
Source§impl Eq for Dir
Source§impl StructuralPartialEq for Dir
Auto Trait Implementations§
§impl Freeze for Dir
§impl RefUnwindSafe for Dir
§impl Send for Dir
§impl Sync for Dir
§impl Unpin for Dir
§impl UnwindSafe for Dir
Blanket Implementations§
Source§impl Copy for Dir
Source§impl Eq for Dir
Source§impl StructuralPartialEq for Dir
Auto Trait Implementations§
§impl Freeze for Dir
§impl RefUnwindSafe for Dir
§impl Send for Dir
§impl Sync for Dir
§impl Unpin for Dir
§impl UnwindSafe for Dir
Blanket Implementations§
Source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
Source§fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read moreSource§impl<T> CloneToUninit for Twhere
diff --git a/pr/255/docs/iroh_quinn/enum.FrameType.html b/pr/255/docs/iroh_quinn/enum.FrameType.html
index a35f3f031..c28f19a5c 100644
--- a/pr/255/docs/iroh_quinn/enum.FrameType.html
+++ b/pr/255/docs/iroh_quinn/enum.FrameType.html
@@ -7,7 +7,7 @@
StopSending,
Crypto,
NewToken,
- Stream(StreamInfo),
+ Stream(StreamInfo),
MaxData,
MaxStreamData,
MaxStreamsBidi,
@@ -25,7 +25,7 @@
HandshakeDone,
AckFrequency,
ImmediateAck,
- Datagram(DatagramInfo),
+ Datagram(DatagramInfo),
ObservedIpv4Addr,
ObservedIpv6Addr,
PathAck,
@@ -43,10 +43,10 @@
ReachOutAtIpv4,
ReachOutAtIpv6,
RemoveAddress,
-}Variants§
§Padding
§Ping
§Ack
§AckEcn
§ResetStream
§StopSending
§Crypto
§NewToken
§Stream(StreamInfo)
§MaxData
§MaxStreamData
§MaxStreamsBidi
§MaxStreamsUni
§DataBlocked
§StreamDataBlocked
§StreamsBlockedBidi
§StreamsBlockedUni
§NewConnectionId
§RetireConnectionId
§PathChallenge
§PathResponse
§ConnectionClose
§ApplicationClose
§HandshakeDone
§AckFrequency
§ImmediateAck
§Datagram(DatagramInfo)
§ObservedIpv4Addr
§ObservedIpv6Addr
§PathAck
§PathAckEcn
§PathAbandon
§PathStatusBackup
§PathStatusAvailable
§PathNewConnectionId
§PathRetireConnectionId
§MaxPathId
§PathsBlocked
§PathCidsBlocked
§AddIpv4Address
§AddIpv6Address
§ReachOutAtIpv4
§ReachOutAtIpv6
§RemoveAddress
Trait Implementations§
Source§impl Encodable for FrameType
Source§fn encode<B>(&self, buf: &mut B)where
+}Variants§
§Padding
§Ping
§Ack
§AckEcn
§ResetStream
§StopSending
§Crypto
§NewToken
§Stream(StreamInfo)
§MaxData
§MaxStreamData
§MaxStreamsBidi
§MaxStreamsUni
§DataBlocked
§StreamDataBlocked
§StreamsBlockedBidi
§StreamsBlockedUni
§NewConnectionId
§RetireConnectionId
§PathChallenge
§PathResponse
§ConnectionClose
§ApplicationClose
§HandshakeDone
§AckFrequency
§ImmediateAck
§Datagram(DatagramInfo)
§ObservedIpv4Addr
§ObservedIpv6Addr
§PathAck
§PathAckEcn
§PathAbandon
§PathStatusBackup
§PathStatusAvailable
§PathNewConnectionId
§PathRetireConnectionId
§MaxPathId
§PathsBlocked
§PathCidsBlocked
§AddIpv4Address
§AddIpv6Address
§ReachOutAtIpv4
§ReachOutAtIpv6
§RemoveAddress
Trait Implementations§
Source§impl Copy for FrameType
Source§impl Eq for FrameType
Source§impl StructuralPartialEq for FrameType
Auto Trait Implementations§
§impl Freeze for FrameType
§impl RefUnwindSafe for FrameType
§impl Send for FrameType
§impl Sync for FrameType
§impl Unpin for FrameType
§impl UnwindSafe for FrameType
Blanket Implementations§
Source§impl Copy for FrameType
Source§impl Eq for FrameType
Source§impl StructuralPartialEq for FrameType
Auto Trait Implementations§
§impl Freeze for FrameType
§impl RefUnwindSafe for FrameType
§impl Send for FrameType
§impl Sync for FrameType
§impl Unpin for FrameType
§impl UnwindSafe for FrameType
Blanket Implementations§
Source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
Source§fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read moreSource§impl<T> CloneToUninit for Twhere
diff --git a/pr/255/docs/iroh_quinn/enum.Side.html b/pr/255/docs/iroh_quinn/enum.Side.html
index 2bcf64c9b..1bb5dd646 100644
--- a/pr/255/docs/iroh_quinn/enum.Side.html
+++ b/pr/255/docs/iroh_quinn/enum.Side.html
@@ -1,27 +1,27 @@
-Side in iroh_quinn - Rust Side
pub enum Side {
+Side in iroh_quinn - Rust Side
pub enum Side {
Client = 0,
Server = 1,
}
Expand description
Whether an endpoint was the initiator of a connection
Variants§
Implementations§
Trait Implementations§
Source§impl<'arbitrary> Arbitrary<'arbitrary> for Side
Source§fn arbitrary(u: &mut Unstructured<'arbitrary>) -> Result<Side, Error>
Generate an arbitrary value of Self from the given unstructured data. Read moreImplementations§
Trait Implementations§
Source§impl<'arbitrary> Arbitrary<'arbitrary> for Side
Source§fn arbitrary(u: &mut Unstructured<'arbitrary>) -> Result<Side, Error>
Generate an arbitrary value of Self from the given unstructured data. Read moreSource§fn arbitrary_take_rest(u: Unstructured<'arbitrary>) -> Result<Side, Error>
Generate an arbitrary value of Self from the entirety of the given
+unstructured data. Read moreSource§impl Ord for Side
Source§impl PartialOrd for Side
Source§impl PartialOrd for Side
Source§impl Copy for Side
Source§impl Eq for Side
Source§impl StructuralPartialEq for Side
Auto Trait Implementations§
§impl Freeze for Side
§impl RefUnwindSafe for Side
§impl Send for Side
§impl Sync for Side
§impl Unpin for Side
§impl UnwindSafe for Side
Blanket Implementations§
Source§impl Copy for Side
Source§impl Eq for Side
Source§impl StructuralPartialEq for Side
Auto Trait Implementations§
§impl Freeze for Side
§impl RefUnwindSafe for Side
§impl Send for Side
§impl Sync for Side
§impl Unpin for Side
§impl UnwindSafe for Side
Blanket Implementations§
Source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
Source§fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read moreSource§impl<T> CloneToUninit for Twhere
diff --git a/pr/255/docs/iroh_quinn/enum.StoppedError.html b/pr/255/docs/iroh_quinn/enum.StoppedError.html
index 42ac78ed6..ca10923e6 100644
--- a/pr/255/docs/iroh_quinn/enum.StoppedError.html
+++ b/pr/255/docs/iroh_quinn/enum.StoppedError.html
@@ -1,4 +1,4 @@
-StoppedError in iroh_quinn - Rust StoppedError
pub enum StoppedError {
+StoppedError in iroh_quinn - Rust StoppedError
pub enum StoppedError {
ConnectionLost(ConnectionError),
ZeroRttRejected,
}
Expand description
Errors that arise while monitoring for a send stream stop from the peer
@@ -6,8 +6,8 @@
§ZeroRttRejected
This was a 0-RTT stream and the server rejected it
Can only occur on clients for 0-RTT streams, which can be opened using
Connecting::into_0rtt().
-Trait Implementations§
Source§impl Clone for StoppedError
Source§fn clone(&self) -> StoppedError
Returns a duplicate of the value. Read more1.0.0 · Source§fn clone_from(&mut self, source: &Self)
Performs copy-assignment from source. Read moreSource§impl Debug for StoppedError
Source§impl Display for StoppedError
Source§impl Error for StoppedError
Source§fn source(&self) -> Option<&(dyn Error + 'static)>
Returns the lower-level source of this error, if any. Read more1.0.0 · Source§fn description(&self) -> &str
👎Deprecated since 1.42.0: use the Display impl or to_string()Source§impl From<ConnectionError> for StoppedError
Source§fn from(source: ConnectionError) -> Self
Converts to this type from the input type.Source§impl From<StoppedError> for Error
Source§fn from(x: StoppedError) -> Self
Converts to this type from the input type.Source§impl From<StoppedError> for WriteError
Source§fn from(x: StoppedError) -> Self
Converts to this type from the input type.Source§impl PartialEq for StoppedError
Source§impl Eq for StoppedError
Source§impl StructuralPartialEq for StoppedError
Auto Trait Implementations§
§impl !Freeze for StoppedError
§impl !RefUnwindSafe for StoppedError
§impl Send for StoppedError
§impl Sync for StoppedError
§impl Unpin for StoppedError
§impl !UnwindSafe for StoppedError
Blanket Implementations§
Trait Implementations§
Source§impl Clone for StoppedError
Source§fn clone(&self) -> StoppedError
Returns a duplicate of the value. Read more1.0.0 · Source§fn clone_from(&mut self, source: &Self)
Performs copy-assignment from source. Read moreSource§impl Debug for StoppedError
Source§impl Display for StoppedError
Source§impl Error for StoppedError
Source§fn source(&self) -> Option<&(dyn Error + 'static)>
Returns the lower-level source of this error, if any. Read more1.0.0 · Source§fn description(&self) -> &str
👎Deprecated since 1.42.0: use the Display impl or to_string()Source§impl From<ConnectionError> for StoppedError
Source§fn from(source: ConnectionError) -> Self
Converts to this type from the input type.Source§impl From<StoppedError> for Error
Source§fn from(x: StoppedError) -> Self
Converts to this type from the input type.Source§impl From<StoppedError> for WriteError
Source§fn from(x: StoppedError) -> Self
Converts to this type from the input type.Source§impl PartialEq for StoppedError
Source§impl Eq for StoppedError
Source§impl StructuralPartialEq for StoppedError
Auto Trait Implementations§
§impl !Freeze for StoppedError
§impl !RefUnwindSafe for StoppedError
§impl Send for StoppedError
§impl Sync for StoppedError
§impl Unpin for StoppedError
§impl !UnwindSafe for StoppedError
Blanket Implementations§
Source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
Source§fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read moreSource§impl<T> CloneToUninit for Twhere
diff --git a/pr/255/docs/iroh_quinn/enum.WriteError.html b/pr/255/docs/iroh_quinn/enum.WriteError.html
index 48fd44e36..ea02311ac 100644
--- a/pr/255/docs/iroh_quinn/enum.WriteError.html
+++ b/pr/255/docs/iroh_quinn/enum.WriteError.html
@@ -1,4 +1,4 @@
-WriteError in iroh_quinn - Rust WriteError
pub enum WriteError {
+WriteError in iroh_quinn - Rust WriteError
pub enum WriteError {
Stopped(VarInt),
ConnectionLost(ConnectionError),
ClosedStream,
@@ -11,8 +11,8 @@
§ZeroRttRejected
This was a 0-RTT stream and the server rejected it
Can only occur on clients for 0-RTT streams, which can be opened using
Connecting::into_0rtt().
-
Trait Implementations§
Source§impl Clone for WriteError
Source§fn clone(&self) -> WriteError
Returns a duplicate of the value. Read more1.0.0 · Source§fn clone_from(&mut self, source: &Self)
Performs copy-assignment from source. Read moreSource§impl Debug for WriteError
Source§impl Display for WriteError
Source§impl Error for WriteError
Source§fn source(&self) -> Option<&(dyn Error + 'static)>
Returns the lower-level source of this error, if any. Read more1.0.0 · Source§fn description(&self) -> &str
👎Deprecated since 1.42.0: use the Display impl or to_string()Source§impl From<ClosedStream> for WriteError
Source§fn from(_: ClosedStream) -> 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<StoppedError> for WriteError
Source§fn from(x: StoppedError) -> Self
Converts to this type from the input type.Source§impl From<WriteError> for Error
Source§fn from(x: WriteError) -> Self
Converts to this type from the input type.Source§impl PartialEq for WriteError
Source§impl Eq for WriteError
Source§impl StructuralPartialEq for WriteError
Auto Trait Implementations§
§impl !Freeze for WriteError
§impl !RefUnwindSafe for WriteError
§impl Send for WriteError
§impl Sync for WriteError
§impl Unpin for WriteError
§impl !UnwindSafe for WriteError
Blanket Implementations§
Trait Implementations§
Source§impl Clone for WriteError
Source§fn clone(&self) -> WriteError
Returns a duplicate of the value. Read more1.0.0 · Source§fn clone_from(&mut self, source: &Self)
Performs copy-assignment from source. Read moreSource§impl Debug for WriteError
Source§impl Display for WriteError
Source§impl Error for WriteError
Source§fn source(&self) -> Option<&(dyn Error + 'static)>
Returns the lower-level source of this error, if any. Read more1.0.0 · Source§fn description(&self) -> &str
👎Deprecated since 1.42.0: use the Display impl or to_string()Source§impl From<ClosedStream> for WriteError
Source§fn from(_: ClosedStream) -> 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<StoppedError> for WriteError
Source§fn from(x: StoppedError) -> Self
Converts to this type from the input type.Source§impl From<WriteError> for Error
Source§fn from(x: WriteError) -> Self
Converts to this type from the input type.Source§impl PartialEq for WriteError
Source§impl Eq for WriteError
Source§impl StructuralPartialEq for WriteError
Auto Trait Implementations§
§impl !Freeze for WriteError
§impl !RefUnwindSafe for WriteError
§impl Send for WriteError
§impl Sync for WriteError
§impl Unpin for WriteError
§impl !UnwindSafe for WriteError
Blanket Implementations§
Source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
Source§fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read moreSource§impl<T> CloneToUninit for Twhere
diff --git a/pr/255/docs/iroh_quinn/index.html b/pr/255/docs/iroh_quinn/index.html
index 281df6ef6..f0adc5bb4 100644
--- a/pr/255/docs/iroh_quinn/index.html
+++ b/pr/255/docs/iroh_quinn/index.html
@@ -1,4 +1,4 @@
-iroh_quinn - Rust Crate iroh_quinn
Expand description
QUIC transport protocol implementation
+iroh_quinn - Rust Crate iroh_quinn
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
@@ -29,6 +29,6 @@ server, it is useful for a QUIC server to be identified by a certificate signed
authority. If this is infeasible–for example, if servers are short-lived or not associated
with a domain name–then as with TLS, self-signed certificates can be used to provide
encryption alone.
-Re-exports§
pub use rustls;pub use udp;
Modules§
- congestion
- Logic for controlling the rate at which data is sent
- crypto
- Traits and implementations for the QUIC cryptography protocol
Structs§
- Accept
- Future produced by
Endpoint::accept - Accept
Bi - Future produced by
Connection::accept_bi - Accept
Uni - Future produced by
Connection::accept_uni - AckFrequency
Config - Parameters for controlling the peer’s acknowledgement frequency
- Application
Close - Reason given by an application for closing the connection
- Bloom
TokenLog - Bloom filter-based
TokenLog - Chunk
- A chunk of data from the receive stream
- Client
Config - Configuration for outgoing connections
- Closed
Stream - Error indicating that a stream has not been opened or has already been finished or reset
- Connecting
- In-progress connection attempt future
- Connection
- A QUIC connection.
- Connection
Close - Reason given by the transport for closing the connection
- Connection
Id - Protocol-level identifier for a connection.
- Connection
Stats - Connection statistics
- Endpoint
- A QUIC endpoint.
- Endpoint
Config - Global configuration for the endpoint, affecting all connections
- Endpoint
Stats - Statistics on Endpoint activity
- Frame
Stats - Number of frames transmitted or received of each frame type
- Idle
Timeout - Maximum duration of inactivity to accept before timing out the connection
- Incoming
- An incoming connection for which the server has not yet begun its part of the handshake
- Incoming
Future - Basic adapter to let
Incoming be await-ed like a Connecting - MtuDiscovery
Config - Parameters governing MTU discovery.
- None
TokenLog - Null implementation of
TokenLog, which never accepts tokens - None
TokenStore - Null implementation of
TokenStore, which does not store any tokens - OnClosed
- Future returned by
Connection::on_closed - OpenBi
- Future produced by
Connection::open_bi - Open
Path - Future produced by
crate::Connection::open_path - OpenUni
- Future produced by
Connection::open_uni - Path
- An open (Multi)Path
- PathId
- Id representing different paths when using multipath extension
- Path
Stats - Statistics related to a transmission path
- Qlog
Config - Configuration for qlog trace logging.
- Qlog
FileFactory - Enables writing qlog traces to a directory.
- Read
Datagram - Future produced by
Connection::read_datagram - Recv
Stream - A stream that can only be used to receive data
- Retry
Error - Error for attempting to retry an
Incoming which already bears a token from a previous retry - Send
Datagram - Future produced by
Connection::send_datagram_wait - Send
Stream - A stream that can only be used to send data
- Server
Config - Parameters governing incoming connections
- Smol
Runtime - A Quinn runtime for smol
- StdSystem
Time - Default implementation of
TimeSource - Stream
Id - Identifier for a stream within a particular connection
- Token
MemoryCache TokenStore implementation that stores up to N tokens per server name for up to a
+
Re-exports§
pub use rustls;pub use udp;
Modules§
- congestion
- Logic for controlling the rate at which data is sent
- crypto
- Traits and implementations for the QUIC cryptography protocol
Structs§
- Accept
- Future produced by
Endpoint::accept - Accept
Bi - Future produced by
Connection::accept_bi - Accept
Uni - Future produced by
Connection::accept_uni - AckFrequency
Config - Parameters for controlling the peer’s acknowledgement frequency
- Address
Discovery - Stream produced by
Path::observed_external_addr - Application
Close - Reason given by an application for closing the connection
- Bloom
TokenLog - Bloom filter-based
TokenLog - Chunk
- A chunk of data from the receive stream
- Client
Config - Configuration for outgoing connections
- Close
Path - Future produced by
Path::close - Closed
Stream - Error indicating that a stream has not been opened or has already been finished or reset
- Connecting
- In-progress connection attempt future
- Connection
- A QUIC connection.
- Connection
Close - Reason given by the transport for closing the connection
- Connection
Id - Protocol-level identifier for a connection.
- Connection
Stats - Connection statistics
- Endpoint
- A QUIC endpoint.
- Endpoint
Config - Global configuration for the endpoint, affecting all connections
- Endpoint
Stats - Statistics on Endpoint activity
- Frame
Stats - Number of frames transmitted or received of each frame type
- Idle
Timeout - Maximum duration of inactivity to accept before timing out the connection
- Incoming
- An incoming connection for which the server has not yet begun its part of the handshake
- Incoming
Future - Basic adapter to let
Incoming be await-ed like a Connecting - Invalid
Cid - The connection ID was not recognized by the
ConnectionIdGenerator - MtuDiscovery
Config - Parameters governing MTU discovery.
- None
TokenLog - Null implementation of
TokenLog, which never accepts tokens - None
TokenStore - Null implementation of
TokenStore, which does not store any tokens - OnClosed
- Future returned by
Connection::on_closed - OpenBi
- Future produced by
Connection::open_bi - Open
Path - Future produced by
crate::Connection::open_path - OpenUni
- Future produced by
Connection::open_uni - Path
- An open (Multi)Path
- PathId
- Id representing different paths when using multipath extension
- Path
Stats - Statistics related to a transmission path
- Qlog
Config - Configuration for qlog trace logging.
- Qlog
FileFactory - Enables writing qlog traces to a directory.
- Read
Datagram - Future produced by
Connection::read_datagram - Recv
Stream - A stream that can only be used to receive data
- Retry
Error - Error for attempting to retry an
Incoming which already bears a token from a previous retry - Send
Datagram - Future produced by
Connection::send_datagram_wait - Send
Stream - A stream that can only be used to send data
- Server
Config - Parameters governing incoming connections
- Smol
Runtime - A Quinn runtime for smol
- StdSystem
Time - Default implementation of
TimeSource - Stream
Id - Identifier for a stream within a particular connection
- Token
MemoryCache TokenStore implementation that stores up to N tokens per server name for up to a
limited number of server names, in-memory- Token
ReuseError - Error for when a validation token may have been reused
- Tokio
Runtime - A Quinn runtime for Tokio
- Transmit
- An outgoing packet
- Transport
Config - Parameters governing the core QUIC state machine
- Transport
ErrorCode - Transport-level error code
- UdpStats
- Statistics about UDP datagrams transmitted or received on a connection
- Unordered
RecvStream - A stream that can be used to receive data out-of-order.
- Validation
TokenConfig - Configuration for sending and handling validation tokens in incoming connections
- VarInt
- An integer less than 2^62
- VarInt
BoundsExceeded - Error returned when constructing a
VarInt from a value >= 2^62 - Weak
ConnectionHandle - A handle to some connection internals, use with care.
- Written
- Indicates how many bytes and chunks had been transferred in a write operation
- Zero
RttAccepted - Future that completes when a connection is fully established
Enums§
- Config
Error - Errors in the configuration of an endpoint
- Connect
Error - Errors in the parameters being used to create a new connection
- Connection
Error - Reasons why a connection might be lost
- Dir
- Whether a stream communicates data in both directions or only from the initiator
- EcnCodepoint
- Explicit congestion notification codepoint
- Frame
Type - Read
Error - Errors that arise from reading from a stream.
- Read
ExactError - Errors that arise from reading from a stream.
- Read
ToEndError - Errors from
RecvStream::read_to_end - Reset
Error - Errors that arise while waiting for a stream to be reset
- Send
DatagramError - Errors that can arise when sending a datagram
- Side
- Whether an endpoint was the initiator of a connection
- Stopped
Error - Errors that arise while monitoring for a send stream stop from the peer
- Write
Error - Errors that arise from writing to a stream
Traits§
- Async
Timer - Abstract implementation of an async timer for runtime independence
- Async
UdpSocket - Abstract implementation of a UDP socket for runtime independence
- Connection
IdGenerator - Generates connection IDs for incoming connections
- Qlog
Factory - Constructs a
QlogConfig for individual connections. - Runtime
- Abstracts I/O and timer operations for runtime independence
- Time
Source - Object to get current
SystemTime - Token
Log - Responsible for limiting clients’ ability to reuse validation tokens
- Token
Store - Responsible for storing validation tokens received from servers and retrieving them for use in
subsequent connections
- UdpSender
- An object for asynchronously writing to an associated
AsyncUdpSocket.
Functions§
- default_
runtime - Automatically select an appropriate runtime from those enabled at compile time
\ No newline at end of file
diff --git a/pr/255/docs/iroh_quinn/path/struct.AddressDiscovery.html b/pr/255/docs/iroh_quinn/path/struct.AddressDiscovery.html
new file mode 100644
index 000000000..e4476ec35
--- /dev/null
+++ b/pr/255/docs/iroh_quinn/path/struct.AddressDiscovery.html
@@ -0,0 +1,11 @@
+
+
+
+
+ Redirection
+
+
+ Redirecting to ../../iroh_quinn/struct.AddressDiscovery.html...
+
+
+
\ No newline at end of file
diff --git a/pr/255/docs/iroh_quinn/path/struct.ClosePath.html b/pr/255/docs/iroh_quinn/path/struct.ClosePath.html
new file mode 100644
index 000000000..56c3283bf
--- /dev/null
+++ b/pr/255/docs/iroh_quinn/path/struct.ClosePath.html
@@ -0,0 +1,11 @@
+
+
+
+
+ Redirection
+
+
+ Redirecting to ../../iroh_quinn/struct.ClosePath.html...
+
+
+
\ No newline at end of file
diff --git a/pr/255/docs/iroh_quinn/sidebar-items.js b/pr/255/docs/iroh_quinn/sidebar-items.js
index ae9bffc7f..2af1c653a 100644
--- a/pr/255/docs/iroh_quinn/sidebar-items.js
+++ b/pr/255/docs/iroh_quinn/sidebar-items.js
@@ -1 +1 @@
-window.SIDEBAR_ITEMS = {"enum":["ConfigError","ConnectError","ConnectionError","Dir","EcnCodepoint","FrameType","ReadError","ReadExactError","ReadToEndError","ResetError","SendDatagramError","Side","StoppedError","WriteError"],"fn":["default_runtime"],"mod":["congestion","crypto"],"struct":["Accept","AcceptBi","AcceptUni","AckFrequencyConfig","ApplicationClose","BloomTokenLog","Chunk","ClientConfig","ClosedStream","Connecting","Connection","ConnectionClose","ConnectionId","ConnectionStats","Endpoint","EndpointConfig","EndpointStats","FrameStats","IdleTimeout","Incoming","IncomingFuture","MtuDiscoveryConfig","NoneTokenLog","NoneTokenStore","OnClosed","OpenBi","OpenPath","OpenUni","Path","PathId","PathStats","QlogConfig","QlogFileFactory","ReadDatagram","RecvStream","RetryError","SendDatagram","SendStream","ServerConfig","SmolRuntime","StdSystemTime","StreamId","TokenMemoryCache","TokenReuseError","TokioRuntime","Transmit","TransportConfig","TransportErrorCode","UdpStats","UnorderedRecvStream","ValidationTokenConfig","VarInt","VarIntBoundsExceeded","WeakConnectionHandle","Written","ZeroRttAccepted"],"trait":["AsyncTimer","AsyncUdpSocket","ConnectionIdGenerator","QlogFactory","Runtime","TimeSource","TokenLog","TokenStore","UdpSender"]};
\ No newline at end of file
+window.SIDEBAR_ITEMS = {"enum":["ConfigError","ConnectError","ConnectionError","Dir","EcnCodepoint","FrameType","ReadError","ReadExactError","ReadToEndError","ResetError","SendDatagramError","Side","StoppedError","WriteError"],"fn":["default_runtime"],"mod":["congestion","crypto"],"struct":["Accept","AcceptBi","AcceptUni","AckFrequencyConfig","AddressDiscovery","ApplicationClose","BloomTokenLog","Chunk","ClientConfig","ClosePath","ClosedStream","Connecting","Connection","ConnectionClose","ConnectionId","ConnectionStats","Endpoint","EndpointConfig","EndpointStats","FrameStats","IdleTimeout","Incoming","IncomingFuture","InvalidCid","MtuDiscoveryConfig","NoneTokenLog","NoneTokenStore","OnClosed","OpenBi","OpenPath","OpenUni","Path","PathId","PathStats","QlogConfig","QlogFileFactory","ReadDatagram","RecvStream","RetryError","SendDatagram","SendStream","ServerConfig","SmolRuntime","StdSystemTime","StreamId","TokenMemoryCache","TokenReuseError","TokioRuntime","Transmit","TransportConfig","TransportErrorCode","UdpStats","UnorderedRecvStream","ValidationTokenConfig","VarInt","VarIntBoundsExceeded","WeakConnectionHandle","Written","ZeroRttAccepted"],"trait":["AsyncTimer","AsyncUdpSocket","ConnectionIdGenerator","QlogFactory","Runtime","TimeSource","TokenLog","TokenStore","UdpSender"]};
\ No newline at end of file
diff --git a/pr/255/docs/iroh_quinn/struct.Accept.html b/pr/255/docs/iroh_quinn/struct.Accept.html
index 6e17e11a0..896bcd39f 100644
--- a/pr/255/docs/iroh_quinn/struct.Accept.html
+++ b/pr/255/docs/iroh_quinn/struct.Accept.html
@@ -1,6 +1,6 @@
-Accept in iroh_quinn - Rust Accept
pub struct Accept<'a> { /* private fields */ }
Expand description
Future produced by Endpoint::accept
-Trait Implementations§
Source§impl<'__pin, 'a> Unpin for Accept<'a>where
+Accept in iroh_quinn - Rust Accept
pub struct Accept<'a> { /* private fields */ }
Expand description
Future produced by Endpoint::accept
+Trait Implementations§
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> BorrowMut<T> for Twhere
diff --git a/pr/255/docs/iroh_quinn/struct.AddressDiscovery.html b/pr/255/docs/iroh_quinn/struct.AddressDiscovery.html
new file mode 100644
index 000000000..5bde10466
--- /dev/null
+++ b/pr/255/docs/iroh_quinn/struct.AddressDiscovery.html
@@ -0,0 +1,173 @@
+AddressDiscovery in iroh_quinn - Rust AddressDiscovery
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.Auto Trait Implementations§
§impl Freeze for AddressDiscovery
§impl !RefUnwindSafe for AddressDiscovery
§impl Send for AddressDiscovery
§impl Sync for AddressDiscovery
§impl Unpin for AddressDiscovery
§impl !UnwindSafe for AddressDiscovery
Blanket Implementations§
Source§impl<T> BorrowMut<T> for Twhere
+ T: ?Sized,
Source§fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more§impl<T> Instrument for T
§fn instrument(self, span: Span) -> Instrumented<Self>
§fn in_current_span(self) -> Instrumented<Self>
Source§impl<T> IntoEither for T
Source§fn into_either(self, into_left: bool) -> Either<Self, Self>
Converts self into a Left variant of Either<Self, Self>
+if into_left is true.
+Converts self into a Right variant of Either<Self, Self>
+otherwise. Read moreSource§fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
Converts self into a Left variant of Either<Self, Self>
+if into_left(&self) returns true.
+Converts self into a Right variant of Either<Self, Self>
+otherwise. Read more§impl<S> StreamExt for Swhere
+ S: Stream + ?Sized,
§fn next(&mut self) -> NextFuture<'_, Self>where
+ Self: Unpin,
Retrieves the next item in the stream. Read more§fn try_next<T, E>(&mut self) -> TryNextFuture<'_, Self>
Retrieves the next item in the stream. Read more§fn count(self) -> CountFuture<Self>where
+ Self: Sized,
Counts the number of items in the stream. Read more§fn map<T, F>(self, f: F) -> Map<Self, F>
Maps items of the stream to new values using a closure. Read more§fn flat_map<U, F>(self, f: F) -> FlatMap<Self, U, F>
Maps items to streams and then concatenates them. Read more§fn flatten(self) -> Flatten<Self>where
+ Self: Sized,
+ Self::Item: Stream,
Concatenates inner streams. Read more§fn then<F, Fut>(self, f: F) -> Then<Self, F, Fut>
Maps items of the stream to new values using an async closure. Read more§fn filter_map<T, F>(self, f: F) -> FilterMap<Self, F>
Filters and maps items of the stream using a closure. Read more§fn take(self, n: usize) -> Take<Self>where
+ Self: Sized,
Takes only the first n items of the stream. Read more§fn take_while<P>(self, predicate: P) -> TakeWhile<Self, P>
§fn skip(self, n: usize) -> Skip<Self>where
+ Self: Sized,
Skips the first n items of the stream. Read more§fn skip_while<P>(self, predicate: P) -> SkipWhile<Self, P>
§fn step_by(self, step: usize) -> StepBy<Self>where
+ Self: Sized,
Yields every stepth item. Read more§fn chain<U>(self, other: U) -> Chain<Self, U>where
+ Self: Sized,
+ U: Stream<Item = Self::Item>,
Appends another stream to the end of this one. Read more§fn collect<C>(self) -> CollectFuture<Self, C>
Collects all items in the stream into a collection. Read more§fn try_collect<T, E, C>(self) -> TryCollectFuture<Self, C>
Collects all items in the fallible stream into a collection. Read more§fn partition<B, P>(self, predicate: P) -> PartitionFuture<Self, P, B>
Partitions items into those for which predicate is true and those for which it is
+false, and then collects them into two collections. Read more§fn fold<T, F>(self, init: T, f: F) -> FoldFuture<Self, F, T>
Accumulates a computation over the stream. Read more§fn try_fold<T, E, F, B>(
+ &mut self,
+ init: B,
+ f: F,
+) -> TryFoldFuture<'_, Self, F, B>
Accumulates a fallible computation over the stream. Read more§fn scan<St, B, F>(self, initial_state: St, f: F) -> Scan<Self, St, F>
Maps items of the stream to new values using a state value and a closure. Read more§fn enumerate(self) -> Enumerate<Self>where
+ Self: Sized,
Enumerates items, mapping them to (index, item). Read more§fn inspect<F>(self, f: F) -> Inspect<Self, F>
Calls a closure on each item and passes it on. Read more§fn nth(&mut self, n: usize) -> NthFuture<'_, Self>where
+ Self: Unpin,
Gets the nth item of the stream. Read more§fn last(self) -> LastFuture<Self>where
+ Self: Sized,
Returns the last item in the stream. Read more§fn for_each<F>(self, f: F) -> ForEachFuture<Self, F>
Calls a closure on each item of the stream. Read more§fn try_for_each<F, E>(&mut self, f: F) -> TryForEachFuture<'_, Self, F>
Calls a fallible closure on each item of the stream, stopping on first error. Read more§fn zip<U>(self, other: U) -> Zip<Self, U>where
+ Self: Sized,
+ U: Stream,
Zips up two streams into a single stream of pairs. Read more§fn unzip<A, B, FromA, FromB>(self) -> UnzipFuture<Self, FromA, FromB>
Collects a stream of pairs into a pair of collections. Read more§fn race<S>(self, other: S) -> Race<Self, S>where
+ Self: Sized,
+ S: Stream<Item = Self::Item>,
Merges with other stream, with no preference for either stream when both are ready. Read more§fn drain(&mut self) -> Drain<'_, Self>
Yields all immediately available values from a stream. Read more§impl<St> StreamExt for Stwhere
+ St: Stream + ?Sized,
§fn next(&mut self) -> Next<'_, Self>where
+ Self: Unpin,
Consumes and returns the next value in the stream or None if the
+stream is finished. Read more§fn try_next<T, E>(&mut self) -> TryNext<'_, Self>
Consumes and returns the next item in the stream. If an error is
+encountered before the next item, the error is returned instead. Read more§fn map<T, F>(self, f: F) -> Map<Self, F>
Maps this stream’s items to a different type, returning a new stream of
+the resulting type. Read more§fn map_while<T, F>(self, f: F) -> MapWhile<Self, F>
Map this stream’s items to a different type for as long as determined by
+the provided closure. A stream of the target type will be returned,
+which will yield elements until the closure returns None. Read more§fn then<F, Fut>(self, f: F) -> Then<Self, Fut, F>
Maps this stream’s items asynchronously to a different type, returning a
+new stream of the resulting type. Read more§fn merge<U>(self, other: U) -> Merge<Self, U>where
+ U: Stream<Item = Self::Item>,
+ Self: Sized,
Combine two streams into one by interleaving the output of both as it
+is produced. Read more§fn filter<F>(self, f: F) -> Filter<Self, F>
Filters the values produced by this stream according to the provided
+predicate. Read more§fn filter_map<T, F>(self, f: F) -> FilterMap<Self, F>
Filters the values produced by this stream while simultaneously mapping
+them to a different type according to the provided closure. Read more§fn fuse(self) -> Fuse<Self>where
+ Self: Sized,
Creates a stream which ends after the first None. Read more§fn take(self, n: usize) -> Take<Self>where
+ Self: Sized,
Creates a new stream of at most n items of the underlying stream. Read more§fn take_while<F>(self, f: F) -> TakeWhile<Self, F>
Take elements from this stream while the provided predicate
+resolves to true. Read more§fn skip(self, n: usize) -> Skip<Self>where
+ Self: Sized,
Creates a new stream that will skip the n first items of the
+underlying stream. Read more§fn skip_while<F>(self, f: F) -> SkipWhile<Self, F>
Skip elements from the underlying stream while the provided predicate
+resolves to true. Read more§fn all<F>(&mut self, f: F) -> AllFuture<'_, Self, F>
Tests if every element of the stream matches a predicate. Read more§fn any<F>(&mut self, f: F) -> AnyFuture<'_, Self, F>
Tests if any element of the stream matches a predicate. Read more§fn chain<U>(self, other: U) -> Chain<Self, U>where
+ U: Stream<Item = Self::Item>,
+ Self: Sized,
Combine two streams into one by first returning all values from the
+first stream then all values from the second stream. Read more§fn fold<B, F>(self, init: B, f: F) -> FoldFuture<Self, B, F>
A combinator that applies a function to every element in a stream
+producing a single, final value. Read more§fn collect<T>(self) -> Collect<Self, T>where
+ T: FromStream<Self::Item>,
+ Self: Sized,
Drain stream pushing all emitted values into a collection. Read more§fn timeout(self, duration: Duration) -> Timeout<Self>where
+ Self: Sized,
Applies a per-item timeout to the passed stream. Read more§fn timeout_repeating(self, interval: Interval) -> TimeoutRepeating<Self>where
+ Self: Sized,
Applies a per-item timeout to the passed stream. Read more§fn throttle(self, duration: Duration) -> Throttle<Self>where
+ Self: Sized,
Slows down a stream by enforcing a delay between items. Read more§impl<T> WithSubscriber for T
§fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>where
+ S: Into<Dispatch>,
§fn with_current_subscriber(self) -> WithDispatch<Self>
Attaches the current default Subscriber to this type, returning a
+[WithDispatch] wrapper. Read more
\ No newline at end of file
diff --git a/pr/255/docs/iroh_quinn/struct.ApplicationClose.html b/pr/255/docs/iroh_quinn/struct.ApplicationClose.html
index c6ccb9e8e..bb5b19c66 100644
--- a/pr/255/docs/iroh_quinn/struct.ApplicationClose.html
+++ b/pr/255/docs/iroh_quinn/struct.ApplicationClose.html
@@ -1,11 +1,11 @@
-ApplicationClose in iroh_quinn - Rust ApplicationClose
pub struct ApplicationClose {
+ApplicationClose in iroh_quinn - Rust ApplicationClose
pub struct ApplicationClose {
pub error_code: VarInt,
pub reason: Bytes,
}
Expand description
Reason given by an application for closing the connection
Fields§
§error_code: VarIntApplication-specific reason code
§reason: BytesHuman-readable reason for the close
-Trait Implementations§
Source§impl Clone for ApplicationClose
Source§fn clone(&self) -> ApplicationClose
Returns a duplicate of the value. Read more1.0.0 · Source§fn clone_from(&mut self, source: &Self)
Performs copy-assignment from source. Read moreSource§impl Debug for ApplicationClose
Source§impl Display for ApplicationClose
Source§impl PartialEq for ApplicationClose
Source§impl Eq for ApplicationClose
Source§impl StructuralPartialEq for ApplicationClose
Auto Trait Implementations§
§impl !Freeze for ApplicationClose
§impl RefUnwindSafe for ApplicationClose
§impl Send for ApplicationClose
§impl Sync for ApplicationClose
§impl Unpin for ApplicationClose
§impl UnwindSafe for ApplicationClose
Blanket Implementations§
Source§impl<T> Any for Twhere
+Trait Implementations§
Source§impl Clone for ApplicationClose
Source§fn clone(&self) -> ApplicationClose
Returns a duplicate of the value. Read more1.0.0 · Source§fn clone_from(&mut self, source: &Self)
Performs copy-assignment from source. Read moreSource§impl Debug for ApplicationClose
Source§impl Display for ApplicationClose
Source§impl PartialEq for ApplicationClose
Source§impl Eq for ApplicationClose
Source§impl StructuralPartialEq for ApplicationClose
Auto Trait Implementations§
§impl !Freeze for ApplicationClose
§impl RefUnwindSafe for ApplicationClose
§impl Send for ApplicationClose
§impl Sync for ApplicationClose
§impl Unpin for ApplicationClose
§impl UnwindSafe for ApplicationClose
Blanket Implementations§
Source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
Source§fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read moreSource§impl<T> CloneToUninit for Twhere
diff --git a/pr/255/docs/iroh_quinn/struct.ClientConfig.html b/pr/255/docs/iroh_quinn/struct.ClientConfig.html
index 990a35909..32e5eca5a 100644
--- a/pr/255/docs/iroh_quinn/struct.ClientConfig.html
+++ b/pr/255/docs/iroh_quinn/struct.ClientConfig.html
@@ -1,4 +1,4 @@
-ClientConfig in iroh_quinn - Rust ClientConfig
#[non_exhaustive]pub struct ClientConfig { /* private fields */ }
Expand description
Configuration for outgoing connections
+ClientConfig in iroh_quinn - Rust ClientConfig
#[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
Sourcepub fn new(crypto: Arc<dyn ClientConfig>) -> ClientConfig
Create a default config with a particular cryptographic config
Sourcepub fn initial_dst_cid_provider(
@@ -17,12 +17,11 @@ at least 8 bytes long and unpredictable, as per section 7.2 of RFC 9000.
Sourcepub fn token_store(&mut self, store: Arc<dyn TokenStore>) -> &mut ClientConfig
Set a custom TokenStore
Defaults to TokenMemoryCache, which is suitable for most internet applications.
Sourcepub fn version(&mut self, version: u32) -> &mut ClientConfig
Set the QUIC version to use
-Source§impl ClientConfig
Sourcepub fn with_platform_verifier() -> ClientConfig
👎Deprecated since 0.11.13: use try_with_platform_verifier() instead
Create a client configuration that trusts the platform’s native roots
-Sourcepub fn try_with_platform_verifier() -> Result<ClientConfig, Error>
Create a client configuration that trusts the platform’s native roots
-Sourcepub fn with_root_certificates(
+
Source§impl ClientConfig
Sourcepub fn try_with_platform_verifier() -> Result<ClientConfig, Error>
Create a client configuration that trusts the platform’s native roots
+Sourcepub fn with_root_certificates(
roots: Arc<RootCertStore>,
) -> Result<ClientConfig, VerifierBuilderError>
Create a client configuration that trusts specified trust anchors
-Trait Implementations§
Source§impl Clone for ClientConfig
Source§fn clone(&self) -> ClientConfig
Returns a duplicate of the value. Read more1.0.0 · Source§fn clone_from(&mut self, source: &Self)
Performs copy-assignment from source. Read moreAuto Trait Implementations§
§impl Freeze for ClientConfig
§impl !RefUnwindSafe for ClientConfig
§impl Send for ClientConfig
§impl Sync for ClientConfig
§impl Unpin for ClientConfig
§impl !UnwindSafe for ClientConfig
Blanket Implementations§
Trait Implementations§
Source§impl Clone for ClientConfig
Source§fn clone(&self) -> ClientConfig
Returns a duplicate of the value. Read more1.0.0 · Source§fn clone_from(&mut self, source: &Self)
Performs copy-assignment from source. Read moreAuto Trait Implementations§
§impl Freeze for ClientConfig
§impl !RefUnwindSafe for ClientConfig
§impl Send for ClientConfig
§impl Sync for ClientConfig
§impl Unpin for ClientConfig
§impl !UnwindSafe for ClientConfig
Blanket Implementations§
Source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
Source§fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read moreSource§impl<T> CloneToUninit for Twhere
diff --git a/pr/255/docs/iroh_quinn/struct.ClosePath.html b/pr/255/docs/iroh_quinn/struct.ClosePath.html
new file mode 100644
index 000000000..346435f36
--- /dev/null
+++ b/pr/255/docs/iroh_quinn/struct.ClosePath.html
@@ -0,0 +1,53 @@
+ClosePath in iroh_quinn - Rust ClosePath
pub struct ClosePath { /* private fields */ }
Expand description
Future produced by Path::close
+Trait Implementations§
Auto Trait Implementations§
§impl Freeze for ClosePath
§impl !RefUnwindSafe for ClosePath
§impl Send for ClosePath
§impl Sync for ClosePath
§impl Unpin for ClosePath
§impl !UnwindSafe for ClosePath
Blanket Implementations§
Source§impl<T> BorrowMut<T> for Twhere
+ T: ?Sized,
Source§fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more§impl<F> FutureExt for F
§fn catch_unwind(self) -> CatchUnwind<Self>where
+ Self: Sized + UnwindSafe,
Catches panics while polling the future. Read more§impl<T> FutureExt for T
§fn with_cancellation_token(
+ self,
+ cancellation_token: &CancellationToken,
+) -> WithCancellationTokenFuture<'_, Self>where
+ Self: Sized,
Similar to [CancellationToken::run_until_cancelled],
+but with the advantage that it is easier to write fluent call chains,
+and biased towards waiting for [CancellationToken] to complete. Read more§fn with_cancellation_token_owned(
+ self,
+ cancellation_token: CancellationToken,
+) -> WithCancellationTokenFutureOwned<Self>where
+ Self: Sized,
Similar to [CancellationToken::run_until_cancelled_owned],
+but with the advantage that it is easier to write fluent call chains,
+and biased towards waiting for [CancellationToken] to complete. Read more§impl<T> Instrument for T
§fn instrument(self, span: Span) -> Instrumented<Self>
§fn in_current_span(self) -> Instrumented<Self>
Source§impl<T> IntoEither for T
Source§fn into_either(self, into_left: bool) -> Either<Self, Self>
Converts self into a Left variant of Either<Self, Self>
+if into_left is true.
+Converts self into a Right variant of Either<Self, Self>
+otherwise. Read moreSource§fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
Converts self into a Left variant of Either<Self, Self>
+if into_left(&self) returns true.
+Converts self into a Right variant of Either<Self, Self>
+otherwise. Read moreSource§impl<F> IntoFuture for Fwhere
+ F: Future,
Source§type IntoFuture = F
Which kind of future are we turning this into?Source§fn into_future(self) -> <F as IntoFuture>::IntoFuture
Creates a future from a value. Read more§impl<F, T, E> TryFuture for F
§impl<T> WithSubscriber for T
§fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>where
+ S: Into<Dispatch>,
§fn with_current_subscriber(self) -> WithDispatch<Self>
Attaches the current default Subscriber to this type, returning a
+[WithDispatch] wrapper. Read more
\ No newline at end of file
diff --git a/pr/255/docs/iroh_quinn/struct.ClosedStream.html b/pr/255/docs/iroh_quinn/struct.ClosedStream.html
index c9021984a..7d402dfa5 100644
--- a/pr/255/docs/iroh_quinn/struct.ClosedStream.html
+++ b/pr/255/docs/iroh_quinn/struct.ClosedStream.html
@@ -1,5 +1,5 @@
ClosedStream in iroh_quinn - Rust ClosedStream
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 more1.0.0 · Source§fn clone_from(&mut self, source: &Self)
Performs copy-assignment from source. Read moreSource§impl Debug for ClosedStream
Source§impl Default for ClosedStream
Source§fn default() -> ClosedStream
Returns the “default value” for a type. Read moreSource§impl Display for ClosedStream
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 more1.0.0 · Source§fn description(&self) -> &str
👎Deprecated since 1.42.0: use the Display impl or to_string()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,
+Trait Implementations§
Source§impl Clone for ClosedStream
Source§fn clone(&self) -> ClosedStream
Returns a duplicate of the value. Read more1.0.0 · Source§fn clone_from(&mut self, source: &Self)
Performs copy-assignment from source. Read moreSource§impl Debug for ClosedStream
Source§impl Default for ClosedStream
Source§fn default() -> ClosedStream
Returns the “default value” for a type. Read moreSource§impl Display for ClosedStream
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 more1.0.0 · Source§fn description(&self) -> &str
👎Deprecated since 1.42.0: use the Display impl or to_string()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§impl Eq for ClosedStream
Source§impl StructuralPartialEq for ClosedStream
Auto Trait Implementations§
§impl Freeze for ClosedStream
§impl RefUnwindSafe for ClosedStream
§impl Send for ClosedStream
§impl Sync for ClosedStream
§impl Unpin for ClosedStream
§impl UnwindSafe for ClosedStream
Blanket Implementations§
Source§impl<T> BorrowMut<T> for Twhere
diff --git a/pr/255/docs/iroh_quinn/struct.ConnectionClose.html b/pr/255/docs/iroh_quinn/struct.ConnectionClose.html
index babfc951e..853926ce5 100644
--- a/pr/255/docs/iroh_quinn/struct.ConnectionClose.html
+++ b/pr/255/docs/iroh_quinn/struct.ConnectionClose.html
@@ -1,13 +1,13 @@
-ConnectionClose in iroh_quinn - Rust ConnectionClose
pub struct ConnectionClose {
+ConnectionClose in iroh_quinn - Rust ConnectionClose
pub struct ConnectionClose {
pub error_code: Code,
- pub frame_type: MaybeFrame,
+ pub frame_type: MaybeFrame,
pub reason: Bytes,
}
Expand description
Reason given by the transport for closing the connection
Fields§
§error_code: CodeClass of error as encoded in the specification
-§frame_type: MaybeFrameType of frame that caused the close
+§frame_type: MaybeFrameType of frame that caused the close
§reason: BytesHuman-readable reason for the close
-Trait Implementations§
Source§impl Clone for ConnectionClose
Source§fn clone(&self) -> ConnectionClose
Returns a duplicate of the value. Read more1.0.0 · Source§fn clone_from(&mut self, source: &Self)
Performs copy-assignment from source. Read moreSource§impl Debug for ConnectionClose
Source§impl Display for ConnectionClose
Source§impl From<Error> for ConnectionClose
Source§fn from(x: Error) -> ConnectionClose
Converts to this type from the input type.Source§impl PartialEq for ConnectionClose
Source§impl Eq for ConnectionClose
Source§impl StructuralPartialEq for ConnectionClose
Auto Trait Implementations§
§impl !Freeze for ConnectionClose
§impl RefUnwindSafe for ConnectionClose
§impl Send for ConnectionClose
§impl Sync for ConnectionClose
§impl Unpin for ConnectionClose
§impl UnwindSafe for ConnectionClose
Blanket Implementations§
Source§impl<T> Any for Twhere
+Trait Implementations§
Source§impl Clone for ConnectionClose
Source§fn clone(&self) -> ConnectionClose
Returns a duplicate of the value. Read more1.0.0 · Source§fn clone_from(&mut self, source: &Self)
Performs copy-assignment from source. Read moreSource§impl Debug for ConnectionClose
Source§impl Display for ConnectionClose
Source§impl From<Error> for ConnectionClose
Source§fn from(x: Error) -> ConnectionClose
Converts to this type from the input type.Source§impl PartialEq for ConnectionClose
Source§impl Eq for ConnectionClose
Source§impl StructuralPartialEq for ConnectionClose
Auto Trait Implementations§
§impl !Freeze for ConnectionClose
§impl RefUnwindSafe for ConnectionClose
§impl Send for ConnectionClose
§impl Sync for ConnectionClose
§impl Unpin for ConnectionClose
§impl UnwindSafe for ConnectionClose
Blanket Implementations§
Source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
Source§fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read moreSource§impl<T> CloneToUninit for Twhere
diff --git a/pr/255/docs/iroh_quinn/struct.Endpoint.html b/pr/255/docs/iroh_quinn/struct.Endpoint.html
index df16aa143..d023d3a0a 100644
--- a/pr/255/docs/iroh_quinn/struct.Endpoint.html
+++ b/pr/255/docs/iroh_quinn/struct.Endpoint.html
@@ -1,8 +1,8 @@
-Endpoint in iroh_quinn - Rust Endpoint
pub struct Endpoint { /* private fields */ }
Expand description
A QUIC endpoint.
+Endpoint in iroh_quinn - Rust Endpoint
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.
-Implementations§
Source§impl Endpoint
Sourcepub fn client(addr: SocketAddr) -> Result<Self>
Helper to construct an endpoint for use with outgoing connections only
+Implementations§
Source§impl Endpoint
Sourcepub fn client(addr: SocketAddr) -> Result<Self>
Helper to construct an endpoint for use with outgoing connections only
Note that addr is the local address to bind to, which should usually be a wildcard
address like 0.0.0.0:0 or [::]:0, which allow communication with any reachable IPv4 or
IPv6 address respectively from an OS-assigned port.
@@ -14,19 +14,19 @@ address. For example:
iroh_quinn::Endpoint::client((std::net::Ipv6Addr::UNSPECIFIED, 0).into());
Some environments may not allow creation of dual-stack sockets, in which case an IPv6
client will only be able to connect to IPv6 servers. An IPv4 client is never dual-stack.
-Sourcepub fn stats(&self) -> EndpointStats
Returns relevant stats from this Endpoint
-Sourcepub fn server(config: ServerConfig, addr: SocketAddr) -> Result<Self>
Helper to construct an endpoint for use with both incoming and outgoing connections
+Sourcepub fn stats(&self) -> EndpointStats
Returns relevant stats from this Endpoint
+Sourcepub fn server(config: ServerConfig, addr: SocketAddr) -> Result<Self>
Helper to construct an endpoint for use with both incoming and outgoing connections
Platform defaults for dual-stack sockets vary. For example, any socket bound to a wildcard
IPv6 address on Windows will not by default be able to communicate with IPv4
addresses. Portable applications should bind an address that matches the family they wish to
communicate within.
-Sourcepub fn new(
config: EndpointConfig,
server_config: Option<ServerConfig>,
socket: UdpSocket,
runtime: Arc<dyn Runtime>,
) -> Result<Self>
Construct an endpoint with arbitrary configuration and socket
-Sourcepub fn new_with_abstract_socket(
+
Sourcepub fn new_with_abstract_socket(
config: EndpointConfig,
server_config: Option<ServerConfig>,
socket: Box<dyn AsyncUdpSocket>,
@@ -34,13 +34,13 @@ communicate within.
) -> Result<Self>
Construct an endpoint with arbitrary configuration and pre-constructed abstract socket
Useful when socket has additional state (e.g. sidechannels) attached for which shared
ownership is needed.
-Sourcepub fn accept(&self) -> Accept<'_> ⓘ
Get the next incoming connection attempt from a client
Yields Incomings, or None if the endpoint is closed. Incoming
can be awaited to obtain the final Connection, or used to e.g.
filter connection attempts or force address validation, or converted into an intermediate
Connecting future which can be used to e.g. send 0.5-RTT data.
-Sourcepub fn set_default_client_config(&mut self, config: ClientConfig)
Set the client configuration used by connect
-Sourcepub fn set_default_client_config(&self, config: ClientConfig)
Set the client configuration used by connect
+Sourcepub fn connect(
&self,
addr: SocketAddr,
server_name: &str,
@@ -50,26 +50,26 @@ connection from being intercepted by an attacker with a valid certificate for so
server.
May fail immediately due to configuration errors, or in the future if the connection could
not be established.
-
Sourcepub fn connect_with(
+
Sourcepub fn connect_with(
&self,
config: ClientConfig,
addr: SocketAddr,
server_name: &str,
) -> Result<Connecting, ConnectError>
Connect to a remote endpoint using a custom configuration.
See connect() for details.
-Sourcepub fn rebind(&self, socket: UdpSocket) -> Result<()>
Switch to a new UDP socket
See Endpoint::rebind_abstract() for details.
-Sourcepub fn rebind_abstract(&self, socket: Box<dyn AsyncUdpSocket>) -> Result<()>
Switch to a new UDP socket
+Sourcepub fn rebind_abstract(&self, socket: Box<dyn AsyncUdpSocket>) -> Result<()>
Switch to a new UDP socket
Allows the endpoint’s address to be updated live, affecting all active connections. Incoming
connections and connections to servers unreachable from the new address will be lost.
On error, the old UDP socket is retained.
-Sourcepub fn set_server_config(&self, server_config: Option<ServerConfig>)
Replace the server configuration, affecting new incoming connections only
+Sourcepub fn set_server_config(&self, server_config: Option<ServerConfig>)
Replace the server configuration, affecting new incoming connections only
Useful for e.g. refreshing TLS certificates without disrupting existing connections.
-Sourcepub fn local_addr(&self) -> Result<SocketAddr>
Get the local SocketAddr the underlying socket is bound to
-Sourcepub fn open_connections(&self) -> usize
Get the number of connections that are currently open
-Sourcepub fn close(&self, error_code: VarInt, reason: &[u8])
Close all of this endpoint’s connections immediately and cease accepting new connections.
+Sourcepub fn local_addr(&self) -> Result<SocketAddr>
Get the local SocketAddr the underlying socket is bound to
+Sourcepub fn open_connections(&self) -> usize
Get the number of connections that are currently open
+Sourcepub fn close(&self, error_code: VarInt, reason: &[u8])
Close all of this endpoint’s connections immediately and cease accepting new connections.
See Connection::close() for details.
-Sourcepub async fn wait_idle(&self)
Wait for all connections on the endpoint to be cleanly shut down
+Sourcepub async fn wait_idle(&self)
Wait for all connections on the endpoint to be cleanly shut down
Waiting for this condition before exiting ensures that a good-faith effort is made to notify
peers of recent connection closes, whereas exiting immediately could force them to wait out
the idle timeout period.
diff --git a/pr/255/docs/iroh_quinn/struct.EndpointStats.html b/pr/255/docs/iroh_quinn/struct.EndpointStats.html
index 4500b994a..efaa12c4b 100644
--- a/pr/255/docs/iroh_quinn/struct.EndpointStats.html
+++ b/pr/255/docs/iroh_quinn/struct.EndpointStats.html
@@ -1,4 +1,4 @@
-EndpointStats in iroh_quinn - Rust EndpointStats
#[non_exhaustive]pub struct EndpointStats {
+EndpointStats in iroh_quinn - Rust EndpointStats
#[non_exhaustive]pub struct EndpointStats {
pub accepted_handshakes: u64,
pub outgoing_handshakes: u64,
pub refused_handshakes: u64,
@@ -8,7 +8,7 @@
§outgoing_handshakes: u64Cumulative number of Quic handshakes sent from this Endpoint
§refused_handshakes: u64Cumulative number of Quic handshakes refused on this Endpoint
§ignored_handshakes: u64Cumulative number of Quic handshakes ignored on this Endpoint
-Trait Implementations§
Source§impl Clone for EndpointStats
Source§fn clone(&self) -> EndpointStats
Returns a duplicate of the value. Read more1.0.0 · Source§fn clone_from(&mut self, source: &Self)
Performs copy-assignment from source. Read moreSource§impl Debug for EndpointStats
Source§impl Default for EndpointStats
Source§fn default() -> EndpointStats
Returns the “default value” for a type. Read moreSource§impl Copy for EndpointStats
Auto Trait Implementations§
§impl Freeze for EndpointStats
§impl RefUnwindSafe for EndpointStats
§impl Send for EndpointStats
§impl Sync for EndpointStats
§impl Unpin for EndpointStats
§impl UnwindSafe for EndpointStats
Blanket Implementations§
Source§impl<T> Any for Twhere
+Trait Implementations§
Source§impl Clone for EndpointStats
Source§fn clone(&self) -> EndpointStats
Returns a duplicate of the value. Read more1.0.0 · Source§fn clone_from(&mut self, source: &Self)
Performs copy-assignment from source. Read moreSource§impl Debug for EndpointStats
Source§impl Default for EndpointStats
Source§fn default() -> EndpointStats
Returns the “default value” for a type. Read moreSource§impl Copy for EndpointStats
Auto Trait Implementations§
§impl Freeze for EndpointStats
§impl RefUnwindSafe for EndpointStats
§impl Send for EndpointStats
§impl Sync for EndpointStats
§impl Unpin for EndpointStats
§impl UnwindSafe for EndpointStats
Blanket Implementations§
Source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
Source§fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read moreSource§impl<T> CloneToUninit for Twhere
diff --git a/pr/255/docs/iroh_quinn/struct.InvalidCid.html b/pr/255/docs/iroh_quinn/struct.InvalidCid.html
new file mode 100644
index 000000000..8cc09d0a5
--- /dev/null
+++ b/pr/255/docs/iroh_quinn/struct.InvalidCid.html
@@ -0,0 +1,27 @@
+InvalidCid in iroh_quinn - Rust InvalidCid
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 more1.0.0 · Source§fn clone_from(&mut self, source: &Self)
Performs copy-assignment from source. Read moreSource§impl Debug for InvalidCid
Source§impl Copy for InvalidCid
Auto Trait Implementations§
§impl Freeze for InvalidCid
§impl RefUnwindSafe for InvalidCid
§impl Send for InvalidCid
§impl Sync for InvalidCid
§impl Unpin for InvalidCid
§impl UnwindSafe for InvalidCid
Blanket Implementations§
Source§impl<T> BorrowMut<T> for Twhere
+ T: ?Sized,
Source§fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read moreSource§impl<T> CloneToUninit for Twhere
+ T: Clone,
§impl<T> Instrument for T
§fn instrument(self, span: Span) -> Instrumented<Self>
§fn in_current_span(self) -> Instrumented<Self>
Source§impl<T> IntoEither for T
Source§fn into_either(self, into_left: bool) -> Either<Self, Self>
Converts self into a Left variant of Either<Self, Self>
+if into_left is true.
+Converts self into a Right variant of Either<Self, Self>
+otherwise. Read moreSource§fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
Converts self into a Left variant of Either<Self, Self>
+if into_left(&self) returns true.
+Converts self into a Right variant of Either<Self, Self>
+otherwise. Read more§impl<T> WithSubscriber for T
§fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>where
+ S: Into<Dispatch>,
§fn with_current_subscriber(self) -> WithDispatch<Self>
Attaches the current default Subscriber to this type, returning a
+[WithDispatch] wrapper. Read more
\ No newline at end of file
diff --git a/pr/255/docs/iroh_quinn/struct.Path.html b/pr/255/docs/iroh_quinn/struct.Path.html
index 5602610f3..e00724478 100644
--- a/pr/255/docs/iroh_quinn/struct.Path.html
+++ b/pr/255/docs/iroh_quinn/struct.Path.html
@@ -2,7 +2,7 @@
Implementations§
Source§impl Path
Sourcepub fn status(&self) -> Result<PathStatus, ClosedPath>
The current local PathStatus of this path.
Sourcepub fn set_status(&self, status: PathStatus) -> Result<(), SetPathStatusError>
Sets the PathStatus of this path.
-Sourcepub fn close(&self) -> Result<ClosePath, ClosePathError>
Closes this path
+Sourcepub fn close(&self) -> Result<ClosePath, ClosePathError>
Closes this path
The future will resolve when all the path state is dropped. This only happens after
the remote has confirmed the path as closed and after an additional timeout to
give any in-flight packets the time to arrive.
@@ -18,7 +18,7 @@ give any in-flight packets the time to arrive.
) -> Result<Option<Duration>, ClosedPath>Sets the keep_alive_interval for a specific path
See TransportConfig::default_path_keep_alive_interval for details.
Returns the previous value of the setting.
-Sourcepub fn observed_external_addr(&self) -> Result<AddressDiscovery, ClosedPath>
Track changes on our external address as reported by the peer.
+Sourcepub fn observed_external_addr(&self) -> Result<AddressDiscovery, ClosedPath>
Track changes on our external address as reported by the peer.
If the address-discovery extension is not negotiated, the stream will never return.
Sourcepub fn remote_address(&self) -> Result<SocketAddr, ClosedPath>
The peer’s UDP address for this path.
Sourcepub fn ping(&self) -> Result<(), ClosedPath>
Ping the remote endpoint over this path.
diff --git a/pr/255/docs/iroh_quinn/struct.SendStream.html b/pr/255/docs/iroh_quinn/struct.SendStream.html
index 069c8def7..0ec06cb61 100644
--- a/pr/255/docs/iroh_quinn/struct.SendStream.html
+++ b/pr/255/docs/iroh_quinn/struct.SendStream.html
@@ -8,7 +8,7 @@ ready will always result in no data being written to the stream. This is true of
succeed immediately when any progress is made, and is not true of methods which might need to
perform multiple writes internally before succeeding. Each write method documents whether it is
cancel-safe.
-Implementations§
Source§impl SendStream
Sourcepub async fn write(&mut self, buf: &[u8]) -> Result<usize, WriteError>
Write a buffer into this stream, returning how many bytes were written
+Implementations§
Source§impl SendStream
Sourcepub async fn write(&mut self, buf: &[u8]) -> Result<usize, WriteError>
Write a buffer into this stream, returning how many bytes were written
Unless this method errors, it waits until some amount of buf can be written into this
stream, and then writes as much as it can without waiting again. Due to congestion and flow
control, this may be shorter than buf.len(). On success this yields the length of the
@@ -58,7 +58,7 @@ or an error occurs. This method mutates bufs by mutating all chunks
§Cancel safety
This method is not cancellation safe. Even if this does not resolve, some bytes may have
been written when previously polled.
-Sourcepub fn finish(&mut self) -> Result<(), ClosedStream>
Notify the peer that no more data will ever be written to this stream
+Sourcepub fn finish(&mut self) -> Result<(), ClosedStream>
Notify the peer that no more data will ever be written to this stream
It is an error to write to a SendStream after finish()ing it. reset()
may still be called after finish to abandon transmission of any stream data that might
still be buffered.
@@ -66,21 +66,21 @@ still be buffered.
May fail if finish() or reset() was previously
called. This error is harmless and serves only to indicate that the caller may have
incorrect assumptions about the stream’s state.
-Sourcepub fn reset(&mut self, error_code: VarInt) -> Result<(), ClosedStream>
Close the send stream immediately.
+Sourcepub fn reset(&mut self, error_code: VarInt) -> Result<(), ClosedStream>
Close the send stream immediately.
No new data can be written after calling this method. Locally buffered data is dropped, and
previously transmitted data will no longer be retransmitted if lost. If an attempt has
already been made to finish the stream, the peer may still receive all written data.
May fail if finish() or reset() was previously
called. This error is harmless and serves only to indicate that the caller may have
incorrect assumptions about the stream’s state.
-Sourcepub fn set_priority(&self, priority: i32) -> Result<(), ClosedStream>
Set the priority of the send stream
+Sourcepub fn set_priority(&self, priority: i32) -> Result<(), ClosedStream>
Set the priority of the send stream
Every send stream has an initial priority of 0. Locally buffered data from streams with
higher priority will be transmitted before data from streams with lower priority. Changing
the priority of a stream with pending data may only take effect after that data has been
transmitted. Using many different priority levels per connection may have a negative
impact on performance.
-Sourcepub fn priority(&self) -> Result<i32, ClosedStream>
Get the priority of the send stream
-Sourcepub fn priority(&self) -> Result<i32, ClosedStream>
Get the priority of the send stream
+Sourcepub fn stopped(
&self,
) -> impl Future<Output = Result<Option<VarInt>, StoppedError>> + Send + Sync + 'static
Completes when the peer stops the stream or reads the stream to completion
Yields Some with the stop error code if the peer stops the stream. Yields None if the
@@ -90,8 +90,8 @@ closing the stream is no longer meaningful.
For a variety of reasons, the peer may not send acknowledgements immediately upon receiving
data. As such, relying on stopped to know when the peer has read a stream to completion
may introduce more latency than using an application-level response of some sort.
-Sourcepub fn poll_write(
+
Sourcepub fn poll_write(
self: Pin<&mut Self>,
cx: &mut Context<'_>,
buf: &[u8],
@@ -100,22 +100,22 @@ may introduce more latency than using an application-level response of some sort
If the stream is not ready for writing, the method returns Poll::Pending and arranges
for the current task (via cx.waker().wake_by_ref()) to receive a notification when the
stream becomes writable or is closed.
-
Trait Implementations§
Source§impl AsyncWrite for SendStream
Available on crate feature futures-io only.
Source§fn poll_write(
+
Trait Implementations§
Source§impl AsyncWrite for SendStream
Available on crate feature futures-io only.
Source§fn poll_write(
self: Pin<&mut Self>,
cx: &mut Context<'_>,
buf: &[u8],
-) -> Poll<Result<usize>>
Attempt to write bytes from buf into the object. Read moreSource§fn poll_flush(self: Pin<&mut Self>, _cx: &mut Context<'_>) -> Poll<Result<()>>
Attempt to flush the object, ensuring that any buffered data reach
-their destination. Read moreSource§fn poll_close(self: Pin<&mut Self>, _cx: &mut Context<'_>) -> Poll<Result<()>>
Attempt to close the object. Read more§fn poll_write_vectored(
+) -> Poll<Result<usize>>
Attempt to write bytes from buf into the object. Read moreSource§fn poll_flush(self: Pin<&mut Self>, _cx: &mut Context<'_>) -> Poll<Result<()>>
Attempt to flush the object, ensuring that any buffered data reach
+their destination. Read moreSource§impl AsyncWrite for SendStream
Source§fn poll_write(
+IO operations. Read more
Source§impl AsyncWrite for SendStream
Source§fn poll_write(
self: Pin<&mut Self>,
cx: &mut Context<'_>,
buf: &[u8],
-) -> Poll<Result<usize>>
Attempt to write bytes from buf into the object. Read moreSource§fn poll_flush(self: Pin<&mut Self>, _cx: &mut Context<'_>) -> Poll<Result<()>>
Attempts to flush the object, ensuring that any buffered data reach
-their destination. Read moreSource§fn poll_shutdown(
+) -> Poll<Result<usize>>
Attempt to write bytes from buf into the object. Read moreSource§fn poll_flush(self: Pin<&mut Self>, _cx: &mut Context<'_>) -> Poll<Result<()>>
Attempts to flush the object, ensuring that any buffered data reach
+their destination. Read moreSource§fn poll_shutdown(
self: Pin<&mut Self>,
_cx: &mut Context<'_>,
) -> Poll<Result<()>>
Initiates or attempts to shut down this writer, returning success when
@@ -124,7 +124,7 @@ the I/O connection has completely shut down. Read moreContext<'_>,
bufs: &[IoSlice<'_>],
) -> Poll<Result<usize, Error>>Like poll_write, except that it writes from a slice of buffers. Read more§fn is_write_vectored(&self) -> bool
Determines if this writer has an efficient poll_write_vectored
-implementation. Read more Source§impl Debug for SendStream
Auto Trait Implementations§
§impl Freeze for SendStream
§impl RefUnwindSafe for SendStream
§impl Send for SendStream
§impl Sync for SendStream
§impl Unpin for SendStream
§impl UnwindSafe for SendStream
Blanket Implementations§
Source§impl Debug for SendStream
Auto Trait Implementations§
§impl Freeze for SendStream
§impl RefUnwindSafe for SendStream
§impl Send for SendStream
§impl Sync for SendStream
§impl Unpin for SendStream
§impl UnwindSafe for SendStream
Blanket Implementations§
§impl<W> AsyncWriteExt for Wwhere
W: AsyncWrite + ?Sized,
§fn write<'a>(&'a mut self, src: &'a [u8]) -> Write<'a, Self>where
Self: Unpin,
Writes a buffer into this writer, returning how many bytes were
diff --git a/pr/255/docs/iroh_quinn/struct.StdSystemTime.html b/pr/255/docs/iroh_quinn/struct.StdSystemTime.html
index 601433e0b..75e3b81a5 100644
--- a/pr/255/docs/iroh_quinn/struct.StdSystemTime.html
+++ b/pr/255/docs/iroh_quinn/struct.StdSystemTime.html
@@ -1,6 +1,6 @@
-StdSystemTime in iroh_quinn - Rust StdSystemTime
pub struct StdSystemTime;
Expand description
Default implementation of TimeSource
+StdSystemTime in iroh_quinn - Rust StdSystemTime
pub struct StdSystemTime;
Expand description
Default implementation of TimeSource
Implements now by calling SystemTime::now().
-Trait Implementations§
Source§impl TimeSource for StdSystemTime
Source§fn now(&self) -> SystemTime
Get SystemTime::now() or the mocked equivalentAuto Trait Implementations§
§impl Freeze for StdSystemTime
§impl RefUnwindSafe for StdSystemTime
§impl Send for StdSystemTime
§impl Sync for StdSystemTime
§impl Unpin for StdSystemTime
§impl UnwindSafe for StdSystemTime
Blanket Implementations§
Trait Implementations§
Source§impl TimeSource for StdSystemTime
Source§fn now(&self) -> SystemTime
Get SystemTime::now() or the mocked equivalentAuto Trait Implementations§
§impl Freeze for StdSystemTime
§impl RefUnwindSafe for StdSystemTime
§impl Send for StdSystemTime
§impl Sync for StdSystemTime
§impl Unpin for StdSystemTime
§impl UnwindSafe for StdSystemTime
Blanket Implementations§
Source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
Source§fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read moreSource§impl<T> From<T> for T
Source§fn from(t: T) -> T
Returns the argument unchanged.
diff --git a/pr/255/docs/iroh_quinn/struct.StreamId.html b/pr/255/docs/iroh_quinn/struct.StreamId.html
index 7d288c046..cd7352208 100644
--- a/pr/255/docs/iroh_quinn/struct.StreamId.html
+++ b/pr/255/docs/iroh_quinn/struct.StreamId.html
@@ -1,26 +1,26 @@
-StreamId in iroh_quinn - Rust StreamId
pub struct StreamId(/* private fields */);
Expand description
Identifier for a stream within a particular connection
-Implementations§
Trait Implementations§
Source§impl<'arbitrary> Arbitrary<'arbitrary> for StreamId
Source§fn arbitrary(u: &mut Unstructured<'arbitrary>) -> Result<StreamId, Error>
Generate an arbitrary value of Self from the given unstructured data. Read moreSource§fn arbitrary_take_rest(u: Unstructured<'arbitrary>) -> Result<StreamId, Error>
Generate an arbitrary value of Self from the entirety of the given
-unstructured data. Read moreSource§fn size_hint(depth: usize) -> (usize, Option<usize>)
Get a size hint for how many bytes out of an Unstructured this type
-needs to construct itself. Read moreSource§fn try_size_hint(
+StreamId in iroh_quinn - Rust StreamId
pub struct StreamId(/* private fields */);
Expand description
Identifier for a stream within a particular connection
+Implementations§
Trait Implementations§
Source§impl<'arbitrary> Arbitrary<'arbitrary> for StreamId
Source§fn arbitrary(u: &mut Unstructured<'arbitrary>) -> Result<StreamId, Error>
Generate an arbitrary value of Self from the given unstructured data. Read moreSource§fn arbitrary_take_rest(u: Unstructured<'arbitrary>) -> Result<StreamId, Error>
Generate an arbitrary value of Self from the entirety of the given
+unstructured data. Read moreSource§impl Ord for StreamId
Source§impl PartialOrd for StreamId
Source§impl PartialOrd for StreamId
Source§impl Copy for StreamId
Source§impl Eq for StreamId
Source§impl StructuralPartialEq for StreamId
Auto Trait Implementations§
§impl Freeze for StreamId
§impl RefUnwindSafe for StreamId
§impl Send for StreamId
§impl Sync for StreamId
§impl Unpin for StreamId
§impl UnwindSafe for StreamId
Blanket Implementations§
Source§impl Copy for StreamId
Source§impl Eq for StreamId
Source§impl StructuralPartialEq for StreamId
Auto Trait Implementations§
§impl Freeze for StreamId
§impl RefUnwindSafe for StreamId
§impl Send for StreamId
§impl Sync for StreamId
§impl Unpin for StreamId
§impl UnwindSafe for StreamId
Blanket Implementations§
Source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
Source§fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read moreSource§impl<T> CloneToUninit for Twhere
diff --git a/pr/255/docs/iroh_quinn/struct.Transmit.html b/pr/255/docs/iroh_quinn/struct.Transmit.html
index c36db78b0..10970ac6e 100644
--- a/pr/255/docs/iroh_quinn/struct.Transmit.html
+++ b/pr/255/docs/iroh_quinn/struct.Transmit.html
@@ -1,4 +1,4 @@
-Transmit in iroh_quinn - Rust Transmit
pub struct Transmit {
+Transmit in iroh_quinn - Rust Transmit
pub struct Transmit {
pub destination: SocketAddr,
pub ecn: Option<EcnCodepoint>,
pub size: usize,
@@ -11,7 +11,7 @@
§segment_size: Option<usize>The segment size if this transmission contains multiple datagrams.
This is None if the transmit only contains a single datagram
§src_ip: Option<IpAddr>Optional source IP address for the datagram
-Trait Implementations§
impl<T> Any for Twhere
+}Fields§
§upload_stats: Stats§download_stats: StatsImplementations§
Trait Implementations§
Source§impl Default for ClientStats
Source§fn default() -> ClientStats
Returns the “default value” for a type. Read moreAuto Trait Implementations§
§impl Freeze for ClientStats
§impl RefUnwindSafe for ClientStats
§impl Send for ClientStats
§impl Sync for ClientStats
§impl Unpin for ClientStats
§impl UnwindSafe for ClientStats
Blanket Implementations§
Source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
Source§fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read moreSource§impl<T> From<T> for T
Source§fn from(t: T) -> T
Returns the argument unchanged.
diff --git a/pr/255/docs/iroh_quinn/all.html b/pr/255/docs/iroh_quinn/all.html
index 9efe65aca..4ca955f58 100644
--- a/pr/255/docs/iroh_quinn/all.html
+++ b/pr/255/docs/iroh_quinn/all.html
@@ -1 +1 @@
-List of all items in this crate All
List of all items
Structs
- Accept
- AcceptBi
- AcceptUni
- AckFrequencyConfig
- ApplicationClose
- BloomTokenLog
- Chunk
- ClientConfig
- ClosedStream
- Connecting
- Connection
- ConnectionClose
- ConnectionId
- ConnectionStats
- Endpoint
- EndpointConfig
- EndpointStats
- FrameStats
- IdleTimeout
- Incoming
- IncomingFuture
- MtuDiscoveryConfig
- NoneTokenLog
- NoneTokenStore
- OnClosed
- OpenBi
- OpenPath
- OpenUni
- Path
- PathId
- PathStats
- QlogConfig
- QlogFileFactory
- ReadDatagram
- RecvStream
- RetryError
- SendDatagram
- SendStream
- ServerConfig
- SmolRuntime
- StdSystemTime
- StreamId
- TokenMemoryCache
- TokenReuseError
- TokioRuntime
- Transmit
- TransportConfig
- TransportErrorCode
- UdpStats
- UnorderedRecvStream
- ValidationTokenConfig
- VarInt
- VarIntBoundsExceeded
- WeakConnectionHandle
- Written
- ZeroRttAccepted
- congestion::Bbr
- congestion::BbrConfig
- congestion::ControllerMetrics
- congestion::Cubic
- congestion::CubicConfig
- congestion::NewReno
- congestion::NewRenoConfig
- crypto::CryptoError
- crypto::ExportKeyingMaterialError
- crypto::KeyPair
- crypto::Keys
- crypto::UnsupportedVersion
- crypto::rustls::HandshakeData
- crypto::rustls::NoInitialCipherSuite
- crypto::rustls::QuicClientConfig
- crypto::rustls::QuicServerConfig
- crypto::rustls::TlsSession
Enums
- ConfigError
- ConnectError
- ConnectionError
- Dir
- EcnCodepoint
- FrameType
- ReadError
- ReadExactError
- ReadToEndError
- ResetError
- SendDatagramError
- Side
- StoppedError
- WriteError
- crypto::rustls::Error
Traits
- AsyncTimer
- AsyncUdpSocket
- ConnectionIdGenerator
- QlogFactory
- Runtime
- TimeSource
- TokenLog
- TokenStore
- UdpSender
- congestion::Controller
- congestion::ControllerFactory
- crypto::AeadKey
- crypto::ClientConfig
- crypto::HandshakeTokenKey
- crypto::HeaderKey
- crypto::HmacKey
- crypto::PacketKey
- crypto::ServerConfig
- crypto::Session
Functions
\ No newline at end of file
+List of all items in this crate All
List of all items
Structs
- Accept
- AcceptBi
- AcceptUni
- AckFrequencyConfig
- AddressDiscovery
- ApplicationClose
- BloomTokenLog
- Chunk
- ClientConfig
- ClosePath
- ClosedStream
- Connecting
- Connection
- ConnectionClose
- ConnectionId
- ConnectionStats
- Endpoint
- EndpointConfig
- EndpointStats
- FrameStats
- IdleTimeout
- Incoming
- IncomingFuture
- InvalidCid
- MtuDiscoveryConfig
- NoneTokenLog
- NoneTokenStore
- OnClosed
- OpenBi
- OpenPath
- OpenUni
- Path
- PathId
- PathStats
- QlogConfig
- QlogFileFactory
- ReadDatagram
- RecvStream
- RetryError
- SendDatagram
- SendStream
- ServerConfig
- SmolRuntime
- StdSystemTime
- StreamId
- TokenMemoryCache
- TokenReuseError
- TokioRuntime
- Transmit
- TransportConfig
- TransportErrorCode
- UdpStats
- UnorderedRecvStream
- ValidationTokenConfig
- VarInt
- VarIntBoundsExceeded
- WeakConnectionHandle
- Written
- ZeroRttAccepted
- congestion::Bbr
- congestion::BbrConfig
- congestion::ControllerMetrics
- congestion::Cubic
- congestion::CubicConfig
- congestion::NewReno
- congestion::NewRenoConfig
- crypto::CryptoError
- crypto::ExportKeyingMaterialError
- crypto::KeyPair
- crypto::Keys
- crypto::UnsupportedVersion
- crypto::rustls::HandshakeData
- crypto::rustls::NoInitialCipherSuite
- crypto::rustls::QuicClientConfig
- crypto::rustls::QuicServerConfig
- crypto::rustls::TlsSession
Enums
- ConfigError
- ConnectError
- ConnectionError
- Dir
- EcnCodepoint
- FrameType
- ReadError
- ReadExactError
- ReadToEndError
- ResetError
- SendDatagramError
- Side
- StoppedError
- WriteError
- crypto::rustls::Error
Traits
- AsyncTimer
- AsyncUdpSocket
- ConnectionIdGenerator
- QlogFactory
- Runtime
- TimeSource
- TokenLog
- TokenStore
- UdpSender
- congestion::Controller
- congestion::ControllerFactory
- crypto::AeadKey
- crypto::ClientConfig
- crypto::HandshakeTokenKey
- crypto::HeaderKey
- crypto::HmacKey
- crypto::PacketKey
- crypto::ServerConfig
- crypto::Session
Functions
\ No newline at end of file
diff --git a/pr/255/docs/iroh_quinn/congestion/index.html b/pr/255/docs/iroh_quinn/congestion/index.html
index 2216af227..8873423fc 100644
--- a/pr/255/docs/iroh_quinn/congestion/index.html
+++ b/pr/255/docs/iroh_quinn/congestion/index.html
@@ -1,2 +1,2 @@
-iroh_quinn::congestion - Rust Module congestion
Expand description
Logic for controlling the rate at which data is sent
+iroh_quinn::congestion - Rust Module congestion
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 - Controller
Metrics - Common congestion controller metrics
- Cubic
- The RFC8312 congestion controller, as widely used for TCP
- Cubic
Config - Configuration for the
Cubic congestion controller - NewReno
- A simple, standard congestion controller
- NewReno
Config - Configuration for the
NewReno congestion controller
Traits§
- Controller
- Common interface for different congestion controllers
- Controller
Factory - Constructs controllers on demand
\ No newline at end of file
diff --git a/pr/255/docs/iroh_quinn/congestion/struct.Bbr.html b/pr/255/docs/iroh_quinn/congestion/struct.Bbr.html
index 630fc0fa4..a2f2eaedc 100644
--- a/pr/255/docs/iroh_quinn/congestion/struct.Bbr.html
+++ b/pr/255/docs/iroh_quinn/congestion/struct.Bbr.html
@@ -4,27 +4,27 @@ Based on google’s quiche implementation https://datatracker.ietf.org/doc/html/draft-cardwell-iccrg-bbr-congestion-control.
More discussion and links at https://groups.google.com/g/bbr-dev.
Implementations§
Trait Implementations§
Trait Implementations§
Source§impl Controller for Bbr
Source§fn on_sent(&mut self, now: Instant, bytes: u64, last_packet_number: u64)
One or more packets were just sentSource§fn on_ack(
&mut self,
now: Instant,
sent: Instant,
bytes: u64,
app_limited: bool,
rtt: &RttEstimator,
-)
Packet deliveries were confirmed Read moreSource§fn on_end_acks(
+)
Packet deliveries were confirmed Read moreSource§fn on_end_acks(
&mut self,
now: Instant,
in_flight: u64,
app_limited: bool,
largest_packet_num_acked: Option<u64>,
-)
Packets are acked in batches, all with the same now argument. This indicates one of those batches has completed.Source§fn on_congestion_event(
+)
Packets are acked in batches, all with the same now argument. This indicates one of those batches has completed.Source§fn on_congestion_event(
&mut self,
_now: Instant,
_sent: Instant,
_is_persistent_congestion: bool,
_is_ecn: bool,
lost_bytes: u64,
-)
Packets were deemed lost or marked congested Read moreSource§fn on_mtu_update(&mut self, new_mtu: u16)
The known MTU for the current network path has been updatedSource§fn metrics(&self) -> ControllerMetrics
Retrieve implementation-specific metrics used to populate qlog traces when they are enabledSource§fn clone_box(&self) -> Box<dyn Controller>
Duplicate the controller’s stateSource§fn initial_window(&self) -> u64
Initial congestion windowSource§fn into_any(self: Box<Bbr>) -> Box<dyn Any>
Returns Self for use in down-casting to extract implementation detailsSource§fn on_spurious_congestion_event(&mut self)
Packets were incorrectly deemed lost Read moreAuto Trait Implementations§
§impl Freeze for Bbr
§impl RefUnwindSafe for Bbr
§impl Send for Bbr
§impl Sync for Bbr
§impl Unpin for Bbr
§impl UnwindSafe for Bbr
Blanket Implementations§
Source§impl<T> Any for Twhere
+)Packets were deemed lost or marked congested Read moreSource§fn on_mtu_update(&mut self, new_mtu: u16)
The known MTU for the current network path has been updatedSource§fn metrics(&self) -> ControllerMetrics
Retrieve implementation-specific metrics used to populate qlog traces when they are enabledSource§fn clone_box(&self) -> Box<dyn Controller>
Duplicate the controller’s stateSource§fn initial_window(&self) -> u64
Initial congestion windowSource§fn into_any(self: Box<Bbr>) -> Box<dyn Any>
Returns Self for use in down-casting to extract implementation detailsSource§fn on_spurious_congestion_event(&mut self)
Packets were incorrectly deemed lost Read more
Auto Trait Implementations§
§impl Freeze for Bbr
§impl RefUnwindSafe for Bbr
§impl Send for Bbr
§impl Sync for Bbr
§impl Unpin for Bbr
§impl UnwindSafe for Bbr
Blanket Implementations§
Source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
Source§fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read moreSource§impl<T> CloneToUninit for Twhere
diff --git a/pr/255/docs/iroh_quinn/congestion/struct.BbrConfig.html b/pr/255/docs/iroh_quinn/congestion/struct.BbrConfig.html
index f340fb3e2..c931fff20 100644
--- a/pr/255/docs/iroh_quinn/congestion/struct.BbrConfig.html
+++ b/pr/255/docs/iroh_quinn/congestion/struct.BbrConfig.html
@@ -1,11 +1,11 @@
-BbrConfig in iroh_quinn::congestion - Rust BbrConfig
pub struct BbrConfig { /* private fields */ }
Expand description
Configuration for the Bbr congestion controller
-Implementations§
Source§impl BbrConfig
Sourcepub fn initial_window(&mut self, value: u64) -> &mut BbrConfig
Default limit on the amount of outstanding data in bytes.
+BbrConfig in iroh_quinn::congestion - Rust BbrConfig
pub struct BbrConfig { /* private fields */ }
Expand description
Configuration for the Bbr congestion controller
+Implementations§
Trait Implementations§
Trait Implementations§
Source§impl ControllerFactory for BbrConfig
Auto Trait Implementations§
§impl Freeze for BbrConfig
§impl RefUnwindSafe for BbrConfig
§impl Send for BbrConfig
§impl Sync for BbrConfig
§impl Unpin for BbrConfig
§impl UnwindSafe for BbrConfig
Blanket Implementations§
Auto Trait Implementations§
§impl Freeze for BbrConfig
§impl RefUnwindSafe for BbrConfig
§impl Send for BbrConfig
§impl Sync for BbrConfig
§impl Unpin for BbrConfig
§impl UnwindSafe for BbrConfig
Blanket Implementations§
Source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
Source§fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read moreSource§impl<T> CloneToUninit for Twhere
diff --git a/pr/255/docs/iroh_quinn/congestion/trait.Controller.html b/pr/255/docs/iroh_quinn/congestion/trait.Controller.html
index 6fd6a4943..c582370df 100644
--- a/pr/255/docs/iroh_quinn/congestion/trait.Controller.html
+++ b/pr/255/docs/iroh_quinn/congestion/trait.Controller.html
@@ -76,4 +76,4 @@ application data prior to receiving these acknowledgements.
This function is called when all packets that were deemed lost (for instance because
of packet reordering) are acknowledged after the congestion event was raised.
Sourcefn metrics(&self) -> ControllerMetrics
Retrieve implementation-specific metrics used to populate qlog traces when they are enabled
-Implementors§
\ No newline at end of file
+Implementors§
\ No newline at end of file
diff --git a/pr/255/docs/iroh_quinn/congestion/trait.ControllerFactory.html b/pr/255/docs/iroh_quinn/congestion/trait.ControllerFactory.html
index 056571893..5f8ab4fc4 100644
--- a/pr/255/docs/iroh_quinn/congestion/trait.ControllerFactory.html
+++ b/pr/255/docs/iroh_quinn/congestion/trait.ControllerFactory.html
@@ -7,4 +7,4 @@
) -> Box<dyn Controller>;
}Expand description
Constructs controllers on demand
Required Methods§
Implementors§
Source§impl ControllerFactory for BbrConfig
Source§impl ControllerFactory for CubicConfig
Source§impl ControllerFactory for NewRenoConfig
\ No newline at end of file
+
Implementors§
Source§impl ControllerFactory for BbrConfig
Source§impl ControllerFactory for CubicConfig
Source§impl ControllerFactory for NewRenoConfig
\ No newline at end of file
diff --git a/pr/255/docs/iroh_quinn/crypto/rustls/struct.QuicClientConfig.html b/pr/255/docs/iroh_quinn/crypto/rustls/struct.QuicClientConfig.html
index 00fbff019..228863942 100644
--- a/pr/255/docs/iroh_quinn/crypto/rustls/struct.QuicClientConfig.html
+++ b/pr/255/docs/iroh_quinn/crypto/rustls/struct.QuicClientConfig.html
@@ -1,6 +1,6 @@
QuicClientConfig in iroh_quinn::crypto::rustls - Rust QuicClientConfig
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::with_platform_verifier().
+ClientConfig::with_root_certificates() and ClientConfig::try_with_platform_verifier().
Alternatively, QuicClientConfig’s TryFrom implementation can be used to wrap around a
custom [rustls::ClientConfig], in which case care should be taken around certain points:
diff --git a/pr/255/docs/iroh_quinn/enum.ConfigError.html b/pr/255/docs/iroh_quinn/enum.ConfigError.html
index f0a6f72ec..ce5f3a366 100644
--- a/pr/255/docs/iroh_quinn/enum.ConfigError.html
+++ b/pr/255/docs/iroh_quinn/enum.ConfigError.html
@@ -1,9 +1,9 @@
-ConfigError in iroh_quinn - Rust ConfigError
#[non_exhaustive]pub enum ConfigError {
+ConfigError in iroh_quinn - Rust ConfigError
#[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
-Trait Implementations§
Source§impl Clone for ConfigError
Source§fn clone(&self) -> ConfigError
Returns a duplicate of the value. Read more1.0.0 · Source§fn clone_from(&mut self, source: &Self)
Performs copy-assignment from source. Read moreSource§impl Debug for ConfigError
Source§impl Display for ConfigError
Source§impl Error for ConfigError
1.30.0 · Source§fn source(&self) -> Option<&(dyn Error + 'static)>
Returns the lower-level source of this error, if any. Read more1.0.0 · Source§fn description(&self) -> &str
👎Deprecated since 1.42.0: use the Display impl or to_string()Source§impl From<TryFromIntError> for ConfigError
Source§fn from(_: TryFromIntError) -> ConfigError
Converts to this type from the input type.Source§impl From<VarIntBoundsExceeded> for ConfigError
Source§fn from(_: VarIntBoundsExceeded) -> ConfigError
Converts to this type from the input type.Source§impl PartialEq for ConfigError
Source§impl Eq for ConfigError
Source§impl StructuralPartialEq for ConfigError
Auto Trait Implementations§
§impl Freeze for ConfigError
§impl RefUnwindSafe for ConfigError
§impl Send for ConfigError
§impl Sync for ConfigError
§impl Unpin for ConfigError
§impl UnwindSafe for ConfigError
Blanket Implementations§
Trait Implementations§
Source§impl Clone for ConfigError
Source§fn clone(&self) -> ConfigError
Returns a duplicate of the value. Read more1.0.0 · Source§fn clone_from(&mut self, source: &Self)
Performs copy-assignment from source. Read moreSource§impl Debug for ConfigError
Source§impl Display for ConfigError
Source§impl Error for ConfigError
1.30.0 · Source§fn source(&self) -> Option<&(dyn Error + 'static)>
Returns the lower-level source of this error, if any. Read more1.0.0 · Source§fn description(&self) -> &str
👎Deprecated since 1.42.0: use the Display impl or to_string()Source§impl From<TryFromIntError> for ConfigError
Source§fn from(_: TryFromIntError) -> ConfigError
Converts to this type from the input type.Source§impl From<VarIntBoundsExceeded> for ConfigError
Source§fn from(_: VarIntBoundsExceeded) -> ConfigError
Converts to this type from the input type.Source§impl PartialEq for ConfigError
Source§impl Eq for ConfigError
Source§impl StructuralPartialEq for ConfigError
Auto Trait Implementations§
§impl Freeze for ConfigError
§impl RefUnwindSafe for ConfigError
§impl Send for ConfigError
§impl Sync for ConfigError
§impl Unpin for ConfigError
§impl UnwindSafe for ConfigError
Blanket Implementations§
Source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
Source§fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read moreSource§impl<T> CloneToUninit for Twhere
diff --git a/pr/255/docs/iroh_quinn/enum.ConnectError.html b/pr/255/docs/iroh_quinn/enum.ConnectError.html
index cbdd09bd8..4238be063 100644
--- a/pr/255/docs/iroh_quinn/enum.ConnectError.html
+++ b/pr/255/docs/iroh_quinn/enum.ConnectError.html
@@ -1,4 +1,4 @@
-ConnectError in iroh_quinn - Rust ConnectError
pub enum ConnectError {
+ConnectError in iroh_quinn - Rust ConnectError
pub enum ConnectError {
EndpointStopping,
CidsExhausted,
InvalidServerName(String),
@@ -17,8 +17,8 @@
§NoDefaultClientConfig
No default client configuration was set up
Use Endpoint::connect_with to specify a client configuration.
§UnsupportedVersion
The local endpoint does not support the QUIC version specified in the client configuration
-
Trait Implementations§
Source§impl Clone for ConnectError
Source§fn clone(&self) -> ConnectError
Returns a duplicate of the value. Read more1.0.0 · Source§fn clone_from(&mut self, source: &Self)
Performs copy-assignment from source. Read moreSource§impl Debug for ConnectError
Source§impl Display for ConnectError
Source§impl Error for ConnectError
1.30.0 · Source§fn source(&self) -> Option<&(dyn Error + 'static)>
Returns the lower-level source of this error, if any. Read more1.0.0 · Source§fn description(&self) -> &str
👎Deprecated since 1.42.0: use the Display impl or to_string()Source§impl From<UnsupportedVersion> for ConnectError
Source§fn from(_: UnsupportedVersion) -> ConnectError
Converts to this type from the input type.Source§impl PartialEq for ConnectError
Source§impl Eq for ConnectError
Source§impl StructuralPartialEq for ConnectError
Auto Trait Implementations§
§impl Freeze for ConnectError
§impl RefUnwindSafe for ConnectError
§impl Send for ConnectError
§impl Sync for ConnectError
§impl Unpin for ConnectError
§impl UnwindSafe for ConnectError
Blanket Implementations§
Trait Implementations§
Source§impl Clone for ConnectError
Source§fn clone(&self) -> ConnectError
Returns a duplicate of the value. Read more1.0.0 · Source§fn clone_from(&mut self, source: &Self)
Performs copy-assignment from source. Read moreSource§impl Debug for ConnectError
Source§impl Display for ConnectError
Source§impl Error for ConnectError
1.30.0 · Source§fn source(&self) -> Option<&(dyn Error + 'static)>
Returns the lower-level source of this error, if any. Read more1.0.0 · Source§fn description(&self) -> &str
👎Deprecated since 1.42.0: use the Display impl or to_string()Source§impl From<UnsupportedVersion> for ConnectError
Source§fn from(_: UnsupportedVersion) -> ConnectError
Converts to this type from the input type.Source§impl PartialEq for ConnectError
Source§impl Eq for ConnectError
Source§impl StructuralPartialEq for ConnectError
Auto Trait Implementations§
§impl Freeze for ConnectError
§impl RefUnwindSafe for ConnectError
§impl Send for ConnectError
§impl Sync for ConnectError
§impl Unpin for ConnectError
§impl UnwindSafe for ConnectError
Blanket Implementations§
Source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
Source§fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read moreSource§impl<T> CloneToUninit for Twhere
diff --git a/pr/255/docs/iroh_quinn/enum.ConnectionError.html b/pr/255/docs/iroh_quinn/enum.ConnectionError.html
index 088a81850..99006f4cd 100644
--- a/pr/255/docs/iroh_quinn/enum.ConnectionError.html
+++ b/pr/255/docs/iroh_quinn/enum.ConnectionError.html
@@ -1,4 +1,4 @@
-ConnectionError in iroh_quinn - Rust ConnectionError
pub enum ConnectionError {
+ConnectionError in iroh_quinn - Rust ConnectionError
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 more1.0.0 · Source§fn clone_from(&mut self, source: &Self)
Performs copy-assignment from source. Read moreSource§impl Debug for ConnectionError
Source§impl Display for ConnectionError
Source§impl Error for ConnectionError
Source§fn source(&self) -> Option<&(dyn Error + 'static)>
Returns the lower-level source of this error, if any. Read more1.0.0 · Source§fn description(&self) -> &str
👎Deprecated since 1.42.0: use the Display impl or to_string()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§impl Eq for ConnectionError
Source§impl StructuralPartialEq for ConnectionError
Auto Trait Implementations§
§impl !Freeze for ConnectionError
§impl !RefUnwindSafe for ConnectionError
§impl Send for ConnectionError
§impl Sync for ConnectionError
§impl Unpin for ConnectionError
§impl !UnwindSafe for ConnectionError
Blanket Implementations§
Trait Implementations§
Source§impl Clone for ConnectionError
Source§fn clone(&self) -> ConnectionError
Returns a duplicate of the value. Read more1.0.0 · Source§fn clone_from(&mut self, source: &Self)
Performs copy-assignment from source. Read moreSource§impl Debug for ConnectionError
Source§impl Display for ConnectionError
Source§impl Error for ConnectionError
Source§fn source(&self) -> Option<&(dyn Error + 'static)>
Returns the lower-level source of this error, if any. Read more1.0.0 · Source§fn description(&self) -> &str
👎Deprecated since 1.42.0: use the Display impl or to_string()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§impl Eq for ConnectionError
Source§impl StructuralPartialEq for ConnectionError
Auto Trait Implementations§
§impl !Freeze for ConnectionError
§impl !RefUnwindSafe for ConnectionError
§impl Send for ConnectionError
§impl Sync for ConnectionError
§impl Unpin for ConnectionError
§impl !UnwindSafe for ConnectionError
Blanket Implementations§
Source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
Source§fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read moreSource§impl<T> CloneToUninit for Twhere
diff --git a/pr/255/docs/iroh_quinn/enum.Dir.html b/pr/255/docs/iroh_quinn/enum.Dir.html
index efbb040b3..59802f8a6 100644
--- a/pr/255/docs/iroh_quinn/enum.Dir.html
+++ b/pr/255/docs/iroh_quinn/enum.Dir.html
@@ -1,25 +1,25 @@
-Dir in iroh_quinn - Rust Dir
pub enum Dir {
+Dir in iroh_quinn - Rust Dir
pub enum Dir {
Bi = 0,
Uni = 1,
}
Expand description
Whether a stream communicates data in both directions or only from the initiator
Variants§
Trait Implementations§
Source§impl<'arbitrary> Arbitrary<'arbitrary> for Dir
Source§fn arbitrary(u: &mut Unstructured<'arbitrary>) -> Result<Dir, Error>
Generate an arbitrary value of Self from the given unstructured data. Read moreTrait Implementations§
Source§impl<'arbitrary> Arbitrary<'arbitrary> for Dir
Source§fn arbitrary(u: &mut Unstructured<'arbitrary>) -> Result<Dir, Error>
Generate an arbitrary value of Self from the given unstructured data. Read moreSource§fn arbitrary_take_rest(u: Unstructured<'arbitrary>) -> Result<Dir, Error>
Generate an arbitrary value of Self from the entirety of the given
+unstructured data. Read moreSource§impl Ord for Dir
Source§impl PartialOrd for Dir
Source§impl PartialOrd for Dir
Source§impl Copy for Dir
Source§impl Eq for Dir
Source§impl StructuralPartialEq for Dir
Auto Trait Implementations§
§impl Freeze for Dir
§impl RefUnwindSafe for Dir
§impl Send for Dir
§impl Sync for Dir
§impl Unpin for Dir
§impl UnwindSafe for Dir
Blanket Implementations§
Source§impl Copy for Dir
Source§impl Eq for Dir
Source§impl StructuralPartialEq for Dir
Auto Trait Implementations§
§impl Freeze for Dir
§impl RefUnwindSafe for Dir
§impl Send for Dir
§impl Sync for Dir
§impl Unpin for Dir
§impl UnwindSafe for Dir
Blanket Implementations§
Source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
Source§fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read moreSource§impl<T> CloneToUninit for Twhere
diff --git a/pr/255/docs/iroh_quinn/enum.FrameType.html b/pr/255/docs/iroh_quinn/enum.FrameType.html
index a35f3f031..c28f19a5c 100644
--- a/pr/255/docs/iroh_quinn/enum.FrameType.html
+++ b/pr/255/docs/iroh_quinn/enum.FrameType.html
@@ -7,7 +7,7 @@
StopSending,
Crypto,
NewToken,
- Stream(StreamInfo),
+ Stream(StreamInfo),
MaxData,
MaxStreamData,
MaxStreamsBidi,
@@ -25,7 +25,7 @@
HandshakeDone,
AckFrequency,
ImmediateAck,
- Datagram(DatagramInfo),
+ Datagram(DatagramInfo),
ObservedIpv4Addr,
ObservedIpv6Addr,
PathAck,
@@ -43,10 +43,10 @@
ReachOutAtIpv4,
ReachOutAtIpv6,
RemoveAddress,
-}Variants§
§Padding
§Ping
§Ack
§AckEcn
§ResetStream
§StopSending
§Crypto
§NewToken
§Stream(StreamInfo)
§MaxData
§MaxStreamData
§MaxStreamsBidi
§MaxStreamsUni
§DataBlocked
§StreamDataBlocked
§StreamsBlockedBidi
§StreamsBlockedUni
§NewConnectionId
§RetireConnectionId
§PathChallenge
§PathResponse
§ConnectionClose
§ApplicationClose
§HandshakeDone
§AckFrequency
§ImmediateAck
§Datagram(DatagramInfo)
§ObservedIpv4Addr
§ObservedIpv6Addr
§PathAck
§PathAckEcn
§PathAbandon
§PathStatusBackup
§PathStatusAvailable
§PathNewConnectionId
§PathRetireConnectionId
§MaxPathId
§PathsBlocked
§PathCidsBlocked
§AddIpv4Address
§AddIpv6Address
§ReachOutAtIpv4
§ReachOutAtIpv6
§RemoveAddress
Trait Implementations§
Source§impl Encodable for FrameType
Source§fn encode<B>(&self, buf: &mut B)where
+}Variants§
§Padding
§Ping
§Ack
§AckEcn
§ResetStream
§StopSending
§Crypto
§NewToken
§Stream(StreamInfo)
§MaxData
§MaxStreamData
§MaxStreamsBidi
§MaxStreamsUni
§DataBlocked
§StreamDataBlocked
§StreamsBlockedBidi
§StreamsBlockedUni
§NewConnectionId
§RetireConnectionId
§PathChallenge
§PathResponse
§ConnectionClose
§ApplicationClose
§HandshakeDone
§AckFrequency
§ImmediateAck
§Datagram(DatagramInfo)
§ObservedIpv4Addr
§ObservedIpv6Addr
§PathAck
§PathAckEcn
§PathAbandon
§PathStatusBackup
§PathStatusAvailable
§PathNewConnectionId
§PathRetireConnectionId
§MaxPathId
§PathsBlocked
§PathCidsBlocked
§AddIpv4Address
§AddIpv6Address
§ReachOutAtIpv4
§ReachOutAtIpv6
§RemoveAddress
Trait Implementations§
Source§impl Copy for FrameType
Source§impl Eq for FrameType
Source§impl StructuralPartialEq for FrameType
Auto Trait Implementations§
§impl Freeze for FrameType
§impl RefUnwindSafe for FrameType
§impl Send for FrameType
§impl Sync for FrameType
§impl Unpin for FrameType
§impl UnwindSafe for FrameType
Blanket Implementations§
Source§impl Copy for FrameType
Source§impl Eq for FrameType
Source§impl StructuralPartialEq for FrameType
Auto Trait Implementations§
§impl Freeze for FrameType
§impl RefUnwindSafe for FrameType
§impl Send for FrameType
§impl Sync for FrameType
§impl Unpin for FrameType
§impl UnwindSafe for FrameType
Blanket Implementations§
Source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
Source§fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read moreSource§impl<T> CloneToUninit for Twhere
diff --git a/pr/255/docs/iroh_quinn/enum.Side.html b/pr/255/docs/iroh_quinn/enum.Side.html
index 2bcf64c9b..1bb5dd646 100644
--- a/pr/255/docs/iroh_quinn/enum.Side.html
+++ b/pr/255/docs/iroh_quinn/enum.Side.html
@@ -1,27 +1,27 @@
-Side in iroh_quinn - Rust Side
pub enum Side {
+Side in iroh_quinn - Rust Side
pub enum Side {
Client = 0,
Server = 1,
}
Expand description
Whether an endpoint was the initiator of a connection
Variants§
Implementations§
Trait Implementations§
Source§impl<'arbitrary> Arbitrary<'arbitrary> for Side
Source§fn arbitrary(u: &mut Unstructured<'arbitrary>) -> Result<Side, Error>
Generate an arbitrary value of Self from the given unstructured data. Read moreImplementations§
Trait Implementations§
Source§impl<'arbitrary> Arbitrary<'arbitrary> for Side
Source§fn arbitrary(u: &mut Unstructured<'arbitrary>) -> Result<Side, Error>
Generate an arbitrary value of Self from the given unstructured data. Read moreSource§fn arbitrary_take_rest(u: Unstructured<'arbitrary>) -> Result<Side, Error>
Generate an arbitrary value of Self from the entirety of the given
+unstructured data. Read moreSource§impl Ord for Side
Source§impl PartialOrd for Side
Source§impl PartialOrd for Side
Source§impl Copy for Side
Source§impl Eq for Side
Source§impl StructuralPartialEq for Side
Auto Trait Implementations§
§impl Freeze for Side
§impl RefUnwindSafe for Side
§impl Send for Side
§impl Sync for Side
§impl Unpin for Side
§impl UnwindSafe for Side
Blanket Implementations§
Source§impl Copy for Side
Source§impl Eq for Side
Source§impl StructuralPartialEq for Side
Auto Trait Implementations§
§impl Freeze for Side
§impl RefUnwindSafe for Side
§impl Send for Side
§impl Sync for Side
§impl Unpin for Side
§impl UnwindSafe for Side
Blanket Implementations§
Source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
Source§fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read moreSource§impl<T> CloneToUninit for Twhere
diff --git a/pr/255/docs/iroh_quinn/enum.StoppedError.html b/pr/255/docs/iroh_quinn/enum.StoppedError.html
index 42ac78ed6..ca10923e6 100644
--- a/pr/255/docs/iroh_quinn/enum.StoppedError.html
+++ b/pr/255/docs/iroh_quinn/enum.StoppedError.html
@@ -1,4 +1,4 @@
-StoppedError in iroh_quinn - Rust StoppedError
pub enum StoppedError {
+StoppedError in iroh_quinn - Rust StoppedError
pub enum StoppedError {
ConnectionLost(ConnectionError),
ZeroRttRejected,
}
Expand description
Errors that arise while monitoring for a send stream stop from the peer
@@ -6,8 +6,8 @@
§ZeroRttRejected
This was a 0-RTT stream and the server rejected it
Can only occur on clients for 0-RTT streams, which can be opened using
Connecting::into_0rtt().
-Trait Implementations§
Source§impl Clone for StoppedError
Source§fn clone(&self) -> StoppedError
Returns a duplicate of the value. Read more1.0.0 · Source§fn clone_from(&mut self, source: &Self)
Performs copy-assignment from source. Read moreSource§impl Debug for StoppedError
Source§impl Display for StoppedError
Source§impl Error for StoppedError
Source§fn source(&self) -> Option<&(dyn Error + 'static)>
Returns the lower-level source of this error, if any. Read more1.0.0 · Source§fn description(&self) -> &str
👎Deprecated since 1.42.0: use the Display impl or to_string()Source§impl From<ConnectionError> for StoppedError
Source§fn from(source: ConnectionError) -> Self
Converts to this type from the input type.Source§impl From<StoppedError> for Error
Source§fn from(x: StoppedError) -> Self
Converts to this type from the input type.Source§impl From<StoppedError> for WriteError
Source§fn from(x: StoppedError) -> Self
Converts to this type from the input type.Source§impl PartialEq for StoppedError
Source§impl Eq for StoppedError
Source§impl StructuralPartialEq for StoppedError
Auto Trait Implementations§
§impl !Freeze for StoppedError
§impl !RefUnwindSafe for StoppedError
§impl Send for StoppedError
§impl Sync for StoppedError
§impl Unpin for StoppedError
§impl !UnwindSafe for StoppedError
Blanket Implementations§
Trait Implementations§
Source§impl Clone for StoppedError
Source§fn clone(&self) -> StoppedError
Returns a duplicate of the value. Read more1.0.0 · Source§fn clone_from(&mut self, source: &Self)
Performs copy-assignment from source. Read moreSource§impl Debug for StoppedError
Source§impl Display for StoppedError
Source§impl Error for StoppedError
Source§fn source(&self) -> Option<&(dyn Error + 'static)>
Returns the lower-level source of this error, if any. Read more1.0.0 · Source§fn description(&self) -> &str
👎Deprecated since 1.42.0: use the Display impl or to_string()Source§impl From<ConnectionError> for StoppedError
Source§fn from(source: ConnectionError) -> Self
Converts to this type from the input type.Source§impl From<StoppedError> for Error
Source§fn from(x: StoppedError) -> Self
Converts to this type from the input type.Source§impl From<StoppedError> for WriteError
Source§fn from(x: StoppedError) -> Self
Converts to this type from the input type.Source§impl PartialEq for StoppedError
Source§impl Eq for StoppedError
Source§impl StructuralPartialEq for StoppedError
Auto Trait Implementations§
§impl !Freeze for StoppedError
§impl !RefUnwindSafe for StoppedError
§impl Send for StoppedError
§impl Sync for StoppedError
§impl Unpin for StoppedError
§impl !UnwindSafe for StoppedError
Blanket Implementations§
Source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
Source§fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read moreSource§impl<T> CloneToUninit for Twhere
diff --git a/pr/255/docs/iroh_quinn/enum.WriteError.html b/pr/255/docs/iroh_quinn/enum.WriteError.html
index 48fd44e36..ea02311ac 100644
--- a/pr/255/docs/iroh_quinn/enum.WriteError.html
+++ b/pr/255/docs/iroh_quinn/enum.WriteError.html
@@ -1,4 +1,4 @@
-WriteError in iroh_quinn - Rust WriteError
pub enum WriteError {
+WriteError in iroh_quinn - Rust WriteError
pub enum WriteError {
Stopped(VarInt),
ConnectionLost(ConnectionError),
ClosedStream,
@@ -11,8 +11,8 @@
§ZeroRttRejected
This was a 0-RTT stream and the server rejected it
Can only occur on clients for 0-RTT streams, which can be opened using
Connecting::into_0rtt().
-
Trait Implementations§
Source§impl Clone for WriteError
Source§fn clone(&self) -> WriteError
Returns a duplicate of the value. Read more1.0.0 · Source§fn clone_from(&mut self, source: &Self)
Performs copy-assignment from source. Read moreSource§impl Debug for WriteError
Source§impl Display for WriteError
Source§impl Error for WriteError
Source§fn source(&self) -> Option<&(dyn Error + 'static)>
Returns the lower-level source of this error, if any. Read more1.0.0 · Source§fn description(&self) -> &str
👎Deprecated since 1.42.0: use the Display impl or to_string()Source§impl From<ClosedStream> for WriteError
Source§fn from(_: ClosedStream) -> 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<StoppedError> for WriteError
Source§fn from(x: StoppedError) -> Self
Converts to this type from the input type.Source§impl From<WriteError> for Error
Source§fn from(x: WriteError) -> Self
Converts to this type from the input type.Source§impl PartialEq for WriteError
Source§impl Eq for WriteError
Source§impl StructuralPartialEq for WriteError
Auto Trait Implementations§
§impl !Freeze for WriteError
§impl !RefUnwindSafe for WriteError
§impl Send for WriteError
§impl Sync for WriteError
§impl Unpin for WriteError
§impl !UnwindSafe for WriteError
Blanket Implementations§
Trait Implementations§
Source§impl Clone for WriteError
Source§fn clone(&self) -> WriteError
Returns a duplicate of the value. Read more1.0.0 · Source§fn clone_from(&mut self, source: &Self)
Performs copy-assignment from source. Read moreSource§impl Debug for WriteError
Source§impl Display for WriteError
Source§impl Error for WriteError
Source§fn source(&self) -> Option<&(dyn Error + 'static)>
Returns the lower-level source of this error, if any. Read more1.0.0 · Source§fn description(&self) -> &str
👎Deprecated since 1.42.0: use the Display impl or to_string()Source§impl From<ClosedStream> for WriteError
Source§fn from(_: ClosedStream) -> 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<StoppedError> for WriteError
Source§fn from(x: StoppedError) -> Self
Converts to this type from the input type.Source§impl From<WriteError> for Error
Source§fn from(x: WriteError) -> Self
Converts to this type from the input type.Source§impl PartialEq for WriteError
Source§impl Eq for WriteError
Source§impl StructuralPartialEq for WriteError
Auto Trait Implementations§
§impl !Freeze for WriteError
§impl !RefUnwindSafe for WriteError
§impl Send for WriteError
§impl Sync for WriteError
§impl Unpin for WriteError
§impl !UnwindSafe for WriteError
Blanket Implementations§
Source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
Source§fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read moreSource§impl<T> CloneToUninit for Twhere
diff --git a/pr/255/docs/iroh_quinn/index.html b/pr/255/docs/iroh_quinn/index.html
index 281df6ef6..f0adc5bb4 100644
--- a/pr/255/docs/iroh_quinn/index.html
+++ b/pr/255/docs/iroh_quinn/index.html
@@ -1,4 +1,4 @@
-iroh_quinn - Rust Crate iroh_quinn
Expand description
QUIC transport protocol implementation
+iroh_quinn - Rust Crate iroh_quinn
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
@@ -29,6 +29,6 @@ server, it is useful for a QUIC server to be identified by a certificate signed
authority. If this is infeasible–for example, if servers are short-lived or not associated
with a domain name–then as with TLS, self-signed certificates can be used to provide
encryption alone.
-Re-exports§
pub use rustls;pub use udp;
Modules§
- congestion
- Logic for controlling the rate at which data is sent
- crypto
- Traits and implementations for the QUIC cryptography protocol
Structs§
- Accept
- Future produced by
Endpoint::accept - Accept
Bi - Future produced by
Connection::accept_bi - Accept
Uni - Future produced by
Connection::accept_uni - AckFrequency
Config - Parameters for controlling the peer’s acknowledgement frequency
- Application
Close - Reason given by an application for closing the connection
- Bloom
TokenLog - Bloom filter-based
TokenLog - Chunk
- A chunk of data from the receive stream
- Client
Config - Configuration for outgoing connections
- Closed
Stream - Error indicating that a stream has not been opened or has already been finished or reset
- Connecting
- In-progress connection attempt future
- Connection
- A QUIC connection.
- Connection
Close - Reason given by the transport for closing the connection
- Connection
Id - Protocol-level identifier for a connection.
- Connection
Stats - Connection statistics
- Endpoint
- A QUIC endpoint.
- Endpoint
Config - Global configuration for the endpoint, affecting all connections
- Endpoint
Stats - Statistics on Endpoint activity
- Frame
Stats - Number of frames transmitted or received of each frame type
- Idle
Timeout - Maximum duration of inactivity to accept before timing out the connection
- Incoming
- An incoming connection for which the server has not yet begun its part of the handshake
- Incoming
Future - Basic adapter to let
Incoming be await-ed like a Connecting - MtuDiscovery
Config - Parameters governing MTU discovery.
- None
TokenLog - Null implementation of
TokenLog, which never accepts tokens - None
TokenStore - Null implementation of
TokenStore, which does not store any tokens - OnClosed
- Future returned by
Connection::on_closed - OpenBi
- Future produced by
Connection::open_bi - Open
Path - Future produced by
crate::Connection::open_path - OpenUni
- Future produced by
Connection::open_uni - Path
- An open (Multi)Path
- PathId
- Id representing different paths when using multipath extension
- Path
Stats - Statistics related to a transmission path
- Qlog
Config - Configuration for qlog trace logging.
- Qlog
FileFactory - Enables writing qlog traces to a directory.
- Read
Datagram - Future produced by
Connection::read_datagram - Recv
Stream - A stream that can only be used to receive data
- Retry
Error - Error for attempting to retry an
Incoming which already bears a token from a previous retry - Send
Datagram - Future produced by
Connection::send_datagram_wait - Send
Stream - A stream that can only be used to send data
- Server
Config - Parameters governing incoming connections
- Smol
Runtime - A Quinn runtime for smol
- StdSystem
Time - Default implementation of
TimeSource - Stream
Id - Identifier for a stream within a particular connection
- Token
MemoryCache TokenStore implementation that stores up to N tokens per server name for up to a
+
Re-exports§
pub use rustls;pub use udp;
Modules§
- congestion
- Logic for controlling the rate at which data is sent
- crypto
- Traits and implementations for the QUIC cryptography protocol
Structs§
- Accept
- Future produced by
Endpoint::accept - Accept
Bi - Future produced by
Connection::accept_bi - Accept
Uni - Future produced by
Connection::accept_uni - AckFrequency
Config - Parameters for controlling the peer’s acknowledgement frequency
- Address
Discovery - Stream produced by
Path::observed_external_addr - Application
Close - Reason given by an application for closing the connection
- Bloom
TokenLog - Bloom filter-based
TokenLog - Chunk
- A chunk of data from the receive stream
- Client
Config - Configuration for outgoing connections
- Close
Path - Future produced by
Path::close - Closed
Stream - Error indicating that a stream has not been opened or has already been finished or reset
- Connecting
- In-progress connection attempt future
- Connection
- A QUIC connection.
- Connection
Close - Reason given by the transport for closing the connection
- Connection
Id - Protocol-level identifier for a connection.
- Connection
Stats - Connection statistics
- Endpoint
- A QUIC endpoint.
- Endpoint
Config - Global configuration for the endpoint, affecting all connections
- Endpoint
Stats - Statistics on Endpoint activity
- Frame
Stats - Number of frames transmitted or received of each frame type
- Idle
Timeout - Maximum duration of inactivity to accept before timing out the connection
- Incoming
- An incoming connection for which the server has not yet begun its part of the handshake
- Incoming
Future - Basic adapter to let
Incoming be await-ed like a Connecting - Invalid
Cid - The connection ID was not recognized by the
ConnectionIdGenerator - MtuDiscovery
Config - Parameters governing MTU discovery.
- None
TokenLog - Null implementation of
TokenLog, which never accepts tokens - None
TokenStore - Null implementation of
TokenStore, which does not store any tokens - OnClosed
- Future returned by
Connection::on_closed - OpenBi
- Future produced by
Connection::open_bi - Open
Path - Future produced by
crate::Connection::open_path - OpenUni
- Future produced by
Connection::open_uni - Path
- An open (Multi)Path
- PathId
- Id representing different paths when using multipath extension
- Path
Stats - Statistics related to a transmission path
- Qlog
Config - Configuration for qlog trace logging.
- Qlog
FileFactory - Enables writing qlog traces to a directory.
- Read
Datagram - Future produced by
Connection::read_datagram - Recv
Stream - A stream that can only be used to receive data
- Retry
Error - Error for attempting to retry an
Incoming which already bears a token from a previous retry - Send
Datagram - Future produced by
Connection::send_datagram_wait - Send
Stream - A stream that can only be used to send data
- Server
Config - Parameters governing incoming connections
- Smol
Runtime - A Quinn runtime for smol
- StdSystem
Time - Default implementation of
TimeSource - Stream
Id - Identifier for a stream within a particular connection
- Token
MemoryCache TokenStore implementation that stores up to N tokens per server name for up to a
limited number of server names, in-memory- Token
ReuseError - Error for when a validation token may have been reused
- Tokio
Runtime - A Quinn runtime for Tokio
- Transmit
- An outgoing packet
- Transport
Config - Parameters governing the core QUIC state machine
- Transport
ErrorCode - Transport-level error code
- UdpStats
- Statistics about UDP datagrams transmitted or received on a connection
- Unordered
RecvStream - A stream that can be used to receive data out-of-order.
- Validation
TokenConfig - Configuration for sending and handling validation tokens in incoming connections
- VarInt
- An integer less than 2^62
- VarInt
BoundsExceeded - Error returned when constructing a
VarInt from a value >= 2^62 - Weak
ConnectionHandle - A handle to some connection internals, use with care.
- Written
- Indicates how many bytes and chunks had been transferred in a write operation
- Zero
RttAccepted - Future that completes when a connection is fully established
Enums§
- Config
Error - Errors in the configuration of an endpoint
- Connect
Error - Errors in the parameters being used to create a new connection
- Connection
Error - Reasons why a connection might be lost
- Dir
- Whether a stream communicates data in both directions or only from the initiator
- EcnCodepoint
- Explicit congestion notification codepoint
- Frame
Type - Read
Error - Errors that arise from reading from a stream.
- Read
ExactError - Errors that arise from reading from a stream.
- Read
ToEndError - Errors from
RecvStream::read_to_end - Reset
Error - Errors that arise while waiting for a stream to be reset
- Send
DatagramError - Errors that can arise when sending a datagram
- Side
- Whether an endpoint was the initiator of a connection
- Stopped
Error - Errors that arise while monitoring for a send stream stop from the peer
- Write
Error - Errors that arise from writing to a stream
Traits§
- Async
Timer - Abstract implementation of an async timer for runtime independence
- Async
UdpSocket - Abstract implementation of a UDP socket for runtime independence
- Connection
IdGenerator - Generates connection IDs for incoming connections
- Qlog
Factory - Constructs a
QlogConfig for individual connections. - Runtime
- Abstracts I/O and timer operations for runtime independence
- Time
Source - Object to get current
SystemTime - Token
Log - Responsible for limiting clients’ ability to reuse validation tokens
- Token
Store - Responsible for storing validation tokens received from servers and retrieving them for use in
subsequent connections
- UdpSender
- An object for asynchronously writing to an associated
AsyncUdpSocket.
Functions§
- default_
runtime - Automatically select an appropriate runtime from those enabled at compile time
\ No newline at end of file
diff --git a/pr/255/docs/iroh_quinn/path/struct.AddressDiscovery.html b/pr/255/docs/iroh_quinn/path/struct.AddressDiscovery.html
new file mode 100644
index 000000000..e4476ec35
--- /dev/null
+++ b/pr/255/docs/iroh_quinn/path/struct.AddressDiscovery.html
@@ -0,0 +1,11 @@
+
+
+
+
+ Redirection
+
+
+ Redirecting to ../../iroh_quinn/struct.AddressDiscovery.html...
+
+
+
\ No newline at end of file
diff --git a/pr/255/docs/iroh_quinn/path/struct.ClosePath.html b/pr/255/docs/iroh_quinn/path/struct.ClosePath.html
new file mode 100644
index 000000000..56c3283bf
--- /dev/null
+++ b/pr/255/docs/iroh_quinn/path/struct.ClosePath.html
@@ -0,0 +1,11 @@
+
+
+
+
+ Redirection
+
+
+ Redirecting to ../../iroh_quinn/struct.ClosePath.html...
+
+
+
\ No newline at end of file
diff --git a/pr/255/docs/iroh_quinn/sidebar-items.js b/pr/255/docs/iroh_quinn/sidebar-items.js
index ae9bffc7f..2af1c653a 100644
--- a/pr/255/docs/iroh_quinn/sidebar-items.js
+++ b/pr/255/docs/iroh_quinn/sidebar-items.js
@@ -1 +1 @@
-window.SIDEBAR_ITEMS = {"enum":["ConfigError","ConnectError","ConnectionError","Dir","EcnCodepoint","FrameType","ReadError","ReadExactError","ReadToEndError","ResetError","SendDatagramError","Side","StoppedError","WriteError"],"fn":["default_runtime"],"mod":["congestion","crypto"],"struct":["Accept","AcceptBi","AcceptUni","AckFrequencyConfig","ApplicationClose","BloomTokenLog","Chunk","ClientConfig","ClosedStream","Connecting","Connection","ConnectionClose","ConnectionId","ConnectionStats","Endpoint","EndpointConfig","EndpointStats","FrameStats","IdleTimeout","Incoming","IncomingFuture","MtuDiscoveryConfig","NoneTokenLog","NoneTokenStore","OnClosed","OpenBi","OpenPath","OpenUni","Path","PathId","PathStats","QlogConfig","QlogFileFactory","ReadDatagram","RecvStream","RetryError","SendDatagram","SendStream","ServerConfig","SmolRuntime","StdSystemTime","StreamId","TokenMemoryCache","TokenReuseError","TokioRuntime","Transmit","TransportConfig","TransportErrorCode","UdpStats","UnorderedRecvStream","ValidationTokenConfig","VarInt","VarIntBoundsExceeded","WeakConnectionHandle","Written","ZeroRttAccepted"],"trait":["AsyncTimer","AsyncUdpSocket","ConnectionIdGenerator","QlogFactory","Runtime","TimeSource","TokenLog","TokenStore","UdpSender"]};
\ No newline at end of file
+window.SIDEBAR_ITEMS = {"enum":["ConfigError","ConnectError","ConnectionError","Dir","EcnCodepoint","FrameType","ReadError","ReadExactError","ReadToEndError","ResetError","SendDatagramError","Side","StoppedError","WriteError"],"fn":["default_runtime"],"mod":["congestion","crypto"],"struct":["Accept","AcceptBi","AcceptUni","AckFrequencyConfig","AddressDiscovery","ApplicationClose","BloomTokenLog","Chunk","ClientConfig","ClosePath","ClosedStream","Connecting","Connection","ConnectionClose","ConnectionId","ConnectionStats","Endpoint","EndpointConfig","EndpointStats","FrameStats","IdleTimeout","Incoming","IncomingFuture","InvalidCid","MtuDiscoveryConfig","NoneTokenLog","NoneTokenStore","OnClosed","OpenBi","OpenPath","OpenUni","Path","PathId","PathStats","QlogConfig","QlogFileFactory","ReadDatagram","RecvStream","RetryError","SendDatagram","SendStream","ServerConfig","SmolRuntime","StdSystemTime","StreamId","TokenMemoryCache","TokenReuseError","TokioRuntime","Transmit","TransportConfig","TransportErrorCode","UdpStats","UnorderedRecvStream","ValidationTokenConfig","VarInt","VarIntBoundsExceeded","WeakConnectionHandle","Written","ZeroRttAccepted"],"trait":["AsyncTimer","AsyncUdpSocket","ConnectionIdGenerator","QlogFactory","Runtime","TimeSource","TokenLog","TokenStore","UdpSender"]};
\ No newline at end of file
diff --git a/pr/255/docs/iroh_quinn/struct.Accept.html b/pr/255/docs/iroh_quinn/struct.Accept.html
index 6e17e11a0..896bcd39f 100644
--- a/pr/255/docs/iroh_quinn/struct.Accept.html
+++ b/pr/255/docs/iroh_quinn/struct.Accept.html
@@ -1,6 +1,6 @@
-Accept in iroh_quinn - Rust Accept
pub struct Accept<'a> { /* private fields */ }
Expand description
Future produced by Endpoint::accept
-Trait Implementations§
Source§impl<'__pin, 'a> Unpin for Accept<'a>where
+Accept in iroh_quinn - Rust Accept
pub struct Accept<'a> { /* private fields */ }
Expand description
Future produced by Endpoint::accept
+Trait Implementations§
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> BorrowMut<T> for Twhere
diff --git a/pr/255/docs/iroh_quinn/struct.AddressDiscovery.html b/pr/255/docs/iroh_quinn/struct.AddressDiscovery.html
new file mode 100644
index 000000000..5bde10466
--- /dev/null
+++ b/pr/255/docs/iroh_quinn/struct.AddressDiscovery.html
@@ -0,0 +1,173 @@
+AddressDiscovery in iroh_quinn - Rust AddressDiscovery
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.Auto Trait Implementations§
§impl Freeze for AddressDiscovery
§impl !RefUnwindSafe for AddressDiscovery
§impl Send for AddressDiscovery
§impl Sync for AddressDiscovery
§impl Unpin for AddressDiscovery
§impl !UnwindSafe for AddressDiscovery
Blanket Implementations§
Source§impl<T> BorrowMut<T> for Twhere
+ T: ?Sized,
Source§fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more§impl<T> Instrument for T
§fn instrument(self, span: Span) -> Instrumented<Self>
§fn in_current_span(self) -> Instrumented<Self>
Source§impl<T> IntoEither for T
Source§fn into_either(self, into_left: bool) -> Either<Self, Self>
Converts self into a Left variant of Either<Self, Self>
+if into_left is true.
+Converts self into a Right variant of Either<Self, Self>
+otherwise. Read moreSource§fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
Converts self into a Left variant of Either<Self, Self>
+if into_left(&self) returns true.
+Converts self into a Right variant of Either<Self, Self>
+otherwise. Read more§impl<S> StreamExt for Swhere
+ S: Stream + ?Sized,
§fn next(&mut self) -> NextFuture<'_, Self>where
+ Self: Unpin,
Retrieves the next item in the stream. Read more§fn try_next<T, E>(&mut self) -> TryNextFuture<'_, Self>
Retrieves the next item in the stream. Read more§fn count(self) -> CountFuture<Self>where
+ Self: Sized,
Counts the number of items in the stream. Read more§fn map<T, F>(self, f: F) -> Map<Self, F>
Maps items of the stream to new values using a closure. Read more§fn flat_map<U, F>(self, f: F) -> FlatMap<Self, U, F>
Maps items to streams and then concatenates them. Read more§fn flatten(self) -> Flatten<Self>where
+ Self: Sized,
+ Self::Item: Stream,
Concatenates inner streams. Read more§fn then<F, Fut>(self, f: F) -> Then<Self, F, Fut>
Maps items of the stream to new values using an async closure. Read more§fn filter_map<T, F>(self, f: F) -> FilterMap<Self, F>
Filters and maps items of the stream using a closure. Read more§fn take(self, n: usize) -> Take<Self>where
+ Self: Sized,
Takes only the first n items of the stream. Read more§fn take_while<P>(self, predicate: P) -> TakeWhile<Self, P>
§fn skip(self, n: usize) -> Skip<Self>where
+ Self: Sized,
Skips the first n items of the stream. Read more§fn skip_while<P>(self, predicate: P) -> SkipWhile<Self, P>
§fn step_by(self, step: usize) -> StepBy<Self>where
+ Self: Sized,
Yields every stepth item. Read more§fn chain<U>(self, other: U) -> Chain<Self, U>where
+ Self: Sized,
+ U: Stream<Item = Self::Item>,
Appends another stream to the end of this one. Read more§fn collect<C>(self) -> CollectFuture<Self, C>
Collects all items in the stream into a collection. Read more§fn try_collect<T, E, C>(self) -> TryCollectFuture<Self, C>
Collects all items in the fallible stream into a collection. Read more§fn partition<B, P>(self, predicate: P) -> PartitionFuture<Self, P, B>
Partitions items into those for which predicate is true and those for which it is
+false, and then collects them into two collections. Read more§fn fold<T, F>(self, init: T, f: F) -> FoldFuture<Self, F, T>
Accumulates a computation over the stream. Read more§fn try_fold<T, E, F, B>(
+ &mut self,
+ init: B,
+ f: F,
+) -> TryFoldFuture<'_, Self, F, B>
Accumulates a fallible computation over the stream. Read more§fn scan<St, B, F>(self, initial_state: St, f: F) -> Scan<Self, St, F>
Maps items of the stream to new values using a state value and a closure. Read more§fn enumerate(self) -> Enumerate<Self>where
+ Self: Sized,
Enumerates items, mapping them to (index, item). Read more§fn inspect<F>(self, f: F) -> Inspect<Self, F>
Calls a closure on each item and passes it on. Read more§fn nth(&mut self, n: usize) -> NthFuture<'_, Self>where
+ Self: Unpin,
Gets the nth item of the stream. Read more§fn last(self) -> LastFuture<Self>where
+ Self: Sized,
Returns the last item in the stream. Read more§fn for_each<F>(self, f: F) -> ForEachFuture<Self, F>
Calls a closure on each item of the stream. Read more§fn try_for_each<F, E>(&mut self, f: F) -> TryForEachFuture<'_, Self, F>
Calls a fallible closure on each item of the stream, stopping on first error. Read more§fn zip<U>(self, other: U) -> Zip<Self, U>where
+ Self: Sized,
+ U: Stream,
Zips up two streams into a single stream of pairs. Read more§fn unzip<A, B, FromA, FromB>(self) -> UnzipFuture<Self, FromA, FromB>
Collects a stream of pairs into a pair of collections. Read more§fn race<S>(self, other: S) -> Race<Self, S>where
+ Self: Sized,
+ S: Stream<Item = Self::Item>,
Merges with other stream, with no preference for either stream when both are ready. Read more§fn drain(&mut self) -> Drain<'_, Self>
Yields all immediately available values from a stream. Read more§impl<St> StreamExt for Stwhere
+ St: Stream + ?Sized,
§fn next(&mut self) -> Next<'_, Self>where
+ Self: Unpin,
Consumes and returns the next value in the stream or None if the
+stream is finished. Read more§fn try_next<T, E>(&mut self) -> TryNext<'_, Self>
Consumes and returns the next item in the stream. If an error is
+encountered before the next item, the error is returned instead. Read more§fn map<T, F>(self, f: F) -> Map<Self, F>
Maps this stream’s items to a different type, returning a new stream of
+the resulting type. Read more§fn map_while<T, F>(self, f: F) -> MapWhile<Self, F>
Map this stream’s items to a different type for as long as determined by
+the provided closure. A stream of the target type will be returned,
+which will yield elements until the closure returns None. Read more§fn then<F, Fut>(self, f: F) -> Then<Self, Fut, F>
Maps this stream’s items asynchronously to a different type, returning a
+new stream of the resulting type. Read more§fn merge<U>(self, other: U) -> Merge<Self, U>where
+ U: Stream<Item = Self::Item>,
+ Self: Sized,
Combine two streams into one by interleaving the output of both as it
+is produced. Read more§fn filter<F>(self, f: F) -> Filter<Self, F>
Filters the values produced by this stream according to the provided
+predicate. Read more§fn filter_map<T, F>(self, f: F) -> FilterMap<Self, F>
Filters the values produced by this stream while simultaneously mapping
+them to a different type according to the provided closure. Read more§fn fuse(self) -> Fuse<Self>where
+ Self: Sized,
Creates a stream which ends after the first None. Read more§fn take(self, n: usize) -> Take<Self>where
+ Self: Sized,
Creates a new stream of at most n items of the underlying stream. Read more§fn take_while<F>(self, f: F) -> TakeWhile<Self, F>
Take elements from this stream while the provided predicate
+resolves to true. Read more§fn skip(self, n: usize) -> Skip<Self>where
+ Self: Sized,
Creates a new stream that will skip the n first items of the
+underlying stream. Read more§fn skip_while<F>(self, f: F) -> SkipWhile<Self, F>
Skip elements from the underlying stream while the provided predicate
+resolves to true. Read more§fn all<F>(&mut self, f: F) -> AllFuture<'_, Self, F>
Tests if every element of the stream matches a predicate. Read more§fn any<F>(&mut self, f: F) -> AnyFuture<'_, Self, F>
Tests if any element of the stream matches a predicate. Read more§fn chain<U>(self, other: U) -> Chain<Self, U>where
+ U: Stream<Item = Self::Item>,
+ Self: Sized,
Combine two streams into one by first returning all values from the
+first stream then all values from the second stream. Read more§fn fold<B, F>(self, init: B, f: F) -> FoldFuture<Self, B, F>
A combinator that applies a function to every element in a stream
+producing a single, final value. Read more§fn collect<T>(self) -> Collect<Self, T>where
+ T: FromStream<Self::Item>,
+ Self: Sized,
Drain stream pushing all emitted values into a collection. Read more§fn timeout(self, duration: Duration) -> Timeout<Self>where
+ Self: Sized,
Applies a per-item timeout to the passed stream. Read more§fn timeout_repeating(self, interval: Interval) -> TimeoutRepeating<Self>where
+ Self: Sized,
Applies a per-item timeout to the passed stream. Read more§fn throttle(self, duration: Duration) -> Throttle<Self>where
+ Self: Sized,
Slows down a stream by enforcing a delay between items. Read more§impl<T> WithSubscriber for T
§fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>where
+ S: Into<Dispatch>,
§fn with_current_subscriber(self) -> WithDispatch<Self>
Attaches the current default Subscriber to this type, returning a
+[WithDispatch] wrapper. Read more
\ No newline at end of file
diff --git a/pr/255/docs/iroh_quinn/struct.ApplicationClose.html b/pr/255/docs/iroh_quinn/struct.ApplicationClose.html
index c6ccb9e8e..bb5b19c66 100644
--- a/pr/255/docs/iroh_quinn/struct.ApplicationClose.html
+++ b/pr/255/docs/iroh_quinn/struct.ApplicationClose.html
@@ -1,11 +1,11 @@
-ApplicationClose in iroh_quinn - Rust ApplicationClose
pub struct ApplicationClose {
+ApplicationClose in iroh_quinn - Rust ApplicationClose
pub struct ApplicationClose {
pub error_code: VarInt,
pub reason: Bytes,
}
Expand description
Reason given by an application for closing the connection
Fields§
§error_code: VarIntApplication-specific reason code
§reason: BytesHuman-readable reason for the close
-Trait Implementations§
Source§impl Clone for ApplicationClose
Source§fn clone(&self) -> ApplicationClose
Returns a duplicate of the value. Read more1.0.0 · Source§fn clone_from(&mut self, source: &Self)
Performs copy-assignment from source. Read moreSource§impl Debug for ApplicationClose
Source§impl Display for ApplicationClose
Source§impl PartialEq for ApplicationClose
Source§impl Eq for ApplicationClose
Source§impl StructuralPartialEq for ApplicationClose
Auto Trait Implementations§
§impl !Freeze for ApplicationClose
§impl RefUnwindSafe for ApplicationClose
§impl Send for ApplicationClose
§impl Sync for ApplicationClose
§impl Unpin for ApplicationClose
§impl UnwindSafe for ApplicationClose
Blanket Implementations§
Source§impl<T> Any for Twhere
+Trait Implementations§
Source§impl Clone for ApplicationClose
Source§fn clone(&self) -> ApplicationClose
Returns a duplicate of the value. Read more1.0.0 · Source§fn clone_from(&mut self, source: &Self)
Performs copy-assignment from source. Read moreSource§impl Debug for ApplicationClose
Source§impl Display for ApplicationClose
Source§impl PartialEq for ApplicationClose
Source§impl Eq for ApplicationClose
Source§impl StructuralPartialEq for ApplicationClose
Auto Trait Implementations§
§impl !Freeze for ApplicationClose
§impl RefUnwindSafe for ApplicationClose
§impl Send for ApplicationClose
§impl Sync for ApplicationClose
§impl Unpin for ApplicationClose
§impl UnwindSafe for ApplicationClose
Blanket Implementations§
Source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
Source§fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read moreSource§impl<T> CloneToUninit for Twhere
diff --git a/pr/255/docs/iroh_quinn/struct.ClientConfig.html b/pr/255/docs/iroh_quinn/struct.ClientConfig.html
index 990a35909..32e5eca5a 100644
--- a/pr/255/docs/iroh_quinn/struct.ClientConfig.html
+++ b/pr/255/docs/iroh_quinn/struct.ClientConfig.html
@@ -1,4 +1,4 @@
-ClientConfig in iroh_quinn - Rust ClientConfig
#[non_exhaustive]pub struct ClientConfig { /* private fields */ }
Expand description
Configuration for outgoing connections
+ClientConfig in iroh_quinn - Rust ClientConfig
#[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
Sourcepub fn new(crypto: Arc<dyn ClientConfig>) -> ClientConfig
Create a default config with a particular cryptographic config
Sourcepub fn initial_dst_cid_provider(
@@ -17,12 +17,11 @@ at least 8 bytes long and unpredictable, as per section 7.2 of RFC 9000.
Sourcepub fn token_store(&mut self, store: Arc<dyn TokenStore>) -> &mut ClientConfig
Set a custom TokenStore
Defaults to TokenMemoryCache, which is suitable for most internet applications.
Sourcepub fn version(&mut self, version: u32) -> &mut ClientConfig
Set the QUIC version to use
-Source§impl ClientConfig
Sourcepub fn with_platform_verifier() -> ClientConfig
👎Deprecated since 0.11.13: use try_with_platform_verifier() instead
Create a client configuration that trusts the platform’s native roots
-Sourcepub fn try_with_platform_verifier() -> Result<ClientConfig, Error>
Create a client configuration that trusts the platform’s native roots
-Sourcepub fn with_root_certificates(
+
Source§impl ClientConfig
Sourcepub fn try_with_platform_verifier() -> Result<ClientConfig, Error>
Create a client configuration that trusts the platform’s native roots
+Sourcepub fn with_root_certificates(
roots: Arc<RootCertStore>,
) -> Result<ClientConfig, VerifierBuilderError>
Create a client configuration that trusts specified trust anchors
-Trait Implementations§
Source§impl Clone for ClientConfig
Source§fn clone(&self) -> ClientConfig
Returns a duplicate of the value. Read more1.0.0 · Source§fn clone_from(&mut self, source: &Self)
Performs copy-assignment from source. Read moreAuto Trait Implementations§
§impl Freeze for ClientConfig
§impl !RefUnwindSafe for ClientConfig
§impl Send for ClientConfig
§impl Sync for ClientConfig
§impl Unpin for ClientConfig
§impl !UnwindSafe for ClientConfig
Blanket Implementations§
Trait Implementations§
Source§impl Clone for ClientConfig
Source§fn clone(&self) -> ClientConfig
Returns a duplicate of the value. Read more1.0.0 · Source§fn clone_from(&mut self, source: &Self)
Performs copy-assignment from source. Read moreAuto Trait Implementations§
§impl Freeze for ClientConfig
§impl !RefUnwindSafe for ClientConfig
§impl Send for ClientConfig
§impl Sync for ClientConfig
§impl Unpin for ClientConfig
§impl !UnwindSafe for ClientConfig
Blanket Implementations§
Source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
Source§fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read moreSource§impl<T> CloneToUninit for Twhere
diff --git a/pr/255/docs/iroh_quinn/struct.ClosePath.html b/pr/255/docs/iroh_quinn/struct.ClosePath.html
new file mode 100644
index 000000000..346435f36
--- /dev/null
+++ b/pr/255/docs/iroh_quinn/struct.ClosePath.html
@@ -0,0 +1,53 @@
+ClosePath in iroh_quinn - Rust ClosePath
pub struct ClosePath { /* private fields */ }
Expand description
Future produced by Path::close
+Trait Implementations§
Auto Trait Implementations§
§impl Freeze for ClosePath
§impl !RefUnwindSafe for ClosePath
§impl Send for ClosePath
§impl Sync for ClosePath
§impl Unpin for ClosePath
§impl !UnwindSafe for ClosePath
Blanket Implementations§
Source§impl<T> BorrowMut<T> for Twhere
+ T: ?Sized,
Source§fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more§impl<F> FutureExt for F
§fn catch_unwind(self) -> CatchUnwind<Self>where
+ Self: Sized + UnwindSafe,
Catches panics while polling the future. Read more§impl<T> FutureExt for T
§fn with_cancellation_token(
+ self,
+ cancellation_token: &CancellationToken,
+) -> WithCancellationTokenFuture<'_, Self>where
+ Self: Sized,
Similar to [CancellationToken::run_until_cancelled],
+but with the advantage that it is easier to write fluent call chains,
+and biased towards waiting for [CancellationToken] to complete. Read more§fn with_cancellation_token_owned(
+ self,
+ cancellation_token: CancellationToken,
+) -> WithCancellationTokenFutureOwned<Self>where
+ Self: Sized,
Similar to [CancellationToken::run_until_cancelled_owned],
+but with the advantage that it is easier to write fluent call chains,
+and biased towards waiting for [CancellationToken] to complete. Read more§impl<T> Instrument for T
§fn instrument(self, span: Span) -> Instrumented<Self>
§fn in_current_span(self) -> Instrumented<Self>
Source§impl<T> IntoEither for T
Source§fn into_either(self, into_left: bool) -> Either<Self, Self>
Converts self into a Left variant of Either<Self, Self>
+if into_left is true.
+Converts self into a Right variant of Either<Self, Self>
+otherwise. Read moreSource§fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
Converts self into a Left variant of Either<Self, Self>
+if into_left(&self) returns true.
+Converts self into a Right variant of Either<Self, Self>
+otherwise. Read moreSource§impl<F> IntoFuture for Fwhere
+ F: Future,
Source§type IntoFuture = F
Which kind of future are we turning this into?Source§fn into_future(self) -> <F as IntoFuture>::IntoFuture
Creates a future from a value. Read more§impl<F, T, E> TryFuture for F
§impl<T> WithSubscriber for T
§fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>where
+ S: Into<Dispatch>,
§fn with_current_subscriber(self) -> WithDispatch<Self>
Attaches the current default Subscriber to this type, returning a
+[WithDispatch] wrapper. Read more
\ No newline at end of file
diff --git a/pr/255/docs/iroh_quinn/struct.ClosedStream.html b/pr/255/docs/iroh_quinn/struct.ClosedStream.html
index c9021984a..7d402dfa5 100644
--- a/pr/255/docs/iroh_quinn/struct.ClosedStream.html
+++ b/pr/255/docs/iroh_quinn/struct.ClosedStream.html
@@ -1,5 +1,5 @@
ClosedStream in iroh_quinn - Rust ClosedStream
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 more1.0.0 · Source§fn clone_from(&mut self, source: &Self)
Performs copy-assignment from source. Read moreSource§impl Debug for ClosedStream
Source§impl Default for ClosedStream
Source§fn default() -> ClosedStream
Returns the “default value” for a type. Read moreSource§impl Display for ClosedStream
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 more1.0.0 · Source§fn description(&self) -> &str
👎Deprecated since 1.42.0: use the Display impl or to_string()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,
+Trait Implementations§
Source§impl Clone for ClosedStream
Source§fn clone(&self) -> ClosedStream
Returns a duplicate of the value. Read more1.0.0 · Source§fn clone_from(&mut self, source: &Self)
Performs copy-assignment from source. Read moreSource§impl Debug for ClosedStream
Source§impl Default for ClosedStream
Source§fn default() -> ClosedStream
Returns the “default value” for a type. Read moreSource§impl Display for ClosedStream
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 more1.0.0 · Source§fn description(&self) -> &str
👎Deprecated since 1.42.0: use the Display impl or to_string()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§impl Eq for ClosedStream
Source§impl StructuralPartialEq for ClosedStream
Auto Trait Implementations§
§impl Freeze for ClosedStream
§impl RefUnwindSafe for ClosedStream
§impl Send for ClosedStream
§impl Sync for ClosedStream
§impl Unpin for ClosedStream
§impl UnwindSafe for ClosedStream
Blanket Implementations§
Source§impl<T> BorrowMut<T> for Twhere
diff --git a/pr/255/docs/iroh_quinn/struct.ConnectionClose.html b/pr/255/docs/iroh_quinn/struct.ConnectionClose.html
index babfc951e..853926ce5 100644
--- a/pr/255/docs/iroh_quinn/struct.ConnectionClose.html
+++ b/pr/255/docs/iroh_quinn/struct.ConnectionClose.html
@@ -1,13 +1,13 @@
-ConnectionClose in iroh_quinn - Rust ConnectionClose
pub struct ConnectionClose {
+ConnectionClose in iroh_quinn - Rust ConnectionClose
pub struct ConnectionClose {
pub error_code: Code,
- pub frame_type: MaybeFrame,
+ pub frame_type: MaybeFrame,
pub reason: Bytes,
}
Expand description
Reason given by the transport for closing the connection
Fields§
§error_code: CodeClass of error as encoded in the specification
-§frame_type: MaybeFrameType of frame that caused the close
+§frame_type: MaybeFrameType of frame that caused the close
§reason: BytesHuman-readable reason for the close
-Trait Implementations§
Source§impl Clone for ConnectionClose
Source§fn clone(&self) -> ConnectionClose
Returns a duplicate of the value. Read more1.0.0 · Source§fn clone_from(&mut self, source: &Self)
Performs copy-assignment from source. Read moreSource§impl Debug for ConnectionClose
Source§impl Display for ConnectionClose
Source§impl From<Error> for ConnectionClose
Source§fn from(x: Error) -> ConnectionClose
Converts to this type from the input type.Source§impl PartialEq for ConnectionClose
Source§impl Eq for ConnectionClose
Source§impl StructuralPartialEq for ConnectionClose
Auto Trait Implementations§
§impl !Freeze for ConnectionClose
§impl RefUnwindSafe for ConnectionClose
§impl Send for ConnectionClose
§impl Sync for ConnectionClose
§impl Unpin for ConnectionClose
§impl UnwindSafe for ConnectionClose
Blanket Implementations§
Source§impl<T> Any for Twhere
+Trait Implementations§
Source§impl Clone for ConnectionClose
Source§fn clone(&self) -> ConnectionClose
Returns a duplicate of the value. Read more1.0.0 · Source§fn clone_from(&mut self, source: &Self)
Performs copy-assignment from source. Read moreSource§impl Debug for ConnectionClose
Source§impl Display for ConnectionClose
Source§impl From<Error> for ConnectionClose
Source§fn from(x: Error) -> ConnectionClose
Converts to this type from the input type.Source§impl PartialEq for ConnectionClose
Source§impl Eq for ConnectionClose
Source§impl StructuralPartialEq for ConnectionClose
Auto Trait Implementations§
§impl !Freeze for ConnectionClose
§impl RefUnwindSafe for ConnectionClose
§impl Send for ConnectionClose
§impl Sync for ConnectionClose
§impl Unpin for ConnectionClose
§impl UnwindSafe for ConnectionClose
Blanket Implementations§
Source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
Source§fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read moreSource§impl<T> CloneToUninit for Twhere
diff --git a/pr/255/docs/iroh_quinn/struct.Endpoint.html b/pr/255/docs/iroh_quinn/struct.Endpoint.html
index df16aa143..d023d3a0a 100644
--- a/pr/255/docs/iroh_quinn/struct.Endpoint.html
+++ b/pr/255/docs/iroh_quinn/struct.Endpoint.html
@@ -1,8 +1,8 @@
-Endpoint in iroh_quinn - Rust Endpoint
pub struct Endpoint { /* private fields */ }
Expand description
A QUIC endpoint.
+Endpoint in iroh_quinn - Rust Endpoint
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.
-Implementations§
Source§impl Endpoint
Sourcepub fn client(addr: SocketAddr) -> Result<Self>
Helper to construct an endpoint for use with outgoing connections only
+Implementations§
Source§impl Endpoint
Sourcepub fn client(addr: SocketAddr) -> Result<Self>
Helper to construct an endpoint for use with outgoing connections only
Note that addr is the local address to bind to, which should usually be a wildcard
address like 0.0.0.0:0 or [::]:0, which allow communication with any reachable IPv4 or
IPv6 address respectively from an OS-assigned port.
@@ -14,19 +14,19 @@ address. For example:
iroh_quinn::Endpoint::client((std::net::Ipv6Addr::UNSPECIFIED, 0).into());
Some environments may not allow creation of dual-stack sockets, in which case an IPv6
client will only be able to connect to IPv6 servers. An IPv4 client is never dual-stack.
-Sourcepub fn stats(&self) -> EndpointStats
Returns relevant stats from this Endpoint
-Sourcepub fn server(config: ServerConfig, addr: SocketAddr) -> Result<Self>
Helper to construct an endpoint for use with both incoming and outgoing connections
+Sourcepub fn stats(&self) -> EndpointStats
Returns relevant stats from this Endpoint
+Sourcepub fn server(config: ServerConfig, addr: SocketAddr) -> Result<Self>
Helper to construct an endpoint for use with both incoming and outgoing connections
Platform defaults for dual-stack sockets vary. For example, any socket bound to a wildcard
IPv6 address on Windows will not by default be able to communicate with IPv4
addresses. Portable applications should bind an address that matches the family they wish to
communicate within.
-Sourcepub fn new(
config: EndpointConfig,
server_config: Option<ServerConfig>,
socket: UdpSocket,
runtime: Arc<dyn Runtime>,
) -> Result<Self>
Construct an endpoint with arbitrary configuration and socket
-Sourcepub fn new_with_abstract_socket(
+
Sourcepub fn new_with_abstract_socket(
config: EndpointConfig,
server_config: Option<ServerConfig>,
socket: Box<dyn AsyncUdpSocket>,
@@ -34,13 +34,13 @@ communicate within.
) -> Result<Self>
Construct an endpoint with arbitrary configuration and pre-constructed abstract socket
Useful when socket has additional state (e.g. sidechannels) attached for which shared
ownership is needed.
-Sourcepub fn accept(&self) -> Accept<'_> ⓘ
Get the next incoming connection attempt from a client
Yields Incomings, or None if the endpoint is closed. Incoming
can be awaited to obtain the final Connection, or used to e.g.
filter connection attempts or force address validation, or converted into an intermediate
Connecting future which can be used to e.g. send 0.5-RTT data.
-Sourcepub fn set_default_client_config(&mut self, config: ClientConfig)
Set the client configuration used by connect
-Sourcepub fn set_default_client_config(&self, config: ClientConfig)
Set the client configuration used by connect
+Sourcepub fn connect(
&self,
addr: SocketAddr,
server_name: &str,
@@ -50,26 +50,26 @@ connection from being intercepted by an attacker with a valid certificate for so
server.
May fail immediately due to configuration errors, or in the future if the connection could
not be established.
-
Sourcepub fn connect_with(
+
Sourcepub fn connect_with(
&self,
config: ClientConfig,
addr: SocketAddr,
server_name: &str,
) -> Result<Connecting, ConnectError>
Connect to a remote endpoint using a custom configuration.
See connect() for details.
-Sourcepub fn rebind(&self, socket: UdpSocket) -> Result<()>
Switch to a new UDP socket
See Endpoint::rebind_abstract() for details.
-Sourcepub fn rebind_abstract(&self, socket: Box<dyn AsyncUdpSocket>) -> Result<()>
Switch to a new UDP socket
+Sourcepub fn rebind_abstract(&self, socket: Box<dyn AsyncUdpSocket>) -> Result<()>
Switch to a new UDP socket
Allows the endpoint’s address to be updated live, affecting all active connections. Incoming
connections and connections to servers unreachable from the new address will be lost.
On error, the old UDP socket is retained.
-Sourcepub fn set_server_config(&self, server_config: Option<ServerConfig>)
Replace the server configuration, affecting new incoming connections only
+Sourcepub fn set_server_config(&self, server_config: Option<ServerConfig>)
Replace the server configuration, affecting new incoming connections only
Useful for e.g. refreshing TLS certificates without disrupting existing connections.
-Sourcepub fn local_addr(&self) -> Result<SocketAddr>
Get the local SocketAddr the underlying socket is bound to
-Sourcepub fn open_connections(&self) -> usize
Get the number of connections that are currently open
-Sourcepub fn close(&self, error_code: VarInt, reason: &[u8])
Close all of this endpoint’s connections immediately and cease accepting new connections.
+Sourcepub fn local_addr(&self) -> Result<SocketAddr>
Get the local SocketAddr the underlying socket is bound to
+Sourcepub fn open_connections(&self) -> usize
Get the number of connections that are currently open
+Sourcepub fn close(&self, error_code: VarInt, reason: &[u8])
Close all of this endpoint’s connections immediately and cease accepting new connections.
See Connection::close() for details.
-Sourcepub async fn wait_idle(&self)
Wait for all connections on the endpoint to be cleanly shut down
+Sourcepub async fn wait_idle(&self)
Wait for all connections on the endpoint to be cleanly shut down
Waiting for this condition before exiting ensures that a good-faith effort is made to notify
peers of recent connection closes, whereas exiting immediately could force them to wait out
the idle timeout period.
diff --git a/pr/255/docs/iroh_quinn/struct.EndpointStats.html b/pr/255/docs/iroh_quinn/struct.EndpointStats.html
index 4500b994a..efaa12c4b 100644
--- a/pr/255/docs/iroh_quinn/struct.EndpointStats.html
+++ b/pr/255/docs/iroh_quinn/struct.EndpointStats.html
@@ -1,4 +1,4 @@
-EndpointStats in iroh_quinn - Rust EndpointStats
#[non_exhaustive]pub struct EndpointStats {
+EndpointStats in iroh_quinn - Rust EndpointStats
#[non_exhaustive]pub struct EndpointStats {
pub accepted_handshakes: u64,
pub outgoing_handshakes: u64,
pub refused_handshakes: u64,
@@ -8,7 +8,7 @@
§outgoing_handshakes: u64Cumulative number of Quic handshakes sent from this Endpoint
§refused_handshakes: u64Cumulative number of Quic handshakes refused on this Endpoint
§ignored_handshakes: u64Cumulative number of Quic handshakes ignored on this Endpoint
-Trait Implementations§
Source§impl Clone for EndpointStats
Source§fn clone(&self) -> EndpointStats
Returns a duplicate of the value. Read more1.0.0 · Source§fn clone_from(&mut self, source: &Self)
Performs copy-assignment from source. Read moreSource§impl Debug for EndpointStats
Source§impl Default for EndpointStats
Source§fn default() -> EndpointStats
Returns the “default value” for a type. Read moreSource§impl Copy for EndpointStats
Auto Trait Implementations§
§impl Freeze for EndpointStats
§impl RefUnwindSafe for EndpointStats
§impl Send for EndpointStats
§impl Sync for EndpointStats
§impl Unpin for EndpointStats
§impl UnwindSafe for EndpointStats
Blanket Implementations§
Source§impl<T> Any for Twhere
+Trait Implementations§
Source§impl Clone for EndpointStats
Source§fn clone(&self) -> EndpointStats
Returns a duplicate of the value. Read more1.0.0 · Source§fn clone_from(&mut self, source: &Self)
Performs copy-assignment from source. Read moreSource§impl Debug for EndpointStats
Source§impl Default for EndpointStats
Source§fn default() -> EndpointStats
Returns the “default value” for a type. Read moreSource§impl Copy for EndpointStats
Auto Trait Implementations§
§impl Freeze for EndpointStats
§impl RefUnwindSafe for EndpointStats
§impl Send for EndpointStats
§impl Sync for EndpointStats
§impl Unpin for EndpointStats
§impl UnwindSafe for EndpointStats
Blanket Implementations§
Source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
Source§fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read moreSource§impl<T> CloneToUninit for Twhere
diff --git a/pr/255/docs/iroh_quinn/struct.InvalidCid.html b/pr/255/docs/iroh_quinn/struct.InvalidCid.html
new file mode 100644
index 000000000..8cc09d0a5
--- /dev/null
+++ b/pr/255/docs/iroh_quinn/struct.InvalidCid.html
@@ -0,0 +1,27 @@
+InvalidCid in iroh_quinn - Rust InvalidCid
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 more1.0.0 · Source§fn clone_from(&mut self, source: &Self)
Performs copy-assignment from source. Read moreSource§impl Debug for InvalidCid
Source§impl Copy for InvalidCid
Auto Trait Implementations§
§impl Freeze for InvalidCid
§impl RefUnwindSafe for InvalidCid
§impl Send for InvalidCid
§impl Sync for InvalidCid
§impl Unpin for InvalidCid
§impl UnwindSafe for InvalidCid
Blanket Implementations§
Source§impl<T> BorrowMut<T> for Twhere
+ T: ?Sized,
Source§fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read moreSource§impl<T> CloneToUninit for Twhere
+ T: Clone,
§impl<T> Instrument for T
§fn instrument(self, span: Span) -> Instrumented<Self>
§fn in_current_span(self) -> Instrumented<Self>
Source§impl<T> IntoEither for T
Source§fn into_either(self, into_left: bool) -> Either<Self, Self>
Converts self into a Left variant of Either<Self, Self>
+if into_left is true.
+Converts self into a Right variant of Either<Self, Self>
+otherwise. Read moreSource§fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
Converts self into a Left variant of Either<Self, Self>
+if into_left(&self) returns true.
+Converts self into a Right variant of Either<Self, Self>
+otherwise. Read more§impl<T> WithSubscriber for T
§fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>where
+ S: Into<Dispatch>,
§fn with_current_subscriber(self) -> WithDispatch<Self>
Attaches the current default Subscriber to this type, returning a
+[WithDispatch] wrapper. Read more
\ No newline at end of file
diff --git a/pr/255/docs/iroh_quinn/struct.Path.html b/pr/255/docs/iroh_quinn/struct.Path.html
index 5602610f3..e00724478 100644
--- a/pr/255/docs/iroh_quinn/struct.Path.html
+++ b/pr/255/docs/iroh_quinn/struct.Path.html
@@ -2,7 +2,7 @@
Implementations§
Source§impl Path
Sourcepub fn status(&self) -> Result<PathStatus, ClosedPath>
The current local PathStatus of this path.
Sourcepub fn set_status(&self, status: PathStatus) -> Result<(), SetPathStatusError>
Sets the PathStatus of this path.
-Sourcepub fn close(&self) -> Result<ClosePath, ClosePathError>
Closes this path
+Sourcepub fn close(&self) -> Result<ClosePath, ClosePathError>
Closes this path
The future will resolve when all the path state is dropped. This only happens after
the remote has confirmed the path as closed and after an additional timeout to
give any in-flight packets the time to arrive.
@@ -18,7 +18,7 @@ give any in-flight packets the time to arrive.
) -> Result<Option<Duration>, ClosedPath>Sets the keep_alive_interval for a specific path
See TransportConfig::default_path_keep_alive_interval for details.
Returns the previous value of the setting.
-Sourcepub fn observed_external_addr(&self) -> Result<AddressDiscovery, ClosedPath>
Track changes on our external address as reported by the peer.
+Sourcepub fn observed_external_addr(&self) -> Result<AddressDiscovery, ClosedPath>
Track changes on our external address as reported by the peer.
If the address-discovery extension is not negotiated, the stream will never return.
Sourcepub fn remote_address(&self) -> Result<SocketAddr, ClosedPath>
The peer’s UDP address for this path.
Sourcepub fn ping(&self) -> Result<(), ClosedPath>
Ping the remote endpoint over this path.
diff --git a/pr/255/docs/iroh_quinn/struct.SendStream.html b/pr/255/docs/iroh_quinn/struct.SendStream.html
index 069c8def7..0ec06cb61 100644
--- a/pr/255/docs/iroh_quinn/struct.SendStream.html
+++ b/pr/255/docs/iroh_quinn/struct.SendStream.html
@@ -8,7 +8,7 @@ ready will always result in no data being written to the stream. This is true of
succeed immediately when any progress is made, and is not true of methods which might need to
perform multiple writes internally before succeeding. Each write method documents whether it is
cancel-safe.
-Implementations§
Source§impl SendStream
Sourcepub async fn write(&mut self, buf: &[u8]) -> Result<usize, WriteError>
Write a buffer into this stream, returning how many bytes were written
+Implementations§
Source§impl SendStream
Sourcepub async fn write(&mut self, buf: &[u8]) -> Result<usize, WriteError>
Write a buffer into this stream, returning how many bytes were written
Unless this method errors, it waits until some amount of buf can be written into this
stream, and then writes as much as it can without waiting again. Due to congestion and flow
control, this may be shorter than buf.len(). On success this yields the length of the
@@ -58,7 +58,7 @@ or an error occurs. This method mutates bufs by mutating all chunks
§Cancel safety
This method is not cancellation safe. Even if this does not resolve, some bytes may have
been written when previously polled.
-Sourcepub fn finish(&mut self) -> Result<(), ClosedStream>
Notify the peer that no more data will ever be written to this stream
+Sourcepub fn finish(&mut self) -> Result<(), ClosedStream>
Notify the peer that no more data will ever be written to this stream
It is an error to write to a SendStream after finish()ing it. reset()
may still be called after finish to abandon transmission of any stream data that might
still be buffered.
@@ -66,21 +66,21 @@ still be buffered.
May fail if finish() or reset() was previously
called. This error is harmless and serves only to indicate that the caller may have
incorrect assumptions about the stream’s state.
-Sourcepub fn reset(&mut self, error_code: VarInt) -> Result<(), ClosedStream>
Close the send stream immediately.
+Sourcepub fn reset(&mut self, error_code: VarInt) -> Result<(), ClosedStream>
Close the send stream immediately.
No new data can be written after calling this method. Locally buffered data is dropped, and
previously transmitted data will no longer be retransmitted if lost. If an attempt has
already been made to finish the stream, the peer may still receive all written data.
May fail if finish() or reset() was previously
called. This error is harmless and serves only to indicate that the caller may have
incorrect assumptions about the stream’s state.
-Sourcepub fn set_priority(&self, priority: i32) -> Result<(), ClosedStream>
Set the priority of the send stream
+Sourcepub fn set_priority(&self, priority: i32) -> Result<(), ClosedStream>
Set the priority of the send stream
Every send stream has an initial priority of 0. Locally buffered data from streams with
higher priority will be transmitted before data from streams with lower priority. Changing
the priority of a stream with pending data may only take effect after that data has been
transmitted. Using many different priority levels per connection may have a negative
impact on performance.
-Sourcepub fn priority(&self) -> Result<i32, ClosedStream>
Get the priority of the send stream
-Sourcepub fn priority(&self) -> Result<i32, ClosedStream>
Get the priority of the send stream
+Sourcepub fn stopped(
&self,
) -> impl Future<Output = Result<Option<VarInt>, StoppedError>> + Send + Sync + 'static
Completes when the peer stops the stream or reads the stream to completion
Yields Some with the stop error code if the peer stops the stream. Yields None if the
@@ -90,8 +90,8 @@ closing the stream is no longer meaningful.
For a variety of reasons, the peer may not send acknowledgements immediately upon receiving
data. As such, relying on stopped to know when the peer has read a stream to completion
may introduce more latency than using an application-level response of some sort.
-Sourcepub fn poll_write(
+
Sourcepub fn poll_write(
self: Pin<&mut Self>,
cx: &mut Context<'_>,
buf: &[u8],
@@ -100,22 +100,22 @@ may introduce more latency than using an application-level response of some sort
If the stream is not ready for writing, the method returns Poll::Pending and arranges
for the current task (via cx.waker().wake_by_ref()) to receive a notification when the
stream becomes writable or is closed.
-
Trait Implementations§
Source§impl AsyncWrite for SendStream
Available on crate feature futures-io only.
Source§fn poll_write(
+
Trait Implementations§
Source§impl AsyncWrite for SendStream
Available on crate feature futures-io only.
Source§fn poll_write(
self: Pin<&mut Self>,
cx: &mut Context<'_>,
buf: &[u8],
-) -> Poll<Result<usize>>
Attempt to write bytes from buf into the object. Read moreSource§fn poll_flush(self: Pin<&mut Self>, _cx: &mut Context<'_>) -> Poll<Result<()>>
Attempt to flush the object, ensuring that any buffered data reach
-their destination. Read moreSource§fn poll_close(self: Pin<&mut Self>, _cx: &mut Context<'_>) -> Poll<Result<()>>
Attempt to close the object. Read more§fn poll_write_vectored(
+) -> Poll<Result<usize>>
Attempt to write bytes from buf into the object. Read moreSource§fn poll_flush(self: Pin<&mut Self>, _cx: &mut Context<'_>) -> Poll<Result<()>>
Attempt to flush the object, ensuring that any buffered data reach
+their destination. Read moreSource§impl AsyncWrite for SendStream
Source§fn poll_write(
+IO operations. Read more
Source§impl AsyncWrite for SendStream
Source§fn poll_write(
self: Pin<&mut Self>,
cx: &mut Context<'_>,
buf: &[u8],
-) -> Poll<Result<usize>>
Attempt to write bytes from buf into the object. Read moreSource§fn poll_flush(self: Pin<&mut Self>, _cx: &mut Context<'_>) -> Poll<Result<()>>
Attempts to flush the object, ensuring that any buffered data reach
-their destination. Read moreSource§fn poll_shutdown(
+) -> Poll<Result<usize>>
Attempt to write bytes from buf into the object. Read moreSource§fn poll_flush(self: Pin<&mut Self>, _cx: &mut Context<'_>) -> Poll<Result<()>>
Attempts to flush the object, ensuring that any buffered data reach
+their destination. Read moreSource§fn poll_shutdown(
self: Pin<&mut Self>,
_cx: &mut Context<'_>,
) -> Poll<Result<()>>
Initiates or attempts to shut down this writer, returning success when
@@ -124,7 +124,7 @@ the I/O connection has completely shut down. Read moreContext<'_>,
bufs: &[IoSlice<'_>],
) -> Poll<Result<usize, Error>>Like poll_write, except that it writes from a slice of buffers. Read more§fn is_write_vectored(&self) -> bool
Determines if this writer has an efficient poll_write_vectored
-implementation. Read more Source§impl Debug for SendStream
Auto Trait Implementations§
§impl Freeze for SendStream
§impl RefUnwindSafe for SendStream
§impl Send for SendStream
§impl Sync for SendStream
§impl Unpin for SendStream
§impl UnwindSafe for SendStream
Blanket Implementations§
Source§impl Debug for SendStream
Auto Trait Implementations§
§impl Freeze for SendStream
§impl RefUnwindSafe for SendStream
§impl Send for SendStream
§impl Sync for SendStream
§impl Unpin for SendStream
§impl UnwindSafe for SendStream
Blanket Implementations§
§impl<W> AsyncWriteExt for Wwhere
W: AsyncWrite + ?Sized,
§fn write<'a>(&'a mut self, src: &'a [u8]) -> Write<'a, Self>where
Self: Unpin,
Writes a buffer into this writer, returning how many bytes were
diff --git a/pr/255/docs/iroh_quinn/struct.StdSystemTime.html b/pr/255/docs/iroh_quinn/struct.StdSystemTime.html
index 601433e0b..75e3b81a5 100644
--- a/pr/255/docs/iroh_quinn/struct.StdSystemTime.html
+++ b/pr/255/docs/iroh_quinn/struct.StdSystemTime.html
@@ -1,6 +1,6 @@
-StdSystemTime in iroh_quinn - Rust StdSystemTime
pub struct StdSystemTime;
Expand description
Default implementation of TimeSource
+StdSystemTime in iroh_quinn - Rust StdSystemTime
pub struct StdSystemTime;
Expand description
Default implementation of TimeSource
Implements now by calling SystemTime::now().
-Trait Implementations§
Source§impl TimeSource for StdSystemTime
Source§fn now(&self) -> SystemTime
Get SystemTime::now() or the mocked equivalentAuto Trait Implementations§
§impl Freeze for StdSystemTime
§impl RefUnwindSafe for StdSystemTime
§impl Send for StdSystemTime
§impl Sync for StdSystemTime
§impl Unpin for StdSystemTime
§impl UnwindSafe for StdSystemTime
Blanket Implementations§
Trait Implementations§
Source§impl TimeSource for StdSystemTime
Source§fn now(&self) -> SystemTime
Get SystemTime::now() or the mocked equivalentAuto Trait Implementations§
§impl Freeze for StdSystemTime
§impl RefUnwindSafe for StdSystemTime
§impl Send for StdSystemTime
§impl Sync for StdSystemTime
§impl Unpin for StdSystemTime
§impl UnwindSafe for StdSystemTime
Blanket Implementations§
Source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
Source§fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read moreSource§impl<T> From<T> for T
Source§fn from(t: T) -> T
Returns the argument unchanged.
diff --git a/pr/255/docs/iroh_quinn/struct.StreamId.html b/pr/255/docs/iroh_quinn/struct.StreamId.html
index 7d288c046..cd7352208 100644
--- a/pr/255/docs/iroh_quinn/struct.StreamId.html
+++ b/pr/255/docs/iroh_quinn/struct.StreamId.html
@@ -1,26 +1,26 @@
-StreamId in iroh_quinn - Rust StreamId
pub struct StreamId(/* private fields */);
Expand description
Identifier for a stream within a particular connection
-Implementations§
Trait Implementations§
Source§impl<'arbitrary> Arbitrary<'arbitrary> for StreamId
Source§fn arbitrary(u: &mut Unstructured<'arbitrary>) -> Result<StreamId, Error>
Generate an arbitrary value of Self from the given unstructured data. Read moreSource§fn arbitrary_take_rest(u: Unstructured<'arbitrary>) -> Result<StreamId, Error>
Generate an arbitrary value of Self from the entirety of the given
-unstructured data. Read moreSource§fn size_hint(depth: usize) -> (usize, Option<usize>)
Get a size hint for how many bytes out of an Unstructured this type
-needs to construct itself. Read moreSource§fn try_size_hint(
+StreamId in iroh_quinn - Rust StreamId
pub struct StreamId(/* private fields */);
Expand description
Identifier for a stream within a particular connection
+Implementations§
Trait Implementations§
Source§impl<'arbitrary> Arbitrary<'arbitrary> for StreamId
Source§fn arbitrary(u: &mut Unstructured<'arbitrary>) -> Result<StreamId, Error>
Generate an arbitrary value of Self from the given unstructured data. Read moreSource§fn arbitrary_take_rest(u: Unstructured<'arbitrary>) -> Result<StreamId, Error>
Generate an arbitrary value of Self from the entirety of the given
+unstructured data. Read moreSource§impl Ord for StreamId
Source§impl PartialOrd for StreamId
Source§impl PartialOrd for StreamId
Source§impl Copy for StreamId
Source§impl Eq for StreamId
Source§impl StructuralPartialEq for StreamId
Auto Trait Implementations§
§impl Freeze for StreamId
§impl RefUnwindSafe for StreamId
§impl Send for StreamId
§impl Sync for StreamId
§impl Unpin for StreamId
§impl UnwindSafe for StreamId
Blanket Implementations§
Source§impl Copy for StreamId
Source§impl Eq for StreamId
Source§impl StructuralPartialEq for StreamId
Auto Trait Implementations§
§impl Freeze for StreamId
§impl RefUnwindSafe for StreamId
§impl Send for StreamId
§impl Sync for StreamId
§impl Unpin for StreamId
§impl UnwindSafe for StreamId
Blanket Implementations§
Source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
Source§fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read moreSource§impl<T> CloneToUninit for Twhere
diff --git a/pr/255/docs/iroh_quinn/struct.Transmit.html b/pr/255/docs/iroh_quinn/struct.Transmit.html
index c36db78b0..10970ac6e 100644
--- a/pr/255/docs/iroh_quinn/struct.Transmit.html
+++ b/pr/255/docs/iroh_quinn/struct.Transmit.html
@@ -1,4 +1,4 @@
-Transmit in iroh_quinn - Rust Transmit
pub struct Transmit {
+Transmit in iroh_quinn - Rust Transmit
pub struct Transmit {
pub destination: SocketAddr,
pub ecn: Option<EcnCodepoint>,
pub size: usize,
@@ -11,7 +11,7 @@
§segment_size: Option<usize>The segment size if this transmission contains multiple datagrams.
This is None if the transmit only contains a single datagram
§src_ip: Option<IpAddr>Optional source IP address for the datagram
-Trait Implementations§
Fields§
§upload_stats: Stats§download_stats: StatsImplementations§
Trait Implementations§
Source§impl Default for ClientStats
impl Default for ClientStats
Source§fn default() -> ClientStats
fn default() -> ClientStats
Auto Trait Implementations§
impl Freeze for ClientStats
impl RefUnwindSafe for ClientStats
impl Send for ClientStats
impl Sync for ClientStats
impl Unpin for ClientStats
impl UnwindSafe for ClientStats
Blanket Implementations§
Source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
Source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Source§impl<T> From<T> for T
impl<T> From<T> for T
Source§fn from(t: T) -> T
fn from(t: T) -> T
Returns the argument unchanged.
diff --git a/pr/255/docs/iroh_quinn/all.html b/pr/255/docs/iroh_quinn/all.html index 9efe65aca..4ca955f58 100644 --- a/pr/255/docs/iroh_quinn/all.html +++ b/pr/255/docs/iroh_quinn/all.html @@ -1 +1 @@ -All
List of all items
Structs
- Accept
- AcceptBi
- AcceptUni
- AckFrequencyConfig
- ApplicationClose
- BloomTokenLog
- Chunk
- ClientConfig
- ClosedStream
- Connecting
- Connection
- ConnectionClose
- ConnectionId
- ConnectionStats
- Endpoint
- EndpointConfig
- EndpointStats
- FrameStats
- IdleTimeout
- Incoming
- IncomingFuture
- MtuDiscoveryConfig
- NoneTokenLog
- NoneTokenStore
- OnClosed
- OpenBi
- OpenPath
- OpenUni
- Path
- PathId
- PathStats
- QlogConfig
- QlogFileFactory
- ReadDatagram
- RecvStream
- RetryError
- SendDatagram
- SendStream
- ServerConfig
- SmolRuntime
- StdSystemTime
- StreamId
- TokenMemoryCache
- TokenReuseError
- TokioRuntime
- Transmit
- TransportConfig
- TransportErrorCode
- UdpStats
- UnorderedRecvStream
- ValidationTokenConfig
- VarInt
- VarIntBoundsExceeded
- WeakConnectionHandle
- Written
- ZeroRttAccepted
- congestion::Bbr
- congestion::BbrConfig
- congestion::ControllerMetrics
- congestion::Cubic
- congestion::CubicConfig
- congestion::NewReno
- congestion::NewRenoConfig
- crypto::CryptoError
- crypto::ExportKeyingMaterialError
- crypto::KeyPair
- crypto::Keys
- crypto::UnsupportedVersion
- crypto::rustls::HandshakeData
- crypto::rustls::NoInitialCipherSuite
- crypto::rustls::QuicClientConfig
- crypto::rustls::QuicServerConfig
- crypto::rustls::TlsSession
Enums
- ConfigError
- ConnectError
- ConnectionError
- Dir
- EcnCodepoint
- FrameType
- ReadError
- ReadExactError
- ReadToEndError
- ResetError
- SendDatagramError
- Side
- StoppedError
- WriteError
- crypto::rustls::Error
Traits
- AsyncTimer
- AsyncUdpSocket
- ConnectionIdGenerator
- QlogFactory
- Runtime
- TimeSource
- TokenLog
- TokenStore
- UdpSender
- congestion::Controller
- congestion::ControllerFactory
- crypto::AeadKey
- crypto::ClientConfig
- crypto::HandshakeTokenKey
- crypto::HeaderKey
- crypto::HmacKey
- crypto::PacketKey
- crypto::ServerConfig
- crypto::Session
Functions
All
List of all items
Structs
- Accept
- AcceptBi
- AcceptUni
- AckFrequencyConfig
- AddressDiscovery
- ApplicationClose
- BloomTokenLog
- Chunk
- ClientConfig
- ClosePath
- ClosedStream
- Connecting
- Connection
- ConnectionClose
- ConnectionId
- ConnectionStats
- Endpoint
- EndpointConfig
- EndpointStats
- FrameStats
- IdleTimeout
- Incoming
- IncomingFuture
- InvalidCid
- MtuDiscoveryConfig
- NoneTokenLog
- NoneTokenStore
- OnClosed
- OpenBi
- OpenPath
- OpenUni
- Path
- PathId
- PathStats
- QlogConfig
- QlogFileFactory
- ReadDatagram
- RecvStream
- RetryError
- SendDatagram
- SendStream
- ServerConfig
- SmolRuntime
- StdSystemTime
- StreamId
- TokenMemoryCache
- TokenReuseError
- TokioRuntime
- Transmit
- TransportConfig
- TransportErrorCode
- UdpStats
- UnorderedRecvStream
- ValidationTokenConfig
- VarInt
- VarIntBoundsExceeded
- WeakConnectionHandle
- Written
- ZeroRttAccepted
- congestion::Bbr
- congestion::BbrConfig
- congestion::ControllerMetrics
- congestion::Cubic
- congestion::CubicConfig
- congestion::NewReno
- congestion::NewRenoConfig
- crypto::CryptoError
- crypto::ExportKeyingMaterialError
- crypto::KeyPair
- crypto::Keys
- crypto::UnsupportedVersion
- crypto::rustls::HandshakeData
- crypto::rustls::NoInitialCipherSuite
- crypto::rustls::QuicClientConfig
- crypto::rustls::QuicServerConfig
- crypto::rustls::TlsSession
Enums
- ConfigError
- ConnectError
- ConnectionError
- Dir
- EcnCodepoint
- FrameType
- ReadError
- ReadExactError
- ReadToEndError
- ResetError
- SendDatagramError
- Side
- StoppedError
- WriteError
- crypto::rustls::Error
Traits
- AsyncTimer
- AsyncUdpSocket
- ConnectionIdGenerator
- QlogFactory
- Runtime
- TimeSource
- TokenLog
- TokenStore
- UdpSender
- congestion::Controller
- congestion::ControllerFactory
- crypto::AeadKey
- crypto::ClientConfig
- crypto::HandshakeTokenKey
- crypto::HeaderKey
- crypto::HmacKey
- crypto::PacketKey
- crypto::ServerConfig
- crypto::Session
Functions
Module congestion
Expand description
Logic for controlling the rate at which data is sent
+Module congestion
Expand description
Logic for controlling the rate at which data is sent
Structs§
- Bbr
- Experimental! Use at your own risk.
- BbrConfig
- Configuration for the
Bbrcongestion controller - Controller
Metrics - Common congestion controller metrics
- Cubic
- The RFC8312 congestion controller, as widely used for TCP
- Cubic
Config - Configuration for the
Cubiccongestion controller - NewReno
- A simple, standard congestion controller
- NewReno
Config - Configuration for the
NewRenocongestion controller
Traits§
- Controller
- Common interface for different congestion controllers
- Controller
Factory - Constructs controllers on demand
Implementations§
Trait Implementations§
Trait Implementations§
Source§impl Controller for Bbr
impl Controller for Bbr
Source§fn on_sent(&mut self, now: Instant, bytes: u64, last_packet_number: u64)
fn on_sent(&mut self, now: Instant, bytes: u64, last_packet_number: u64)
Source§fn on_ack(
&mut self,
now: Instant,
sent: Instant,
bytes: u64,
app_limited: bool,
rtt: &RttEstimator,
-)
fn on_ack( &mut self, now: Instant, sent: Instant, bytes: u64, app_limited: bool, rtt: &RttEstimator, -)
Source§fn on_end_acks(
+)
fn on_end_acks( +)
Source§fn on_end_acks(
&mut self,
now: Instant,
in_flight: u64,
app_limited: bool,
largest_packet_num_acked: Option<u64>,
-)
fn on_end_acks( &mut self, now: Instant, in_flight: u64, app_limited: bool, largest_packet_num_acked: Option<u64>, -)
now argument. This indicates one of those batches has completed.Source§fn on_congestion_event(
+)
fn on_congestion_event( +)
now argument. This indicates one of those batches has completed.Source§fn on_congestion_event(
&mut self,
_now: Instant,
_sent: Instant,
_is_persistent_congestion: bool,
_is_ecn: bool,
lost_bytes: u64,
-)
fn on_congestion_event( &mut self, _now: Instant, _sent: Instant, _is_persistent_congestion: bool, _is_ecn: bool, lost_bytes: u64, -)
Source§fn on_mtu_update(&mut self, new_mtu: u16)
fn on_mtu_update(&mut self, new_mtu: u16)
Source§fn metrics(&self) -> ControllerMetrics
fn metrics(&self) -> ControllerMetrics
qlog traces when they are enabledSource§fn clone_box(&self) -> Box<dyn Controller>
fn clone_box(&self) -> Box<dyn Controller>
Source§fn initial_window(&self) -> u64
fn initial_window(&self) -> u64
Source§fn into_any(self: Box<Bbr>) -> Box<dyn Any>
fn into_any(self: Box<Bbr>) -> Box<dyn Any>
Source§fn on_spurious_congestion_event(&mut self)
fn on_spurious_congestion_event(&mut self)
Auto Trait Implementations§
impl Freeze for Bbr
impl RefUnwindSafe for Bbr
impl Send for Bbr
impl Sync for Bbr
impl Unpin for Bbr
impl UnwindSafe for Bbr
Blanket Implementations§
Source§impl<T> Any for Twhere
+)Packets were deemed lost or marked congested Read moreSource§fn on_mtu_update(&mut self, new_mtu: u16)
The known MTU for the current network path has been updatedSource§fn metrics(&self) -> ControllerMetrics
Retrieve implementation-specific metrics used to populate qlog traces when they are enabledSource§fn clone_box(&self) -> Box<dyn Controller>
Duplicate the controller’s stateSource§fn initial_window(&self) -> u64
Initial congestion windowSource§fn into_any(self: Box<Bbr>) -> Box<dyn Any>
Returns Self for use in down-casting to extract implementation detailsSource§fn on_spurious_congestion_event(&mut self)
Packets were incorrectly deemed lost Read more
impl<T> Any for Twhere
+)Packets were deemed lost or marked congested Read moreSource§fn on_mtu_update(&mut self, new_mtu: u16)
The known MTU for the current network path has been updatedSource§fn metrics(&self) -> ControllerMetrics
Retrieve implementation-specific metrics used to populate qlog traces when they are enabledSource§fn clone_box(&self) -> Box<dyn Controller>
Duplicate the controller’s stateSource§fn initial_window(&self) -> u64
Initial congestion windowSource§fn into_any(self: Box<Bbr>) -> Box<dyn Any>
Returns Self for use in down-casting to extract implementation detailsSource§fn on_spurious_congestion_event(&mut self)
Packets were incorrectly deemed lost Read more
Source§fn on_mtu_update(&mut self, new_mtu: u16)
fn on_mtu_update(&mut self, new_mtu: u16)
Source§fn metrics(&self) -> ControllerMetrics
fn metrics(&self) -> ControllerMetrics
qlog traces when they are enabledSource§fn clone_box(&self) -> Box<dyn Controller>
fn clone_box(&self) -> Box<dyn Controller>
Source§fn initial_window(&self) -> u64
fn initial_window(&self) -> u64
Source§fn into_any(self: Box<Bbr>) -> Box<dyn Any>
fn into_any(self: Box<Bbr>) -> Box<dyn Any>
Source§fn on_spurious_congestion_event(&mut self)
fn on_spurious_congestion_event(&mut self)
Auto Trait Implementations§
impl Freeze for Bbr
impl RefUnwindSafe for Bbr
impl Send for Bbr
impl Sync for Bbr
impl Unpin for Bbr
impl UnwindSafe for Bbr
Blanket Implementations§
Source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
Source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Source§impl<T> CloneToUninit for Twhere
diff --git a/pr/255/docs/iroh_quinn/congestion/struct.BbrConfig.html b/pr/255/docs/iroh_quinn/congestion/struct.BbrConfig.html
index f340fb3e2..c931fff20 100644
--- a/pr/255/docs/iroh_quinn/congestion/struct.BbrConfig.html
+++ b/pr/255/docs/iroh_quinn/congestion/struct.BbrConfig.html
@@ -1,11 +1,11 @@
-BbrConfig in iroh_quinn::congestion - Rust BbrConfig
pub struct BbrConfig { /* private fields */ }
Expand description
Configuration for the Bbr congestion controller
-Implementations§
Source§impl BbrConfig
Sourcepub fn initial_window(&mut self, value: u64) -> &mut BbrConfig
Default limit on the amount of outstanding data in bytes.
+BbrConfig in iroh_quinn::congestion - Rust BbrConfig
pub struct BbrConfig { /* private fields */ }
Expand description
Configuration for the Bbr congestion controller
+Implementations§
Trait Implementations§
Trait Implementations§
Source§impl ControllerFactory for BbrConfig
Auto Trait Implementations§
§impl Freeze for BbrConfig
§impl RefUnwindSafe for BbrConfig
§impl Send for BbrConfig
§impl Sync for BbrConfig
§impl Unpin for BbrConfig
§impl UnwindSafe for BbrConfig
Blanket Implementations§
Auto Trait Implementations§
§impl Freeze for BbrConfig
§impl RefUnwindSafe for BbrConfig
§impl Send for BbrConfig
§impl Sync for BbrConfig
§impl Unpin for BbrConfig
§impl UnwindSafe for BbrConfig
Blanket Implementations§
Source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
Source§fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read moreSource§impl<T> CloneToUninit for Twhere
diff --git a/pr/255/docs/iroh_quinn/congestion/trait.Controller.html b/pr/255/docs/iroh_quinn/congestion/trait.Controller.html
index 6fd6a4943..c582370df 100644
--- a/pr/255/docs/iroh_quinn/congestion/trait.Controller.html
+++ b/pr/255/docs/iroh_quinn/congestion/trait.Controller.html
@@ -76,4 +76,4 @@ application data prior to receiving these acknowledgements.
This function is called when all packets that were deemed lost (for instance because
of packet reordering) are acknowledged after the congestion event was raised.
Sourcefn metrics(&self) -> ControllerMetrics
Retrieve implementation-specific metrics used to populate qlog traces when they are enabled
-Implementors§
\ No newline at end of file
+Implementors§
\ No newline at end of file
diff --git a/pr/255/docs/iroh_quinn/congestion/trait.ControllerFactory.html b/pr/255/docs/iroh_quinn/congestion/trait.ControllerFactory.html
index 056571893..5f8ab4fc4 100644
--- a/pr/255/docs/iroh_quinn/congestion/trait.ControllerFactory.html
+++ b/pr/255/docs/iroh_quinn/congestion/trait.ControllerFactory.html
@@ -7,4 +7,4 @@
) -> Box<dyn Controller>;
}Expand description
Constructs controllers on demand
Required Methods§
Implementors§
Source§impl ControllerFactory for BbrConfig
Source§impl ControllerFactory for CubicConfig
Source§impl ControllerFactory for NewRenoConfig
\ No newline at end of file
+
impl<T> CloneToUninit for Twhere
diff --git a/pr/255/docs/iroh_quinn/congestion/struct.BbrConfig.html b/pr/255/docs/iroh_quinn/congestion/struct.BbrConfig.html
index f340fb3e2..c931fff20 100644
--- a/pr/255/docs/iroh_quinn/congestion/struct.BbrConfig.html
+++ b/pr/255/docs/iroh_quinn/congestion/struct.BbrConfig.html
@@ -1,11 +1,11 @@
-BbrConfig in iroh_quinn::congestion - Rust BbrConfig
pub struct BbrConfig { /* private fields */ }
Expand description
Configuration for the Bbr congestion controller
-Implementations§
Source§impl BbrConfig
Sourcepub fn initial_window(&mut self, value: u64) -> &mut BbrConfig
Default limit on the amount of outstanding data in bytes.
+BbrConfig in iroh_quinn::congestion - Rust BbrConfig
pub struct BbrConfig { /* private fields */ }
Expand description
Configuration for the Bbr congestion controller
+Implementations§
Trait Implementations§
Trait Implementations§
Source§impl ControllerFactory for BbrConfig
Auto Trait Implementations§
§impl Freeze for BbrConfig
§impl RefUnwindSafe for BbrConfig
§impl Send for BbrConfig
§impl Sync for BbrConfig
§impl Unpin for BbrConfig
§impl UnwindSafe for BbrConfig
Blanket Implementations§
Auto Trait Implementations§
§impl Freeze for BbrConfig
§impl RefUnwindSafe for BbrConfig
§impl Send for BbrConfig
§impl Sync for BbrConfig
§impl Unpin for BbrConfig
§impl UnwindSafe for BbrConfig
Blanket Implementations§
Source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
Source§fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read moreSource§impl<T> CloneToUninit for Twhere
diff --git a/pr/255/docs/iroh_quinn/congestion/trait.Controller.html b/pr/255/docs/iroh_quinn/congestion/trait.Controller.html
index 6fd6a4943..c582370df 100644
--- a/pr/255/docs/iroh_quinn/congestion/trait.Controller.html
+++ b/pr/255/docs/iroh_quinn/congestion/trait.Controller.html
@@ -76,4 +76,4 @@ application data prior to receiving these acknowledgements.
This function is called when all packets that were deemed lost (for instance because
of packet reordering) are acknowledged after the congestion event was raised.
Sourcefn metrics(&self) -> ControllerMetrics
Retrieve implementation-specific metrics used to populate qlog traces when they are enabled
-Implementors§
\ No newline at end of file
+Implementors§
\ No newline at end of file
diff --git a/pr/255/docs/iroh_quinn/congestion/trait.ControllerFactory.html b/pr/255/docs/iroh_quinn/congestion/trait.ControllerFactory.html
index 056571893..5f8ab4fc4 100644
--- a/pr/255/docs/iroh_quinn/congestion/trait.ControllerFactory.html
+++ b/pr/255/docs/iroh_quinn/congestion/trait.ControllerFactory.html
@@ -7,4 +7,4 @@
) -> Box<dyn Controller>;
}Expand description
Constructs controllers on demand
Required Methods§
Implementors§
Source§impl ControllerFactory for BbrConfig
Source§impl ControllerFactory for CubicConfig
Source§impl ControllerFactory for NewRenoConfig
\ No newline at end of file
+
BbrConfig
pub struct BbrConfig { /* private fields */ }Expand description
Configuration for the Bbr congestion controller
Implementations§
Source§impl BbrConfig
impl BbrConfig
Sourcepub fn initial_window(&mut self, value: u64) -> &mut BbrConfig
pub fn initial_window(&mut self, value: u64) -> &mut BbrConfig
Default limit on the amount of outstanding data in bytes.
+BbrConfig
pub struct BbrConfig { /* private fields */ }Expand description
Configuration for the Bbr congestion controller
Implementations§
Trait Implementations§
Trait Implementations§
Source§impl ControllerFactory for BbrConfig
impl ControllerFactory for BbrConfig
Auto Trait Implementations§
impl Freeze for BbrConfig
impl RefUnwindSafe for BbrConfig
impl Send for BbrConfig
impl Sync for BbrConfig
impl Unpin for BbrConfig
impl UnwindSafe for BbrConfig
Blanket Implementations§
Auto Trait Implementations§
impl Freeze for BbrConfig
impl RefUnwindSafe for BbrConfig
impl Send for BbrConfig
impl Sync for BbrConfig
impl Unpin for BbrConfig
impl UnwindSafe for BbrConfig
Blanket Implementations§
Source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
Source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Source§impl<T> CloneToUninit for Twhere
diff --git a/pr/255/docs/iroh_quinn/congestion/trait.Controller.html b/pr/255/docs/iroh_quinn/congestion/trait.Controller.html
index 6fd6a4943..c582370df 100644
--- a/pr/255/docs/iroh_quinn/congestion/trait.Controller.html
+++ b/pr/255/docs/iroh_quinn/congestion/trait.Controller.html
@@ -76,4 +76,4 @@ application data prior to receiving these acknowledgements.
This function is called when all packets that were deemed lost (for instance because
of packet reordering) are acknowledged after the congestion event was raised.
impl<T> CloneToUninit for Twhere
diff --git a/pr/255/docs/iroh_quinn/congestion/trait.Controller.html b/pr/255/docs/iroh_quinn/congestion/trait.Controller.html
index 6fd6a4943..c582370df 100644
--- a/pr/255/docs/iroh_quinn/congestion/trait.Controller.html
+++ b/pr/255/docs/iroh_quinn/congestion/trait.Controller.html
@@ -76,4 +76,4 @@ application data prior to receiving these acknowledgements.
This function is called when all packets that were deemed lost (for instance because
of packet reordering) are acknowledged after the congestion event was raised.
This function is called when all packets that were deemed lost (for instance because of packet reordering) are acknowledged after the congestion event was raised.
Sourcefn metrics(&self) -> ControllerMetrics
fn metrics(&self) -> ControllerMetrics
Retrieve implementation-specific metrics used to populate qlog traces when they are enabled
Implementors§
Implementors§
Expand description
Constructs controllers on demand
Required Methods§
Implementors§
impl ControllerFactory for BbrConfig
impl ControllerFactory for CubicConfig
impl ControllerFactory for NewRenoConfig
Implementors§
impl ControllerFactory for BbrConfig
impl ControllerFactory for CubicConfig
impl ControllerFactory for NewRenoConfig
QuicClientConfig
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::with_platform_verifier().
+ClientConfig::with_root_certificates() and ClientConfig::try_with_platform_verifier().
Alternatively, QuicClientConfig’s TryFrom implementation can be used to wrap around a
custom [rustls::ClientConfig], in which case care should be taken around certain points:
-
diff --git a/pr/255/docs/iroh_quinn/enum.ConfigError.html b/pr/255/docs/iroh_quinn/enum.ConfigError.html
index f0a6f72ec..ce5f3a366 100644
--- a/pr/255/docs/iroh_quinn/enum.ConfigError.html
+++ b/pr/255/docs/iroh_quinn/enum.ConfigError.html
@@ -1,9 +1,9 @@
-
pub use rustls;pub use udp;- congestion
- Logic for controlling the rate at which data is sent
- crypto
- Traits and implementations for the QUIC cryptography protocol
- Accept
- Future produced by
Endpoint::accept - Accept
Bi - Future produced by
Connection::accept_bi - Accept
Uni - Future produced by
Connection::accept_uni - AckFrequency
Config - Parameters for controlling the peer’s acknowledgement frequency
- Application
Close - Reason given by an application for closing the connection
- Bloom
Token Log - Bloom filter-based
TokenLog - Chunk
- A chunk of data from the receive stream
- Client
Config - Configuration for outgoing connections
- Closed
Stream - Error indicating that a stream has not been opened or has already been finished or reset
- Connecting
- In-progress connection attempt future
- Connection
- A QUIC connection.
- Connection
Close - Reason given by the transport for closing the connection
- Connection
Id - Protocol-level identifier for a connection.
- Connection
Stats - Connection statistics
- Endpoint
- A QUIC endpoint.
- Endpoint
Config - Global configuration for the endpoint, affecting all connections
- Endpoint
Stats - Statistics on Endpoint activity
- Frame
Stats - Number of frames transmitted or received of each frame type
- Idle
Timeout - Maximum duration of inactivity to accept before timing out the connection
- Incoming
- An incoming connection for which the server has not yet begun its part of the handshake
- Incoming
Future - Basic adapter to let
Incomingbeawait-ed like aConnecting - MtuDiscovery
Config - Parameters governing MTU discovery.
- None
Token Log - Null implementation of
TokenLog, which never accepts tokens - None
Token Store - Null implementation of
TokenStore, which does not store any tokens - OnClosed
- Future returned by
Connection::on_closed - OpenBi
- Future produced by
Connection::open_bi - Open
Path - Future produced by
crate::Connection::open_path - OpenUni
- Future produced by
Connection::open_uni - Path
- An open (Multi)Path
- PathId
- Id representing different paths when using multipath extension
- Path
Stats - Statistics related to a transmission path
- Qlog
Config - Configuration for qlog trace logging.
- Qlog
File Factory - Enables writing qlog traces to a directory.
- Read
Datagram - Future produced by
Connection::read_datagram - Recv
Stream - A stream that can only be used to receive data
- Retry
Error - Error for attempting to retry an
Incomingwhich already bears a token from a previous retry - Send
Datagram - Future produced by
Connection::send_datagram_wait - Send
Stream - A stream that can only be used to send data
- Server
Config - Parameters governing incoming connections
- Smol
Runtime - A Quinn runtime for smol
- StdSystem
Time - Default implementation of
TimeSource - Stream
Id - Identifier for a stream within a particular connection
- Token
Memory Cache TokenStoreimplementation that stores up toNtokens per server name for up to a +pub use rustls;pub use udp;- congestion
- Logic for controlling the rate at which data is sent
- crypto
- Traits and implementations for the QUIC cryptography protocol
- Accept
- Future produced by
Endpoint::accept - Accept
Bi - Future produced by
Connection::accept_bi - Accept
Uni - Future produced by
Connection::accept_uni - AckFrequency
Config - Parameters for controlling the peer’s acknowledgement frequency
- Address
Discovery - Stream produced by
Path::observed_external_addr - Application
Close - Reason given by an application for closing the connection
- Bloom
Token Log - Bloom filter-based
TokenLog - Chunk
- A chunk of data from the receive stream
- Client
Config - Configuration for outgoing connections
- Close
Path - Future produced by
Path::close - Closed
Stream - Error indicating that a stream has not been opened or has already been finished or reset
- Connecting
- In-progress connection attempt future
- Connection
- A QUIC connection.
- Connection
Close - Reason given by the transport for closing the connection
- Connection
Id - Protocol-level identifier for a connection.
- Connection
Stats - Connection statistics
- Endpoint
- A QUIC endpoint.
- Endpoint
Config - Global configuration for the endpoint, affecting all connections
- Endpoint
Stats - Statistics on Endpoint activity
- Frame
Stats - Number of frames transmitted or received of each frame type
- Idle
Timeout - Maximum duration of inactivity to accept before timing out the connection
- Incoming
- An incoming connection for which the server has not yet begun its part of the handshake
- Incoming
Future - Basic adapter to let
Incomingbeawait-ed like aConnecting - Invalid
Cid - The connection ID was not recognized by the
ConnectionIdGenerator - MtuDiscovery
Config - Parameters governing MTU discovery.
- None
Token Log - Null implementation of
TokenLog, which never accepts tokens - None
Token Store - Null implementation of
TokenStore, which does not store any tokens - OnClosed
- Future returned by
Connection::on_closed - OpenBi
- Future produced by
Connection::open_bi - Open
Path - Future produced by
crate::Connection::open_path - OpenUni
- Future produced by
Connection::open_uni - Path
- An open (Multi)Path
- PathId
- Id representing different paths when using multipath extension
- Path
Stats - Statistics related to a transmission path
- Qlog
Config - Configuration for qlog trace logging.
- Qlog
File Factory - Enables writing qlog traces to a directory.
- Read
Datagram - Future produced by
Connection::read_datagram - Recv
Stream - A stream that can only be used to receive data
- Retry
Error - Error for attempting to retry an
Incomingwhich already bears a token from a previous retry - Send
Datagram - Future produced by
Connection::send_datagram_wait - Send
Stream - A stream that can only be used to send data
- Server
Config - Parameters governing incoming connections
- Smol
Runtime - A Quinn runtime for smol
- StdSystem
Time - Default implementation of
TimeSource - Stream
Id - Identifier for a stream within a particular connection
- Token
Memory Cache TokenStoreimplementation that stores up toNtokens per server name for up to a limited number of server names, in-memory- Token
Reuse Error - Error for when a validation token may have been reused
- Tokio
Runtime - A Quinn runtime for Tokio
- Transmit
- An outgoing packet
- Transport
Config - Parameters governing the core QUIC state machine
- Transport
Error Code - Transport-level error code
- UdpStats
- Statistics about UDP datagrams transmitted or received on a connection
- Unordered
Recv Stream - A stream that can be used to receive data out-of-order.
- Validation
Token Config - Configuration for sending and handling validation tokens in incoming connections
- VarInt
- An integer less than 2^62
- VarInt
Bounds Exceeded - Error returned when constructing a
VarIntfrom a value >= 2^62 - Weak
Connection Handle - A handle to some connection internals, use with care.
- Written
- Indicates how many bytes and chunks had been transferred in a write operation
- Zero
RttAccepted - Future that completes when a connection is fully established
- Config
Error - Errors in the configuration of an endpoint
- Connect
Error - Errors in the parameters being used to create a new connection
- Connection
Error - Reasons why a connection might be lost
- Dir
- Whether a stream communicates data in both directions or only from the initiator
- EcnCodepoint
- Explicit congestion notification codepoint
- Frame
Type - Read
Error - Errors that arise from reading from a stream.
- Read
Exact Error - Errors that arise from reading from a stream.
- Read
ToEnd Error - Errors from
RecvStream::read_to_end - Reset
Error - Errors that arise while waiting for a stream to be reset
- Send
Datagram Error - Errors that can arise when sending a datagram
- Side
- Whether an endpoint was the initiator of a connection
- Stopped
Error - Errors that arise while monitoring for a send stream stop from the peer
- Write
Error - Errors that arise from writing to a stream
- Async
Timer - Abstract implementation of an async timer for runtime independence
- Async
UdpSocket - Abstract implementation of a UDP socket for runtime independence
- Connection
IdGenerator - Generates connection IDs for incoming connections
- Qlog
Factory - Constructs a
QlogConfigfor individual connections. - Runtime
- Abstracts I/O and timer operations for runtime independence
- Time
Source - Object to get current
SystemTime - Token
Log - Responsible for limiting clients’ ability to reuse validation tokens
- Token
Store - Responsible for storing validation tokens received from servers and retrieving them for use in subsequent connections
- UdpSender
- An object for asynchronously writing to an associated
AsyncUdpSocket. - default_
runtime - Automatically select an appropriate runtime from those enabled at compile time
ConfigError
#[non_exhaustive]pub enum ConfigError {
+ConfigError in iroh_quinn - Rust ConfigError
#[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
-Trait Implementations§
Source§impl Clone for ConfigError
Source§fn clone(&self) -> ConfigError
Returns a duplicate of the value. Read more1.0.0 · Source§fn clone_from(&mut self, source: &Self)
Performs copy-assignment from source. Read moreSource§impl Debug for ConfigError
Source§impl Display for ConfigError
Source§impl Error for ConfigError
1.30.0 · Source§fn source(&self) -> Option<&(dyn Error + 'static)>
Returns the lower-level source of this error, if any. Read more1.0.0 · Source§fn description(&self) -> &str
👎Deprecated since 1.42.0: use the Display impl or to_string()Source§impl From<TryFromIntError> for ConfigError
Source§fn from(_: TryFromIntError) -> ConfigError
Converts to this type from the input type.Source§impl From<VarIntBoundsExceeded> for ConfigError
Source§fn from(_: VarIntBoundsExceeded) -> ConfigError
Converts to this type from the input type.Source§impl PartialEq for ConfigError
Source§impl Eq for ConfigError
Source§impl StructuralPartialEq for ConfigError
Auto Trait Implementations§
§impl Freeze for ConfigError
§impl RefUnwindSafe for ConfigError
§impl Send for ConfigError
§impl Sync for ConfigError
§impl Unpin for ConfigError
§impl UnwindSafe for ConfigError
Blanket Implementations§
Trait Implementations§
Source§impl Clone for ConfigError
Source§fn clone(&self) -> ConfigError
Returns a duplicate of the value. Read more1.0.0 · Source§fn clone_from(&mut self, source: &Self)
Performs copy-assignment from source. Read moreSource§impl Debug for ConfigError
Source§impl Display for ConfigError
Source§impl Error for ConfigError
1.30.0 · Source§fn source(&self) -> Option<&(dyn Error + 'static)>
Returns the lower-level source of this error, if any. Read more1.0.0 · Source§fn description(&self) -> &str
👎Deprecated since 1.42.0: use the Display impl or to_string()Source§impl From<TryFromIntError> for ConfigError
Source§fn from(_: TryFromIntError) -> ConfigError
Converts to this type from the input type.Source§impl From<VarIntBoundsExceeded> for ConfigError
Source§fn from(_: VarIntBoundsExceeded) -> ConfigError
Converts to this type from the input type.Source§impl PartialEq for ConfigError
Source§impl Eq for ConfigError
Source§impl StructuralPartialEq for ConfigError
Auto Trait Implementations§
§impl Freeze for ConfigError
§impl RefUnwindSafe for ConfigError
§impl Send for ConfigError
§impl Sync for ConfigError
§impl Unpin for ConfigError
§impl UnwindSafe for ConfigError
Blanket Implementations§
Source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
Source§fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read moreSource§impl<T> CloneToUninit for Twhere
diff --git a/pr/255/docs/iroh_quinn/enum.ConnectError.html b/pr/255/docs/iroh_quinn/enum.ConnectError.html
index cbdd09bd8..4238be063 100644
--- a/pr/255/docs/iroh_quinn/enum.ConnectError.html
+++ b/pr/255/docs/iroh_quinn/enum.ConnectError.html
@@ -1,4 +1,4 @@
-ConnectError in iroh_quinn - Rust ConnectError
pub enum ConnectError {
+ConnectError in iroh_quinn - Rust ConnectError
pub enum ConnectError {
EndpointStopping,
CidsExhausted,
InvalidServerName(String),
@@ -17,8 +17,8 @@
§NoDefaultClientConfig
No default client configuration was set up
Use Endpoint::connect_with to specify a client configuration.
§UnsupportedVersion
The local endpoint does not support the QUIC version specified in the client configuration
-
Trait Implementations§
Source§impl Clone for ConnectError
Source§fn clone(&self) -> ConnectError
Returns a duplicate of the value. Read more1.0.0 · Source§fn clone_from(&mut self, source: &Self)
Performs copy-assignment from source. Read moreSource§impl Debug for ConnectError
Source§impl Display for ConnectError
Source§impl Error for ConnectError
1.30.0 · Source§fn source(&self) -> Option<&(dyn Error + 'static)>
Returns the lower-level source of this error, if any. Read more1.0.0 · Source§fn description(&self) -> &str
👎Deprecated since 1.42.0: use the Display impl or to_string()Source§impl From<UnsupportedVersion> for ConnectError
Source§fn from(_: UnsupportedVersion) -> ConnectError
Converts to this type from the input type.Source§impl PartialEq for ConnectError
Source§impl Eq for ConnectError
Source§impl StructuralPartialEq for ConnectError
Auto Trait Implementations§
§impl Freeze for ConnectError
§impl RefUnwindSafe for ConnectError
§impl Send for ConnectError
§impl Sync for ConnectError
§impl Unpin for ConnectError
§impl UnwindSafe for ConnectError
Blanket Implementations§
Trait Implementations§
Source§impl Clone for ConnectError
Source§fn clone(&self) -> ConnectError
Returns a duplicate of the value. Read more1.0.0 · Source§fn clone_from(&mut self, source: &Self)
Performs copy-assignment from source. Read moreSource§impl Debug for ConnectError
Source§impl Display for ConnectError
Source§impl Error for ConnectError
1.30.0 · Source§fn source(&self) -> Option<&(dyn Error + 'static)>
Returns the lower-level source of this error, if any. Read more1.0.0 · Source§fn description(&self) -> &str
👎Deprecated since 1.42.0: use the Display impl or to_string()Source§impl From<UnsupportedVersion> for ConnectError
Source§fn from(_: UnsupportedVersion) -> ConnectError
Converts to this type from the input type.Source§impl PartialEq for ConnectError
Source§impl Eq for ConnectError
Source§impl StructuralPartialEq for ConnectError
Auto Trait Implementations§
§impl Freeze for ConnectError
§impl RefUnwindSafe for ConnectError
§impl Send for ConnectError
§impl Sync for ConnectError
§impl Unpin for ConnectError
§impl UnwindSafe for ConnectError
Blanket Implementations§
Source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
Source§fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read moreSource§impl<T> CloneToUninit for Twhere
diff --git a/pr/255/docs/iroh_quinn/enum.ConnectionError.html b/pr/255/docs/iroh_quinn/enum.ConnectionError.html
index 088a81850..99006f4cd 100644
--- a/pr/255/docs/iroh_quinn/enum.ConnectionError.html
+++ b/pr/255/docs/iroh_quinn/enum.ConnectionError.html
@@ -1,4 +1,4 @@
-ConnectionError in iroh_quinn - Rust ConnectionError
pub enum ConnectionError {
+ConnectionError in iroh_quinn - Rust ConnectionError
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 more1.0.0 · Source§fn clone_from(&mut self, source: &Self)
Performs copy-assignment from source. Read moreSource§impl Debug for ConnectionError
Source§impl Display for ConnectionError
Source§impl Error for ConnectionError
Source§fn source(&self) -> Option<&(dyn Error + 'static)>
Returns the lower-level source of this error, if any. Read more1.0.0 · Source§fn description(&self) -> &str
👎Deprecated since 1.42.0: use the Display impl or to_string()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§impl Eq for ConnectionError
Source§impl StructuralPartialEq for ConnectionError
Auto Trait Implementations§
§impl !Freeze for ConnectionError
§impl !RefUnwindSafe for ConnectionError
§impl Send for ConnectionError
§impl Sync for ConnectionError
§impl Unpin for ConnectionError
§impl !UnwindSafe for ConnectionError
Blanket Implementations§
Trait Implementations§
Source§impl Clone for ConnectionError
Source§fn clone(&self) -> ConnectionError
Returns a duplicate of the value. Read more1.0.0 · Source§fn clone_from(&mut self, source: &Self)
Performs copy-assignment from source. Read moreSource§impl Debug for ConnectionError
Source§impl Display for ConnectionError
Source§impl Error for ConnectionError
Source§fn source(&self) -> Option<&(dyn Error + 'static)>
Returns the lower-level source of this error, if any. Read more1.0.0 · Source§fn description(&self) -> &str
👎Deprecated since 1.42.0: use the Display impl or to_string()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§impl Eq for ConnectionError
Source§impl StructuralPartialEq for ConnectionError
Auto Trait Implementations§
§impl !Freeze for ConnectionError
§impl !RefUnwindSafe for ConnectionError
§impl Send for ConnectionError
§impl Sync for ConnectionError
§impl Unpin for ConnectionError
§impl !UnwindSafe for ConnectionError
Blanket Implementations§
Source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
Source§fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read moreSource§impl<T> CloneToUninit for Twhere
diff --git a/pr/255/docs/iroh_quinn/enum.Dir.html b/pr/255/docs/iroh_quinn/enum.Dir.html
index efbb040b3..59802f8a6 100644
--- a/pr/255/docs/iroh_quinn/enum.Dir.html
+++ b/pr/255/docs/iroh_quinn/enum.Dir.html
@@ -1,25 +1,25 @@
-Dir in iroh_quinn - Rust Dir
pub enum Dir {
+Dir in iroh_quinn - Rust Dir
pub enum Dir {
Bi = 0,
Uni = 1,
}
Expand description
Whether a stream communicates data in both directions or only from the initiator
Variants§
Trait Implementations§
Source§impl<'arbitrary> Arbitrary<'arbitrary> for Dir
Source§fn arbitrary(u: &mut Unstructured<'arbitrary>) -> Result<Dir, Error>
Generate an arbitrary value of Self from the given unstructured data. Read moreTrait Implementations§
Source§impl<'arbitrary> Arbitrary<'arbitrary> for Dir
Source§fn arbitrary(u: &mut Unstructured<'arbitrary>) -> Result<Dir, Error>
Generate an arbitrary value of Self from the given unstructured data. Read moreSource§fn arbitrary_take_rest(u: Unstructured<'arbitrary>) -> Result<Dir, Error>
Generate an arbitrary value of Self from the entirety of the given
+unstructured data. Read moreSource§impl Ord for Dir
Source§impl PartialOrd for Dir
Source§impl PartialOrd for Dir
Source§impl Copy for Dir
Source§impl Eq for Dir
Source§impl StructuralPartialEq for Dir
Auto Trait Implementations§
§impl Freeze for Dir
§impl RefUnwindSafe for Dir
§impl Send for Dir
§impl Sync for Dir
§impl Unpin for Dir
§impl UnwindSafe for Dir
Blanket Implementations§
Source§impl Copy for Dir
Source§impl Eq for Dir
Source§impl StructuralPartialEq for Dir
Auto Trait Implementations§
§impl Freeze for Dir
§impl RefUnwindSafe for Dir
§impl Send for Dir
§impl Sync for Dir
§impl Unpin for Dir
§impl UnwindSafe for Dir
Blanket Implementations§
Source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
Source§fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read moreSource§impl<T> CloneToUninit for Twhere
diff --git a/pr/255/docs/iroh_quinn/enum.FrameType.html b/pr/255/docs/iroh_quinn/enum.FrameType.html
index a35f3f031..c28f19a5c 100644
--- a/pr/255/docs/iroh_quinn/enum.FrameType.html
+++ b/pr/255/docs/iroh_quinn/enum.FrameType.html
@@ -7,7 +7,7 @@
StopSending,
Crypto,
NewToken,
- Stream(StreamInfo),
+ Stream(StreamInfo),
MaxData,
MaxStreamData,
MaxStreamsBidi,
@@ -25,7 +25,7 @@
HandshakeDone,
AckFrequency,
ImmediateAck,
- Datagram(DatagramInfo),
+ Datagram(DatagramInfo),
ObservedIpv4Addr,
ObservedIpv6Addr,
PathAck,
@@ -43,10 +43,10 @@
ReachOutAtIpv4,
ReachOutAtIpv6,
RemoveAddress,
-}Variants§
§Padding
§Ping
§Ack
§AckEcn
§ResetStream
§StopSending
§Crypto
§NewToken
§Stream(StreamInfo)
§MaxData
§MaxStreamData
§MaxStreamsBidi
§MaxStreamsUni
§DataBlocked
§StreamDataBlocked
§StreamsBlockedBidi
§StreamsBlockedUni
§NewConnectionId
§RetireConnectionId
§PathChallenge
§PathResponse
§ConnectionClose
§ApplicationClose
§HandshakeDone
§AckFrequency
§ImmediateAck
§Datagram(DatagramInfo)
§ObservedIpv4Addr
§ObservedIpv6Addr
§PathAck
§PathAckEcn
§PathAbandon
§PathStatusBackup
§PathStatusAvailable
§PathNewConnectionId
§PathRetireConnectionId
§MaxPathId
§PathsBlocked
§PathCidsBlocked
§AddIpv4Address
§AddIpv6Address
§ReachOutAtIpv4
§ReachOutAtIpv6
§RemoveAddress
Trait Implementations§
Source§impl Encodable for FrameType
Source§fn encode<B>(&self, buf: &mut B)where
+}Variants§
§Padding
§Ping
§Ack
§AckEcn
§ResetStream
§StopSending
§Crypto
§NewToken
§Stream(StreamInfo)
§MaxData
§MaxStreamData
§MaxStreamsBidi
§MaxStreamsUni
§DataBlocked
§StreamDataBlocked
§StreamsBlockedBidi
§StreamsBlockedUni
§NewConnectionId
§RetireConnectionId
§PathChallenge
§PathResponse
§ConnectionClose
§ApplicationClose
§HandshakeDone
§AckFrequency
§ImmediateAck
§Datagram(DatagramInfo)
§ObservedIpv4Addr
§ObservedIpv6Addr
§PathAck
§PathAckEcn
§PathAbandon
§PathStatusBackup
§PathStatusAvailable
§PathNewConnectionId
§PathRetireConnectionId
§MaxPathId
§PathsBlocked
§PathCidsBlocked
§AddIpv4Address
§AddIpv6Address
§ReachOutAtIpv4
§ReachOutAtIpv6
§RemoveAddress
Trait Implementations§
Source§impl Copy for FrameType
Source§impl Eq for FrameType
Source§impl StructuralPartialEq for FrameType
Auto Trait Implementations§
§impl Freeze for FrameType
§impl RefUnwindSafe for FrameType
§impl Send for FrameType
§impl Sync for FrameType
§impl Unpin for FrameType
§impl UnwindSafe for FrameType
Blanket Implementations§
Source§impl Copy for FrameType
Source§impl Eq for FrameType
Source§impl StructuralPartialEq for FrameType
Auto Trait Implementations§
§impl Freeze for FrameType
§impl RefUnwindSafe for FrameType
§impl Send for FrameType
§impl Sync for FrameType
§impl Unpin for FrameType
§impl UnwindSafe for FrameType
Blanket Implementations§
Source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
Source§fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read moreSource§impl<T> CloneToUninit for Twhere
diff --git a/pr/255/docs/iroh_quinn/enum.Side.html b/pr/255/docs/iroh_quinn/enum.Side.html
index 2bcf64c9b..1bb5dd646 100644
--- a/pr/255/docs/iroh_quinn/enum.Side.html
+++ b/pr/255/docs/iroh_quinn/enum.Side.html
@@ -1,27 +1,27 @@
-Side in iroh_quinn - Rust Side
pub enum Side {
+Side in iroh_quinn - Rust Side
pub enum Side {
Client = 0,
Server = 1,
}
Expand description
Whether an endpoint was the initiator of a connection
Variants§
Implementations§
Trait Implementations§
Source§impl<'arbitrary> Arbitrary<'arbitrary> for Side
Source§fn arbitrary(u: &mut Unstructured<'arbitrary>) -> Result<Side, Error>
Generate an arbitrary value of Self from the given unstructured data. Read moreImplementations§
Trait Implementations§
Source§impl<'arbitrary> Arbitrary<'arbitrary> for Side
Source§fn arbitrary(u: &mut Unstructured<'arbitrary>) -> Result<Side, Error>
Generate an arbitrary value of Self from the given unstructured data. Read moreSource§fn arbitrary_take_rest(u: Unstructured<'arbitrary>) -> Result<Side, Error>
Generate an arbitrary value of Self from the entirety of the given
+unstructured data. Read moreSource§impl Ord for Side
Source§impl PartialOrd for Side
Source§impl PartialOrd for Side
Source§impl Copy for Side
Source§impl Eq for Side
Source§impl StructuralPartialEq for Side
Auto Trait Implementations§
§impl Freeze for Side
§impl RefUnwindSafe for Side
§impl Send for Side
§impl Sync for Side
§impl Unpin for Side
§impl UnwindSafe for Side
Blanket Implementations§
Source§impl Copy for Side
Source§impl Eq for Side
Source§impl StructuralPartialEq for Side
Auto Trait Implementations§
§impl Freeze for Side
§impl RefUnwindSafe for Side
§impl Send for Side
§impl Sync for Side
§impl Unpin for Side
§impl UnwindSafe for Side
Blanket Implementations§
Source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
Source§fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read moreSource§impl<T> CloneToUninit for Twhere
diff --git a/pr/255/docs/iroh_quinn/enum.StoppedError.html b/pr/255/docs/iroh_quinn/enum.StoppedError.html
index 42ac78ed6..ca10923e6 100644
--- a/pr/255/docs/iroh_quinn/enum.StoppedError.html
+++ b/pr/255/docs/iroh_quinn/enum.StoppedError.html
@@ -1,4 +1,4 @@
-StoppedError in iroh_quinn - Rust StoppedError
pub enum StoppedError {
+StoppedError in iroh_quinn - Rust StoppedError
pub enum StoppedError {
ConnectionLost(ConnectionError),
ZeroRttRejected,
}
Expand description
Errors that arise while monitoring for a send stream stop from the peer
@@ -6,8 +6,8 @@
§ZeroRttRejected
This was a 0-RTT stream and the server rejected it
Can only occur on clients for 0-RTT streams, which can be opened using
Connecting::into_0rtt().
-Trait Implementations§
Source§impl Clone for StoppedError
Source§fn clone(&self) -> StoppedError
Returns a duplicate of the value. Read more1.0.0 · Source§fn clone_from(&mut self, source: &Self)
Performs copy-assignment from source. Read moreSource§impl Debug for StoppedError
Source§impl Display for StoppedError
Source§impl Error for StoppedError
Source§fn source(&self) -> Option<&(dyn Error + 'static)>
Returns the lower-level source of this error, if any. Read more1.0.0 · Source§fn description(&self) -> &str
👎Deprecated since 1.42.0: use the Display impl or to_string()Source§impl From<ConnectionError> for StoppedError
Source§fn from(source: ConnectionError) -> Self
Converts to this type from the input type.Source§impl From<StoppedError> for Error
Source§fn from(x: StoppedError) -> Self
Converts to this type from the input type.Source§impl From<StoppedError> for WriteError
Source§fn from(x: StoppedError) -> Self
Converts to this type from the input type.Source§impl PartialEq for StoppedError
Source§impl Eq for StoppedError
Source§impl StructuralPartialEq for StoppedError
Auto Trait Implementations§
§impl !Freeze for StoppedError
§impl !RefUnwindSafe for StoppedError
§impl Send for StoppedError
§impl Sync for StoppedError
§impl Unpin for StoppedError
§impl !UnwindSafe for StoppedError
Blanket Implementations§
Trait Implementations§
Source§impl Clone for StoppedError
Source§fn clone(&self) -> StoppedError
Returns a duplicate of the value. Read more1.0.0 · Source§fn clone_from(&mut self, source: &Self)
Performs copy-assignment from source. Read moreSource§impl Debug for StoppedError
Source§impl Display for StoppedError
Source§impl Error for StoppedError
Source§fn source(&self) -> Option<&(dyn Error + 'static)>
Returns the lower-level source of this error, if any. Read more1.0.0 · Source§fn description(&self) -> &str
👎Deprecated since 1.42.0: use the Display impl or to_string()Source§impl From<ConnectionError> for StoppedError
Source§fn from(source: ConnectionError) -> Self
Converts to this type from the input type.Source§impl From<StoppedError> for Error
Source§fn from(x: StoppedError) -> Self
Converts to this type from the input type.Source§impl From<StoppedError> for WriteError
Source§fn from(x: StoppedError) -> Self
Converts to this type from the input type.Source§impl PartialEq for StoppedError
Source§impl Eq for StoppedError
Source§impl StructuralPartialEq for StoppedError
Auto Trait Implementations§
§impl !Freeze for StoppedError
§impl !RefUnwindSafe for StoppedError
§impl Send for StoppedError
§impl Sync for StoppedError
§impl Unpin for StoppedError
§impl !UnwindSafe for StoppedError
Blanket Implementations§
Source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
Source§fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read moreSource§impl<T> CloneToUninit for Twhere
diff --git a/pr/255/docs/iroh_quinn/enum.WriteError.html b/pr/255/docs/iroh_quinn/enum.WriteError.html
index 48fd44e36..ea02311ac 100644
--- a/pr/255/docs/iroh_quinn/enum.WriteError.html
+++ b/pr/255/docs/iroh_quinn/enum.WriteError.html
@@ -1,4 +1,4 @@
-WriteError in iroh_quinn - Rust WriteError
pub enum WriteError {
+WriteError in iroh_quinn - Rust WriteError
pub enum WriteError {
Stopped(VarInt),
ConnectionLost(ConnectionError),
ClosedStream,
@@ -11,8 +11,8 @@
§ZeroRttRejected
This was a 0-RTT stream and the server rejected it
Can only occur on clients for 0-RTT streams, which can be opened using
Connecting::into_0rtt().
-
Trait Implementations§
Source§impl Clone for WriteError
Source§fn clone(&self) -> WriteError
Returns a duplicate of the value. Read more1.0.0 · Source§fn clone_from(&mut self, source: &Self)
Performs copy-assignment from source. Read moreSource§impl Debug for WriteError
Source§impl Display for WriteError
Source§impl Error for WriteError
Source§fn source(&self) -> Option<&(dyn Error + 'static)>
Returns the lower-level source of this error, if any. Read more1.0.0 · Source§fn description(&self) -> &str
👎Deprecated since 1.42.0: use the Display impl or to_string()Source§impl From<ClosedStream> for WriteError
Source§fn from(_: ClosedStream) -> 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<StoppedError> for WriteError
Source§fn from(x: StoppedError) -> Self
Converts to this type from the input type.Source§impl From<WriteError> for Error
Source§fn from(x: WriteError) -> Self
Converts to this type from the input type.Source§impl PartialEq for WriteError
Source§impl Eq for WriteError
Source§impl StructuralPartialEq for WriteError
Auto Trait Implementations§
§impl !Freeze for WriteError
§impl !RefUnwindSafe for WriteError
§impl Send for WriteError
§impl Sync for WriteError
§impl Unpin for WriteError
§impl !UnwindSafe for WriteError
Blanket Implementations§
Trait Implementations§
Source§impl Clone for WriteError
Source§fn clone(&self) -> WriteError
Returns a duplicate of the value. Read more1.0.0 · Source§fn clone_from(&mut self, source: &Self)
Performs copy-assignment from source. Read moreSource§impl Debug for WriteError
Source§impl Display for WriteError
Source§impl Error for WriteError
Source§fn source(&self) -> Option<&(dyn Error + 'static)>
Returns the lower-level source of this error, if any. Read more1.0.0 · Source§fn description(&self) -> &str
👎Deprecated since 1.42.0: use the Display impl or to_string()Source§impl From<ClosedStream> for WriteError
Source§fn from(_: ClosedStream) -> 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<StoppedError> for WriteError
Source§fn from(x: StoppedError) -> Self
Converts to this type from the input type.Source§impl From<WriteError> for Error
Source§fn from(x: WriteError) -> Self
Converts to this type from the input type.Source§impl PartialEq for WriteError
Source§impl Eq for WriteError
Source§impl StructuralPartialEq for WriteError
Auto Trait Implementations§
§impl !Freeze for WriteError
§impl !RefUnwindSafe for WriteError
§impl Send for WriteError
§impl Sync for WriteError
§impl Unpin for WriteError
§impl !UnwindSafe for WriteError
Blanket Implementations§
Source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
Source§fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read moreSource§impl<T> CloneToUninit for Twhere
diff --git a/pr/255/docs/iroh_quinn/index.html b/pr/255/docs/iroh_quinn/index.html
index 281df6ef6..f0adc5bb4 100644
--- a/pr/255/docs/iroh_quinn/index.html
+++ b/pr/255/docs/iroh_quinn/index.html
@@ -1,4 +1,4 @@
-iroh_quinn - Rust Crate iroh_quinn
Expand description
QUIC transport protocol implementation
+iroh_quinn - Rust Crate iroh_quinn
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
@@ -29,6 +29,6 @@ server, it is useful for a QUIC server to be identified by a certificate signed
authority. If this is infeasible–for example, if servers are short-lived or not associated
with a domain name–then as with TLS, self-signed certificates can be used to provide
encryption alone.
-Re-exports§
Modules§
Structs§
Re-exports§
Modules§
Structs§
Enums§
Traits§
Functions§
\ No newline at end of file
diff --git a/pr/255/docs/iroh_quinn/path/struct.AddressDiscovery.html b/pr/255/docs/iroh_quinn/path/struct.AddressDiscovery.html
new file mode 100644
index 000000000..e4476ec35
--- /dev/null
+++ b/pr/255/docs/iroh_quinn/path/struct.AddressDiscovery.html
@@ -0,0 +1,11 @@
+
+
+
+
+ Redirection
+
+
+ Redirecting to ../../iroh_quinn/struct.AddressDiscovery.html...
+
+
+
\ No newline at end of file
diff --git a/pr/255/docs/iroh_quinn/path/struct.ClosePath.html b/pr/255/docs/iroh_quinn/path/struct.ClosePath.html
new file mode 100644
index 000000000..56c3283bf
--- /dev/null
+++ b/pr/255/docs/iroh_quinn/path/struct.ClosePath.html
@@ -0,0 +1,11 @@
+
+
+
+
+ Redirection
+
+
+ Redirecting to ../../iroh_quinn/struct.ClosePath.html...
+
+
+
\ No newline at end of file
diff --git a/pr/255/docs/iroh_quinn/sidebar-items.js b/pr/255/docs/iroh_quinn/sidebar-items.js
index ae9bffc7f..2af1c653a 100644
--- a/pr/255/docs/iroh_quinn/sidebar-items.js
+++ b/pr/255/docs/iroh_quinn/sidebar-items.js
@@ -1 +1 @@
-window.SIDEBAR_ITEMS = {"enum":["ConfigError","ConnectError","ConnectionError","Dir","EcnCodepoint","FrameType","ReadError","ReadExactError","ReadToEndError","ResetError","SendDatagramError","Side","StoppedError","WriteError"],"fn":["default_runtime"],"mod":["congestion","crypto"],"struct":["Accept","AcceptBi","AcceptUni","AckFrequencyConfig","ApplicationClose","BloomTokenLog","Chunk","ClientConfig","ClosedStream","Connecting","Connection","ConnectionClose","ConnectionId","ConnectionStats","Endpoint","EndpointConfig","EndpointStats","FrameStats","IdleTimeout","Incoming","IncomingFuture","MtuDiscoveryConfig","NoneTokenLog","NoneTokenStore","OnClosed","OpenBi","OpenPath","OpenUni","Path","PathId","PathStats","QlogConfig","QlogFileFactory","ReadDatagram","RecvStream","RetryError","SendDatagram","SendStream","ServerConfig","SmolRuntime","StdSystemTime","StreamId","TokenMemoryCache","TokenReuseError","TokioRuntime","Transmit","TransportConfig","TransportErrorCode","UdpStats","UnorderedRecvStream","ValidationTokenConfig","VarInt","VarIntBoundsExceeded","WeakConnectionHandle","Written","ZeroRttAccepted"],"trait":["AsyncTimer","AsyncUdpSocket","ConnectionIdGenerator","QlogFactory","Runtime","TimeSource","TokenLog","TokenStore","UdpSender"]};
\ No newline at end of file
+window.SIDEBAR_ITEMS = {"enum":["ConfigError","ConnectError","ConnectionError","Dir","EcnCodepoint","FrameType","ReadError","ReadExactError","ReadToEndError","ResetError","SendDatagramError","Side","StoppedError","WriteError"],"fn":["default_runtime"],"mod":["congestion","crypto"],"struct":["Accept","AcceptBi","AcceptUni","AckFrequencyConfig","AddressDiscovery","ApplicationClose","BloomTokenLog","Chunk","ClientConfig","ClosePath","ClosedStream","Connecting","Connection","ConnectionClose","ConnectionId","ConnectionStats","Endpoint","EndpointConfig","EndpointStats","FrameStats","IdleTimeout","Incoming","IncomingFuture","InvalidCid","MtuDiscoveryConfig","NoneTokenLog","NoneTokenStore","OnClosed","OpenBi","OpenPath","OpenUni","Path","PathId","PathStats","QlogConfig","QlogFileFactory","ReadDatagram","RecvStream","RetryError","SendDatagram","SendStream","ServerConfig","SmolRuntime","StdSystemTime","StreamId","TokenMemoryCache","TokenReuseError","TokioRuntime","Transmit","TransportConfig","TransportErrorCode","UdpStats","UnorderedRecvStream","ValidationTokenConfig","VarInt","VarIntBoundsExceeded","WeakConnectionHandle","Written","ZeroRttAccepted"],"trait":["AsyncTimer","AsyncUdpSocket","ConnectionIdGenerator","QlogFactory","Runtime","TimeSource","TokenLog","TokenStore","UdpSender"]};
\ No newline at end of file
diff --git a/pr/255/docs/iroh_quinn/struct.Accept.html b/pr/255/docs/iroh_quinn/struct.Accept.html
index 6e17e11a0..896bcd39f 100644
--- a/pr/255/docs/iroh_quinn/struct.Accept.html
+++ b/pr/255/docs/iroh_quinn/struct.Accept.html
@@ -1,6 +1,6 @@
-Accept in iroh_quinn - Rust Accept
pub struct Accept<'a> { /* private fields */ }
Expand description
Future produced by Endpoint::accept
-Trait Implementations§
Source§impl<'__pin, 'a> Unpin for Accept<'a>where
+Accept in iroh_quinn - Rust Accept
pub struct Accept<'a> { /* private fields */ }
Expand description
Future produced by Endpoint::accept
+Trait Implementations§
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> BorrowMut<T> for Twhere
diff --git a/pr/255/docs/iroh_quinn/struct.AddressDiscovery.html b/pr/255/docs/iroh_quinn/struct.AddressDiscovery.html
new file mode 100644
index 000000000..5bde10466
--- /dev/null
+++ b/pr/255/docs/iroh_quinn/struct.AddressDiscovery.html
@@ -0,0 +1,173 @@
+AddressDiscovery in iroh_quinn - Rust AddressDiscovery
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.Auto Trait Implementations§
§impl Freeze for AddressDiscovery
§impl !RefUnwindSafe for AddressDiscovery
§impl Send for AddressDiscovery
§impl Sync for AddressDiscovery
§impl Unpin for AddressDiscovery
§impl !UnwindSafe for AddressDiscovery
Blanket Implementations§
Source§impl<T> BorrowMut<T> for Twhere
+ T: ?Sized,
Source§fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more§impl<T> Instrument for T
§fn instrument(self, span: Span) -> Instrumented<Self>
§fn in_current_span(self) -> Instrumented<Self>
Source§impl<T> IntoEither for T
Source§fn into_either(self, into_left: bool) -> Either<Self, Self>
Converts self into a Left variant of Either<Self, Self>
+if into_left is true.
+Converts self into a Right variant of Either<Self, Self>
+otherwise. Read moreSource§fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
Converts self into a Left variant of Either<Self, Self>
+if into_left(&self) returns true.
+Converts self into a Right variant of Either<Self, Self>
+otherwise. Read more§impl<S> StreamExt for Swhere
+ S: Stream + ?Sized,
§fn next(&mut self) -> NextFuture<'_, Self>where
+ Self: Unpin,
Retrieves the next item in the stream. Read more§fn try_next<T, E>(&mut self) -> TryNextFuture<'_, Self>
Retrieves the next item in the stream. Read more§fn count(self) -> CountFuture<Self>where
+ Self: Sized,
Counts the number of items in the stream. Read more§fn map<T, F>(self, f: F) -> Map<Self, F>
Maps items of the stream to new values using a closure. Read more§fn flat_map<U, F>(self, f: F) -> FlatMap<Self, U, F>
Maps items to streams and then concatenates them. Read more§fn flatten(self) -> Flatten<Self>where
+ Self: Sized,
+ Self::Item: Stream,
Concatenates inner streams. Read more§fn then<F, Fut>(self, f: F) -> Then<Self, F, Fut>
Maps items of the stream to new values using an async closure. Read more§fn filter_map<T, F>(self, f: F) -> FilterMap<Self, F>
Filters and maps items of the stream using a closure. Read more§fn take(self, n: usize) -> Take<Self>where
+ Self: Sized,
Takes only the first n items of the stream. Read more§fn take_while<P>(self, predicate: P) -> TakeWhile<Self, P>
§fn skip(self, n: usize) -> Skip<Self>where
+ Self: Sized,
Skips the first n items of the stream. Read more§fn skip_while<P>(self, predicate: P) -> SkipWhile<Self, P>
§fn step_by(self, step: usize) -> StepBy<Self>where
+ Self: Sized,
Yields every stepth item. Read more§fn chain<U>(self, other: U) -> Chain<Self, U>where
+ Self: Sized,
+ U: Stream<Item = Self::Item>,
Appends another stream to the end of this one. Read more§fn collect<C>(self) -> CollectFuture<Self, C>
Collects all items in the stream into a collection. Read more§fn try_collect<T, E, C>(self) -> TryCollectFuture<Self, C>
Collects all items in the fallible stream into a collection. Read more§fn partition<B, P>(self, predicate: P) -> PartitionFuture<Self, P, B>
Partitions items into those for which predicate is true and those for which it is
+false, and then collects them into two collections. Read more§fn fold<T, F>(self, init: T, f: F) -> FoldFuture<Self, F, T>
Accumulates a computation over the stream. Read more§fn try_fold<T, E, F, B>(
+ &mut self,
+ init: B,
+ f: F,
+) -> TryFoldFuture<'_, Self, F, B>
Accumulates a fallible computation over the stream. Read more§fn scan<St, B, F>(self, initial_state: St, f: F) -> Scan<Self, St, F>
Maps items of the stream to new values using a state value and a closure. Read more§fn enumerate(self) -> Enumerate<Self>where
+ Self: Sized,
Enumerates items, mapping them to (index, item). Read more§fn inspect<F>(self, f: F) -> Inspect<Self, F>
Calls a closure on each item and passes it on. Read more§fn nth(&mut self, n: usize) -> NthFuture<'_, Self>where
+ Self: Unpin,
Gets the nth item of the stream. Read more§fn last(self) -> LastFuture<Self>where
+ Self: Sized,
Returns the last item in the stream. Read more§fn for_each<F>(self, f: F) -> ForEachFuture<Self, F>
Calls a closure on each item of the stream. Read more§fn try_for_each<F, E>(&mut self, f: F) -> TryForEachFuture<'_, Self, F>
Calls a fallible closure on each item of the stream, stopping on first error. Read more§fn zip<U>(self, other: U) -> Zip<Self, U>where
+ Self: Sized,
+ U: Stream,
Zips up two streams into a single stream of pairs. Read more§fn unzip<A, B, FromA, FromB>(self) -> UnzipFuture<Self, FromA, FromB>
Collects a stream of pairs into a pair of collections. Read more§fn race<S>(self, other: S) -> Race<Self, S>where
+ Self: Sized,
+ S: Stream<Item = Self::Item>,
Merges with other stream, with no preference for either stream when both are ready. Read more§fn drain(&mut self) -> Drain<'_, Self>
Yields all immediately available values from a stream. Read more§impl<St> StreamExt for Stwhere
+ St: Stream + ?Sized,
§fn next(&mut self) -> Next<'_, Self>where
+ Self: Unpin,
Consumes and returns the next value in the stream or None if the
+stream is finished. Read more§fn try_next<T, E>(&mut self) -> TryNext<'_, Self>
Consumes and returns the next item in the stream. If an error is
+encountered before the next item, the error is returned instead. Read more§fn map<T, F>(self, f: F) -> Map<Self, F>
Maps this stream’s items to a different type, returning a new stream of
+the resulting type. Read more§fn map_while<T, F>(self, f: F) -> MapWhile<Self, F>
Map this stream’s items to a different type for as long as determined by
+the provided closure. A stream of the target type will be returned,
+which will yield elements until the closure returns None. Read more§fn then<F, Fut>(self, f: F) -> Then<Self, Fut, F>
Maps this stream’s items asynchronously to a different type, returning a
+new stream of the resulting type. Read more§fn merge<U>(self, other: U) -> Merge<Self, U>where
+ U: Stream<Item = Self::Item>,
+ Self: Sized,
Combine two streams into one by interleaving the output of both as it
+is produced. Read more§fn filter<F>(self, f: F) -> Filter<Self, F>
Filters the values produced by this stream according to the provided
+predicate. Read more§fn filter_map<T, F>(self, f: F) -> FilterMap<Self, F>
Filters the values produced by this stream while simultaneously mapping
+them to a different type according to the provided closure. Read more§fn fuse(self) -> Fuse<Self>where
+ Self: Sized,
Creates a stream which ends after the first None. Read more§fn take(self, n: usize) -> Take<Self>where
+ Self: Sized,
Creates a new stream of at most n items of the underlying stream. Read more§fn take_while<F>(self, f: F) -> TakeWhile<Self, F>
Take elements from this stream while the provided predicate
+resolves to true. Read more§fn skip(self, n: usize) -> Skip<Self>where
+ Self: Sized,
Creates a new stream that will skip the n first items of the
+underlying stream. Read more§fn skip_while<F>(self, f: F) -> SkipWhile<Self, F>
Skip elements from the underlying stream while the provided predicate
+resolves to true. Read more§fn all<F>(&mut self, f: F) -> AllFuture<'_, Self, F>
Tests if every element of the stream matches a predicate. Read more§fn any<F>(&mut self, f: F) -> AnyFuture<'_, Self, F>
Tests if any element of the stream matches a predicate. Read more§fn chain<U>(self, other: U) -> Chain<Self, U>where
+ U: Stream<Item = Self::Item>,
+ Self: Sized,
Combine two streams into one by first returning all values from the
+first stream then all values from the second stream. Read more§fn fold<B, F>(self, init: B, f: F) -> FoldFuture<Self, B, F>
A combinator that applies a function to every element in a stream
+producing a single, final value. Read more§fn collect<T>(self) -> Collect<Self, T>where
+ T: FromStream<Self::Item>,
+ Self: Sized,
Drain stream pushing all emitted values into a collection. Read more§fn timeout(self, duration: Duration) -> Timeout<Self>where
+ Self: Sized,
Applies a per-item timeout to the passed stream. Read more§fn timeout_repeating(self, interval: Interval) -> TimeoutRepeating<Self>where
+ Self: Sized,
Applies a per-item timeout to the passed stream. Read more§fn throttle(self, duration: Duration) -> Throttle<Self>where
+ Self: Sized,
Slows down a stream by enforcing a delay between items. Read more§impl<T> WithSubscriber for T
§fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>where
+ S: Into<Dispatch>,
§fn with_current_subscriber(self) -> WithDispatch<Self>
Attaches the current default Subscriber to this type, returning a
+[WithDispatch] wrapper. Read more
\ No newline at end of file
diff --git a/pr/255/docs/iroh_quinn/struct.ApplicationClose.html b/pr/255/docs/iroh_quinn/struct.ApplicationClose.html
index c6ccb9e8e..bb5b19c66 100644
--- a/pr/255/docs/iroh_quinn/struct.ApplicationClose.html
+++ b/pr/255/docs/iroh_quinn/struct.ApplicationClose.html
@@ -1,11 +1,11 @@
-ApplicationClose in iroh_quinn - Rust ApplicationClose
pub struct ApplicationClose {
+ApplicationClose in iroh_quinn - Rust ApplicationClose
pub struct ApplicationClose {
pub error_code: VarInt,
pub reason: Bytes,
}
Expand description
Reason given by an application for closing the connection
Fields§
§error_code: VarIntApplication-specific reason code
§reason: BytesHuman-readable reason for the close
-Trait Implementations§
Source§impl Clone for ApplicationClose
Source§fn clone(&self) -> ApplicationClose
Returns a duplicate of the value. Read more1.0.0 · Source§fn clone_from(&mut self, source: &Self)
Performs copy-assignment from source. Read moreSource§impl Debug for ApplicationClose
Source§impl Display for ApplicationClose
Source§impl PartialEq for ApplicationClose
Source§impl Eq for ApplicationClose
Source§impl StructuralPartialEq for ApplicationClose
Auto Trait Implementations§
§impl !Freeze for ApplicationClose
§impl RefUnwindSafe for ApplicationClose
§impl Send for ApplicationClose
§impl Sync for ApplicationClose
§impl Unpin for ApplicationClose
§impl UnwindSafe for ApplicationClose
Blanket Implementations§
Source§impl<T> Any for Twhere
+Trait Implementations§
Source§impl Clone for ApplicationClose
Source§fn clone(&self) -> ApplicationClose
Returns a duplicate of the value. Read more1.0.0 · Source§fn clone_from(&mut self, source: &Self)
Performs copy-assignment from source. Read moreSource§impl Debug for ApplicationClose
Source§impl Display for ApplicationClose
Source§impl PartialEq for ApplicationClose
Source§impl Eq for ApplicationClose
Source§impl StructuralPartialEq for ApplicationClose
Auto Trait Implementations§
§impl !Freeze for ApplicationClose
§impl RefUnwindSafe for ApplicationClose
§impl Send for ApplicationClose
§impl Sync for ApplicationClose
§impl Unpin for ApplicationClose
§impl UnwindSafe for ApplicationClose
Blanket Implementations§
Source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
Source§fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read moreSource§impl<T> CloneToUninit for Twhere
diff --git a/pr/255/docs/iroh_quinn/struct.ClientConfig.html b/pr/255/docs/iroh_quinn/struct.ClientConfig.html
index 990a35909..32e5eca5a 100644
--- a/pr/255/docs/iroh_quinn/struct.ClientConfig.html
+++ b/pr/255/docs/iroh_quinn/struct.ClientConfig.html
@@ -1,4 +1,4 @@
-ClientConfig in iroh_quinn - Rust ClientConfig
#[non_exhaustive]pub struct ClientConfig { /* private fields */ }
Expand description
Configuration for outgoing connections
+ClientConfig in iroh_quinn - Rust ClientConfig
#[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
Sourcepub fn new(crypto: Arc<dyn ClientConfig>) -> ClientConfig
Create a default config with a particular cryptographic config
Sourcepub fn initial_dst_cid_provider(
@@ -17,12 +17,11 @@ at least 8 bytes long and unpredictable, as per section 7.2 of RFC 9000.
Sourcepub fn token_store(&mut self, store: Arc<dyn TokenStore>) -> &mut ClientConfig
Set a custom TokenStore
Defaults to TokenMemoryCache, which is suitable for most internet applications.
Sourcepub fn version(&mut self, version: u32) -> &mut ClientConfig
Set the QUIC version to use
-Source§impl ClientConfig
Sourcepub fn with_platform_verifier() -> ClientConfig
👎Deprecated since 0.11.13: use try_with_platform_verifier() instead
Create a client configuration that trusts the platform’s native roots
-Sourcepub fn try_with_platform_verifier() -> Result<ClientConfig, Error>
Create a client configuration that trusts the platform’s native roots
-Sourcepub fn with_root_certificates(
+
Source§impl ClientConfig
Sourcepub fn try_with_platform_verifier() -> Result<ClientConfig, Error>
Create a client configuration that trusts the platform’s native roots
+Sourcepub fn with_root_certificates(
roots: Arc<RootCertStore>,
) -> Result<ClientConfig, VerifierBuilderError>
Create a client configuration that trusts specified trust anchors
-Trait Implementations§
Source§impl Clone for ClientConfig
Source§fn clone(&self) -> ClientConfig
Returns a duplicate of the value. Read more1.0.0 · Source§fn clone_from(&mut self, source: &Self)
Performs copy-assignment from source. Read moreAuto Trait Implementations§
§impl Freeze for ClientConfig
§impl !RefUnwindSafe for ClientConfig
§impl Send for ClientConfig
§impl Sync for ClientConfig
§impl Unpin for ClientConfig
§impl !UnwindSafe for ClientConfig
Blanket Implementations§
Trait Implementations§
Source§impl Clone for ClientConfig
Source§fn clone(&self) -> ClientConfig
Returns a duplicate of the value. Read more1.0.0 · Source§fn clone_from(&mut self, source: &Self)
Performs copy-assignment from source. Read moreAuto Trait Implementations§
§impl Freeze for ClientConfig
§impl !RefUnwindSafe for ClientConfig
§impl Send for ClientConfig
§impl Sync for ClientConfig
§impl Unpin for ClientConfig
§impl !UnwindSafe for ClientConfig
Blanket Implementations§
Source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
Source§fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read moreSource§impl<T> CloneToUninit for Twhere
diff --git a/pr/255/docs/iroh_quinn/struct.ClosePath.html b/pr/255/docs/iroh_quinn/struct.ClosePath.html
new file mode 100644
index 000000000..346435f36
--- /dev/null
+++ b/pr/255/docs/iroh_quinn/struct.ClosePath.html
@@ -0,0 +1,53 @@
+ClosePath in iroh_quinn - Rust ClosePath
pub struct ClosePath { /* private fields */ }
Expand description
Future produced by Path::close
+Trait Implementations§
Auto Trait Implementations§
§impl Freeze for ClosePath
§impl !RefUnwindSafe for ClosePath
§impl Send for ClosePath
§impl Sync for ClosePath
§impl Unpin for ClosePath
§impl !UnwindSafe for ClosePath
Blanket Implementations§
Source§impl<T> BorrowMut<T> for Twhere
+ T: ?Sized,
Source§fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more§impl<F> FutureExt for F
§fn catch_unwind(self) -> CatchUnwind<Self>where
+ Self: Sized + UnwindSafe,
Catches panics while polling the future. Read more§impl<T> FutureExt for T
§fn with_cancellation_token(
+ self,
+ cancellation_token: &CancellationToken,
+) -> WithCancellationTokenFuture<'_, Self>where
+ Self: Sized,
Similar to [CancellationToken::run_until_cancelled],
+but with the advantage that it is easier to write fluent call chains,
+and biased towards waiting for [CancellationToken] to complete. Read more§fn with_cancellation_token_owned(
+ self,
+ cancellation_token: CancellationToken,
+) -> WithCancellationTokenFutureOwned<Self>where
+ Self: Sized,
Similar to [CancellationToken::run_until_cancelled_owned],
+but with the advantage that it is easier to write fluent call chains,
+and biased towards waiting for [CancellationToken] to complete. Read more§impl<T> Instrument for T
§fn instrument(self, span: Span) -> Instrumented<Self>
§fn in_current_span(self) -> Instrumented<Self>
Source§impl<T> IntoEither for T
Source§fn into_either(self, into_left: bool) -> Either<Self, Self>
Converts self into a Left variant of Either<Self, Self>
+if into_left is true.
+Converts self into a Right variant of Either<Self, Self>
+otherwise. Read moreSource§fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
Converts self into a Left variant of Either<Self, Self>
+if into_left(&self) returns true.
+Converts self into a Right variant of Either<Self, Self>
+otherwise. Read moreSource§impl<F> IntoFuture for Fwhere
+ F: Future,
Source§type IntoFuture = F
Which kind of future are we turning this into?Source§fn into_future(self) -> <F as IntoFuture>::IntoFuture
Creates a future from a value. Read more§impl<F, T, E> TryFuture for F
§impl<T> WithSubscriber for T
§fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>where
+ S: Into<Dispatch>,
§fn with_current_subscriber(self) -> WithDispatch<Self>
Attaches the current default Subscriber to this type, returning a
+[WithDispatch] wrapper. Read more
\ No newline at end of file
diff --git a/pr/255/docs/iroh_quinn/struct.ClosedStream.html b/pr/255/docs/iroh_quinn/struct.ClosedStream.html
index c9021984a..7d402dfa5 100644
--- a/pr/255/docs/iroh_quinn/struct.ClosedStream.html
+++ b/pr/255/docs/iroh_quinn/struct.ClosedStream.html
@@ -1,5 +1,5 @@
ClosedStream in iroh_quinn - Rust ClosedStream
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 more1.0.0 · Source§fn clone_from(&mut self, source: &Self)
Performs copy-assignment from source. Read moreSource§impl Debug for ClosedStream
Source§impl Default for ClosedStream
Source§fn default() -> ClosedStream
Returns the “default value” for a type. Read moreSource§impl Display for ClosedStream
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 more1.0.0 · Source§fn description(&self) -> &str
👎Deprecated since 1.42.0: use the Display impl or to_string()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,
+Trait Implementations§
Source§impl Clone for ClosedStream
Source§fn clone(&self) -> ClosedStream
Returns a duplicate of the value. Read more1.0.0 · Source§fn clone_from(&mut self, source: &Self)
Performs copy-assignment from source. Read moreSource§impl Debug for ClosedStream
Source§impl Default for ClosedStream
Source§fn default() -> ClosedStream
Returns the “default value” for a type. Read moreSource§impl Display for ClosedStream
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 more1.0.0 · Source§fn description(&self) -> &str
👎Deprecated since 1.42.0: use the Display impl or to_string()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§impl Eq for ClosedStream
Source§impl StructuralPartialEq for ClosedStream
Auto Trait Implementations§
§impl Freeze for ClosedStream
§impl RefUnwindSafe for ClosedStream
§impl Send for ClosedStream
§impl Sync for ClosedStream
§impl Unpin for ClosedStream
§impl UnwindSafe for ClosedStream
Blanket Implementations§
Source§impl<T> BorrowMut<T> for Twhere
diff --git a/pr/255/docs/iroh_quinn/struct.ConnectionClose.html b/pr/255/docs/iroh_quinn/struct.ConnectionClose.html
index babfc951e..853926ce5 100644
--- a/pr/255/docs/iroh_quinn/struct.ConnectionClose.html
+++ b/pr/255/docs/iroh_quinn/struct.ConnectionClose.html
@@ -1,13 +1,13 @@
-ConnectionClose in iroh_quinn - Rust ConnectionClose
pub struct ConnectionClose {
+ConnectionClose in iroh_quinn - Rust ConnectionClose
pub struct ConnectionClose {
pub error_code: Code,
- pub frame_type: MaybeFrame,
+ pub frame_type: MaybeFrame,
pub reason: Bytes,
}
Expand description
Reason given by the transport for closing the connection
Fields§
§error_code: CodeClass of error as encoded in the specification
-§frame_type: MaybeFrameType of frame that caused the close
+§frame_type: MaybeFrameType of frame that caused the close
§reason: BytesHuman-readable reason for the close
-Trait Implementations§
Source§impl Clone for ConnectionClose
Source§fn clone(&self) -> ConnectionClose
Returns a duplicate of the value. Read more1.0.0 · Source§fn clone_from(&mut self, source: &Self)
Performs copy-assignment from source. Read moreSource§impl Debug for ConnectionClose
Source§impl Display for ConnectionClose
Source§impl From<Error> for ConnectionClose
Source§fn from(x: Error) -> ConnectionClose
Converts to this type from the input type.Source§impl PartialEq for ConnectionClose
Source§impl Eq for ConnectionClose
Source§impl StructuralPartialEq for ConnectionClose
Auto Trait Implementations§
§impl !Freeze for ConnectionClose
§impl RefUnwindSafe for ConnectionClose
§impl Send for ConnectionClose
§impl Sync for ConnectionClose
§impl Unpin for ConnectionClose
§impl UnwindSafe for ConnectionClose
Blanket Implementations§
Source§impl<T> Any for Twhere
+Trait Implementations§
Source§impl Clone for ConnectionClose
Source§fn clone(&self) -> ConnectionClose
Returns a duplicate of the value. Read more1.0.0 · Source§fn clone_from(&mut self, source: &Self)
Performs copy-assignment from source. Read moreSource§impl Debug for ConnectionClose
Source§impl Display for ConnectionClose
Source§impl From<Error> for ConnectionClose
Source§fn from(x: Error) -> ConnectionClose
Converts to this type from the input type.Source§impl PartialEq for ConnectionClose
Source§impl Eq for ConnectionClose
Source§impl StructuralPartialEq for ConnectionClose
Auto Trait Implementations§
§impl !Freeze for ConnectionClose
§impl RefUnwindSafe for ConnectionClose
§impl Send for ConnectionClose
§impl Sync for ConnectionClose
§impl Unpin for ConnectionClose
§impl UnwindSafe for ConnectionClose
Blanket Implementations§
Source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
Source§fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read moreSource§impl<T> CloneToUninit for Twhere
diff --git a/pr/255/docs/iroh_quinn/struct.Endpoint.html b/pr/255/docs/iroh_quinn/struct.Endpoint.html
index df16aa143..d023d3a0a 100644
--- a/pr/255/docs/iroh_quinn/struct.Endpoint.html
+++ b/pr/255/docs/iroh_quinn/struct.Endpoint.html
@@ -1,8 +1,8 @@
-Endpoint in iroh_quinn - Rust Endpoint
pub struct Endpoint { /* private fields */ }
Expand description
A QUIC endpoint.
+Endpoint in iroh_quinn - Rust Endpoint
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.
-Implementations§
Source§impl Endpoint
Sourcepub fn client(addr: SocketAddr) -> Result<Self>
Helper to construct an endpoint for use with outgoing connections only
+Implementations§
Source§impl Endpoint
Sourcepub fn client(addr: SocketAddr) -> Result<Self>
Helper to construct an endpoint for use with outgoing connections only
Note that addr is the local address to bind to, which should usually be a wildcard
address like 0.0.0.0:0 or [::]:0, which allow communication with any reachable IPv4 or
IPv6 address respectively from an OS-assigned port.
@@ -14,19 +14,19 @@ address. For example:
iroh_quinn::Endpoint::client((std::net::Ipv6Addr::UNSPECIFIED, 0).into());
Some environments may not allow creation of dual-stack sockets, in which case an IPv6
client will only be able to connect to IPv6 servers. An IPv4 client is never dual-stack.
-Sourcepub fn stats(&self) -> EndpointStats
Returns relevant stats from this Endpoint
-Sourcepub fn server(config: ServerConfig, addr: SocketAddr) -> Result<Self>
Helper to construct an endpoint for use with both incoming and outgoing connections
+Sourcepub fn stats(&self) -> EndpointStats
Returns relevant stats from this Endpoint
+Sourcepub fn server(config: ServerConfig, addr: SocketAddr) -> Result<Self>
Helper to construct an endpoint for use with both incoming and outgoing connections
Platform defaults for dual-stack sockets vary. For example, any socket bound to a wildcard
IPv6 address on Windows will not by default be able to communicate with IPv4
addresses. Portable applications should bind an address that matches the family they wish to
communicate within.
-Sourcepub fn new(
config: EndpointConfig,
server_config: Option<ServerConfig>,
socket: UdpSocket,
runtime: Arc<dyn Runtime>,
) -> Result<Self>
Construct an endpoint with arbitrary configuration and socket
-Sourcepub fn new_with_abstract_socket(
+
Sourcepub fn new_with_abstract_socket(
config: EndpointConfig,
server_config: Option<ServerConfig>,
socket: Box<dyn AsyncUdpSocket>,
@@ -34,13 +34,13 @@ communicate within.
) -> Result<Self>
Construct an endpoint with arbitrary configuration and pre-constructed abstract socket
Useful when socket has additional state (e.g. sidechannels) attached for which shared
ownership is needed.
-Sourcepub fn accept(&self) -> Accept<'_> ⓘ
Get the next incoming connection attempt from a client
Yields Incomings, or None if the endpoint is closed. Incoming
can be awaited to obtain the final Connection, or used to e.g.
filter connection attempts or force address validation, or converted into an intermediate
Connecting future which can be used to e.g. send 0.5-RTT data.
-Sourcepub fn set_default_client_config(&mut self, config: ClientConfig)
Set the client configuration used by connect
-Sourcepub fn set_default_client_config(&self, config: ClientConfig)
Set the client configuration used by connect
+Sourcepub fn connect(
&self,
addr: SocketAddr,
server_name: &str,
@@ -50,26 +50,26 @@ connection from being intercepted by an attacker with a valid certificate for so
server.
May fail immediately due to configuration errors, or in the future if the connection could
not be established.
-
Sourcepub fn connect_with(
+
Sourcepub fn connect_with(
&self,
config: ClientConfig,
addr: SocketAddr,
server_name: &str,
) -> Result<Connecting, ConnectError>
Connect to a remote endpoint using a custom configuration.
See connect() for details.
-Sourcepub fn rebind(&self, socket: UdpSocket) -> Result<()>
Switch to a new UDP socket
See Endpoint::rebind_abstract() for details.
-Sourcepub fn rebind_abstract(&self, socket: Box<dyn AsyncUdpSocket>) -> Result<()>
Switch to a new UDP socket
+Sourcepub fn rebind_abstract(&self, socket: Box<dyn AsyncUdpSocket>) -> Result<()>
Switch to a new UDP socket
Allows the endpoint’s address to be updated live, affecting all active connections. Incoming
connections and connections to servers unreachable from the new address will be lost.
On error, the old UDP socket is retained.
-Sourcepub fn set_server_config(&self, server_config: Option<ServerConfig>)
Replace the server configuration, affecting new incoming connections only
+Sourcepub fn set_server_config(&self, server_config: Option<ServerConfig>)
Replace the server configuration, affecting new incoming connections only
Useful for e.g. refreshing TLS certificates without disrupting existing connections.
-Sourcepub fn local_addr(&self) -> Result<SocketAddr>
Get the local SocketAddr the underlying socket is bound to
-Sourcepub fn open_connections(&self) -> usize
Get the number of connections that are currently open
-Sourcepub fn close(&self, error_code: VarInt, reason: &[u8])
Close all of this endpoint’s connections immediately and cease accepting new connections.
+Sourcepub fn local_addr(&self) -> Result<SocketAddr>
Get the local SocketAddr the underlying socket is bound to
+Sourcepub fn open_connections(&self) -> usize
Get the number of connections that are currently open
+Sourcepub fn close(&self, error_code: VarInt, reason: &[u8])
Close all of this endpoint’s connections immediately and cease accepting new connections.
See Connection::close() for details.
-Sourcepub async fn wait_idle(&self)
Wait for all connections on the endpoint to be cleanly shut down
+Sourcepub async fn wait_idle(&self)
Wait for all connections on the endpoint to be cleanly shut down
Waiting for this condition before exiting ensures that a good-faith effort is made to notify
peers of recent connection closes, whereas exiting immediately could force them to wait out
the idle timeout period.
diff --git a/pr/255/docs/iroh_quinn/struct.EndpointStats.html b/pr/255/docs/iroh_quinn/struct.EndpointStats.html
index 4500b994a..efaa12c4b 100644
--- a/pr/255/docs/iroh_quinn/struct.EndpointStats.html
+++ b/pr/255/docs/iroh_quinn/struct.EndpointStats.html
@@ -1,4 +1,4 @@
-EndpointStats in iroh_quinn - Rust EndpointStats
#[non_exhaustive]pub struct EndpointStats {
+EndpointStats in iroh_quinn - Rust EndpointStats
#[non_exhaustive]pub struct EndpointStats {
pub accepted_handshakes: u64,
pub outgoing_handshakes: u64,
pub refused_handshakes: u64,
@@ -8,7 +8,7 @@
§outgoing_handshakes: u64Cumulative number of Quic handshakes sent from this Endpoint
§refused_handshakes: u64Cumulative number of Quic handshakes refused on this Endpoint
§ignored_handshakes: u64Cumulative number of Quic handshakes ignored on this Endpoint
-Trait Implementations§
Source§impl Clone for EndpointStats
Source§fn clone(&self) -> EndpointStats
Returns a duplicate of the value. Read more1.0.0 · Source§fn clone_from(&mut self, source: &Self)
Performs copy-assignment from source. Read moreSource§impl Debug for EndpointStats
Source§impl Default for EndpointStats
Source§fn default() -> EndpointStats
Returns the “default value” for a type. Read moreSource§impl Copy for EndpointStats
Auto Trait Implementations§
§impl Freeze for EndpointStats
§impl RefUnwindSafe for EndpointStats
§impl Send for EndpointStats
§impl Sync for EndpointStats
§impl Unpin for EndpointStats
§impl UnwindSafe for EndpointStats
Blanket Implementations§
Source§impl<T> Any for Twhere
+Trait Implementations§
Source§impl Clone for EndpointStats
Source§fn clone(&self) -> EndpointStats
Returns a duplicate of the value. Read more1.0.0 · Source§fn clone_from(&mut self, source: &Self)
Performs copy-assignment from source. Read moreSource§impl Debug for EndpointStats
Source§impl Default for EndpointStats
Source§fn default() -> EndpointStats
Returns the “default value” for a type. Read moreSource§impl Copy for EndpointStats
Auto Trait Implementations§
§impl Freeze for EndpointStats
§impl RefUnwindSafe for EndpointStats
§impl Send for EndpointStats
§impl Sync for EndpointStats
§impl Unpin for EndpointStats
§impl UnwindSafe for EndpointStats
Blanket Implementations§
Source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
Source§fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read moreSource§impl<T> CloneToUninit for Twhere
diff --git a/pr/255/docs/iroh_quinn/struct.InvalidCid.html b/pr/255/docs/iroh_quinn/struct.InvalidCid.html
new file mode 100644
index 000000000..8cc09d0a5
--- /dev/null
+++ b/pr/255/docs/iroh_quinn/struct.InvalidCid.html
@@ -0,0 +1,27 @@
+InvalidCid in iroh_quinn - Rust InvalidCid
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 more1.0.0 · Source§fn clone_from(&mut self, source: &Self)
Performs copy-assignment from source. Read moreSource§impl Debug for InvalidCid
Source§impl Copy for InvalidCid
Auto Trait Implementations§
§impl Freeze for InvalidCid
§impl RefUnwindSafe for InvalidCid
§impl Send for InvalidCid
§impl Sync for InvalidCid
§impl Unpin for InvalidCid
§impl UnwindSafe for InvalidCid
Blanket Implementations§
Source§impl<T> BorrowMut<T> for Twhere
+ T: ?Sized,
Source§fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read moreSource§impl<T> CloneToUninit for Twhere
+ T: Clone,
§impl<T> Instrument for T
§fn instrument(self, span: Span) -> Instrumented<Self>
§fn in_current_span(self) -> Instrumented<Self>
Source§impl<T> IntoEither for T
Source§fn into_either(self, into_left: bool) -> Either<Self, Self>
Converts self into a Left variant of Either<Self, Self>
+if into_left is true.
+Converts self into a Right variant of Either<Self, Self>
+otherwise. Read moreSource§fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
Converts self into a Left variant of Either<Self, Self>
+if into_left(&self) returns true.
+Converts self into a Right variant of Either<Self, Self>
+otherwise. Read more§impl<T> WithSubscriber for T
§fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>where
+ S: Into<Dispatch>,
§fn with_current_subscriber(self) -> WithDispatch<Self>
Attaches the current default Subscriber to this type, returning a
+[WithDispatch] wrapper. Read more
\ No newline at end of file
diff --git a/pr/255/docs/iroh_quinn/struct.Path.html b/pr/255/docs/iroh_quinn/struct.Path.html
index 5602610f3..e00724478 100644
--- a/pr/255/docs/iroh_quinn/struct.Path.html
+++ b/pr/255/docs/iroh_quinn/struct.Path.html
@@ -2,7 +2,7 @@
Implementations§
Source§impl Path
Sourcepub fn status(&self) -> Result<PathStatus, ClosedPath>
The current local PathStatus of this path.
Sourcepub fn set_status(&self, status: PathStatus) -> Result<(), SetPathStatusError>
Sets the PathStatus of this path.
-Sourcepub fn close(&self) -> Result<ClosePath, ClosePathError>
Closes this path
+Sourcepub fn close(&self) -> Result<ClosePath, ClosePathError>
Closes this path
The future will resolve when all the path state is dropped. This only happens after
the remote has confirmed the path as closed and after an additional timeout to
give any in-flight packets the time to arrive.
@@ -18,7 +18,7 @@ give any in-flight packets the time to arrive.
) -> Result<Option<Duration>, ClosedPath>Sets the keep_alive_interval for a specific path
See TransportConfig::default_path_keep_alive_interval for details.
Returns the previous value of the setting.
-Sourcepub fn observed_external_addr(&self) -> Result<AddressDiscovery, ClosedPath>
Track changes on our external address as reported by the peer.
+Sourcepub fn observed_external_addr(&self) -> Result<AddressDiscovery, ClosedPath>
Track changes on our external address as reported by the peer.
If the address-discovery extension is not negotiated, the stream will never return.
Sourcepub fn remote_address(&self) -> Result<SocketAddr, ClosedPath>
The peer’s UDP address for this path.
Sourcepub fn ping(&self) -> Result<(), ClosedPath>
Ping the remote endpoint over this path.
diff --git a/pr/255/docs/iroh_quinn/struct.SendStream.html b/pr/255/docs/iroh_quinn/struct.SendStream.html
index 069c8def7..0ec06cb61 100644
--- a/pr/255/docs/iroh_quinn/struct.SendStream.html
+++ b/pr/255/docs/iroh_quinn/struct.SendStream.html
@@ -8,7 +8,7 @@ ready will always result in no data being written to the stream. This is true of
succeed immediately when any progress is made, and is not true of methods which might need to
perform multiple writes internally before succeeding. Each write method documents whether it is
cancel-safe.
-Implementations§
Source§impl SendStream
Sourcepub async fn write(&mut self, buf: &[u8]) -> Result<usize, WriteError>
Write a buffer into this stream, returning how many bytes were written
+Implementations§
Source§impl SendStream
Sourcepub async fn write(&mut self, buf: &[u8]) -> Result<usize, WriteError>
Write a buffer into this stream, returning how many bytes were written
Unless this method errors, it waits until some amount of buf can be written into this
stream, and then writes as much as it can without waiting again. Due to congestion and flow
control, this may be shorter than buf.len(). On success this yields the length of the
@@ -58,7 +58,7 @@ or an error occurs. This method mutates bufs by mutating all chunks
§Cancel safety
This method is not cancellation safe. Even if this does not resolve, some bytes may have
been written when previously polled.
-Sourcepub fn finish(&mut self) -> Result<(), ClosedStream>
Notify the peer that no more data will ever be written to this stream
+Sourcepub fn finish(&mut self) -> Result<(), ClosedStream>
Notify the peer that no more data will ever be written to this stream
It is an error to write to a SendStream after finish()ing it. reset()
may still be called after finish to abandon transmission of any stream data that might
still be buffered.
@@ -66,21 +66,21 @@ still be buffered.
May fail if finish() or reset() was previously
called. This error is harmless and serves only to indicate that the caller may have
incorrect assumptions about the stream’s state.
-Sourcepub fn reset(&mut self, error_code: VarInt) -> Result<(), ClosedStream>
Close the send stream immediately.
+Sourcepub fn reset(&mut self, error_code: VarInt) -> Result<(), ClosedStream>
Close the send stream immediately.
No new data can be written after calling this method. Locally buffered data is dropped, and
previously transmitted data will no longer be retransmitted if lost. If an attempt has
already been made to finish the stream, the peer may still receive all written data.
May fail if finish() or reset() was previously
called. This error is harmless and serves only to indicate that the caller may have
incorrect assumptions about the stream’s state.
-Sourcepub fn set_priority(&self, priority: i32) -> Result<(), ClosedStream>
Set the priority of the send stream
+Sourcepub fn set_priority(&self, priority: i32) -> Result<(), ClosedStream>
Set the priority of the send stream
Every send stream has an initial priority of 0. Locally buffered data from streams with
higher priority will be transmitted before data from streams with lower priority. Changing
the priority of a stream with pending data may only take effect after that data has been
transmitted. Using many different priority levels per connection may have a negative
impact on performance.
-Sourcepub fn priority(&self) -> Result<i32, ClosedStream>
Get the priority of the send stream
-Sourcepub fn priority(&self) -> Result<i32, ClosedStream>
Get the priority of the send stream
+Sourcepub fn stopped(
&self,
) -> impl Future<Output = Result<Option<VarInt>, StoppedError>> + Send + Sync + 'static
Completes when the peer stops the stream or reads the stream to completion
Yields Some with the stop error code if the peer stops the stream. Yields None if the
@@ -90,8 +90,8 @@ closing the stream is no longer meaningful.
For a variety of reasons, the peer may not send acknowledgements immediately upon receiving
data. As such, relying on stopped to know when the peer has read a stream to completion
may introduce more latency than using an application-level response of some sort.
-Sourcepub fn poll_write(
+
Sourcepub fn poll_write(
self: Pin<&mut Self>,
cx: &mut Context<'_>,
buf: &[u8],
@@ -100,22 +100,22 @@ may introduce more latency than using an application-level response of some sort
If the stream is not ready for writing, the method returns Poll::Pending and arranges
for the current task (via cx.waker().wake_by_ref()) to receive a notification when the
stream becomes writable or is closed.
-
Trait Implementations§
Source§impl AsyncWrite for SendStream
Available on crate feature futures-io only.
Source§fn poll_write(
+
Trait Implementations§
Source§impl AsyncWrite for SendStream
Available on crate feature futures-io only.
Source§fn poll_write(
self: Pin<&mut Self>,
cx: &mut Context<'_>,
buf: &[u8],
-) -> Poll<Result<usize>>
Attempt to write bytes from buf into the object. Read moreSource§fn poll_flush(self: Pin<&mut Self>, _cx: &mut Context<'_>) -> Poll<Result<()>>
Attempt to flush the object, ensuring that any buffered data reach
-their destination. Read moreSource§fn poll_close(self: Pin<&mut Self>, _cx: &mut Context<'_>) -> Poll<Result<()>>
Attempt to close the object. Read more§fn poll_write_vectored(
+) -> Poll<Result<usize>>
Attempt to write bytes from buf into the object. Read moreSource§fn poll_flush(self: Pin<&mut Self>, _cx: &mut Context<'_>) -> Poll<Result<()>>
Attempt to flush the object, ensuring that any buffered data reach
+their destination. Read moreSource§impl AsyncWrite for SendStream
Source§fn poll_write(
+IO operations. Read more
Source§impl AsyncWrite for SendStream
Source§fn poll_write(
self: Pin<&mut Self>,
cx: &mut Context<'_>,
buf: &[u8],
-) -> Poll<Result<usize>>
Attempt to write bytes from buf into the object. Read moreSource§fn poll_flush(self: Pin<&mut Self>, _cx: &mut Context<'_>) -> Poll<Result<()>>
Attempts to flush the object, ensuring that any buffered data reach
-their destination. Read moreSource§fn poll_shutdown(
+) -> Poll<Result<usize>>
Attempt to write bytes from buf into the object. Read moreSource§fn poll_flush(self: Pin<&mut Self>, _cx: &mut Context<'_>) -> Poll<Result<()>>
Attempts to flush the object, ensuring that any buffered data reach
+their destination. Read moreSource§fn poll_shutdown(
self: Pin<&mut Self>,
_cx: &mut Context<'_>,
) -> Poll<Result<()>>
Initiates or attempts to shut down this writer, returning success when
@@ -124,7 +124,7 @@ the I/O connection has completely shut down. Read moreContext<'_>,
bufs: &[IoSlice<'_>],
) -> Poll<Result<usize, Error>>Like poll_write, except that it writes from a slice of buffers. Read more§fn is_write_vectored(&self) -> bool
Determines if this writer has an efficient poll_write_vectored
-implementation. Read more Source§impl Debug for SendStream
Auto Trait Implementations§
§impl Freeze for SendStream
§impl RefUnwindSafe for SendStream
§impl Send for SendStream
§impl Sync for SendStream
§impl Unpin for SendStream
§impl UnwindSafe for SendStream
Blanket Implementations§
Source§impl Debug for SendStream
Auto Trait Implementations§
§impl Freeze for SendStream
§impl RefUnwindSafe for SendStream
§impl Send for SendStream
§impl Sync for SendStream
§impl Unpin for SendStream
§impl UnwindSafe for SendStream
Blanket Implementations§
§impl<W> AsyncWriteExt for Wwhere
W: AsyncWrite + ?Sized,
§fn write<'a>(&'a mut self, src: &'a [u8]) -> Write<'a, Self>where
Self: Unpin,
Writes a buffer into this writer, returning how many bytes were
diff --git a/pr/255/docs/iroh_quinn/struct.StdSystemTime.html b/pr/255/docs/iroh_quinn/struct.StdSystemTime.html
index 601433e0b..75e3b81a5 100644
--- a/pr/255/docs/iroh_quinn/struct.StdSystemTime.html
+++ b/pr/255/docs/iroh_quinn/struct.StdSystemTime.html
@@ -1,6 +1,6 @@
-StdSystemTime in iroh_quinn - Rust StdSystemTime
pub struct StdSystemTime;
Expand description
Default implementation of TimeSource
+StdSystemTime in iroh_quinn - Rust StdSystemTime
pub struct StdSystemTime;
Expand description
Default implementation of TimeSource
Implements now by calling SystemTime::now().
-Trait Implementations§
Source§impl TimeSource for StdSystemTime
Source§fn now(&self) -> SystemTime
Get SystemTime::now() or the mocked equivalentAuto Trait Implementations§
§impl Freeze for StdSystemTime
§impl RefUnwindSafe for StdSystemTime
§impl Send for StdSystemTime
§impl Sync for StdSystemTime
§impl Unpin for StdSystemTime
§impl UnwindSafe for StdSystemTime
Blanket Implementations§
Trait Implementations§
Source§impl TimeSource for StdSystemTime
Source§fn now(&self) -> SystemTime
Get SystemTime::now() or the mocked equivalentAuto Trait Implementations§
§impl Freeze for StdSystemTime
§impl RefUnwindSafe for StdSystemTime
§impl Send for StdSystemTime
§impl Sync for StdSystemTime
§impl Unpin for StdSystemTime
§impl UnwindSafe for StdSystemTime
Blanket Implementations§
Source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
Source§fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read moreSource§impl<T> From<T> for T
Source§fn from(t: T) -> T
Returns the argument unchanged.
diff --git a/pr/255/docs/iroh_quinn/struct.StreamId.html b/pr/255/docs/iroh_quinn/struct.StreamId.html
index 7d288c046..cd7352208 100644
--- a/pr/255/docs/iroh_quinn/struct.StreamId.html
+++ b/pr/255/docs/iroh_quinn/struct.StreamId.html
@@ -1,26 +1,26 @@
-StreamId in iroh_quinn - Rust StreamId
pub struct StreamId(/* private fields */);
Expand description
Identifier for a stream within a particular connection
-Implementations§
Trait Implementations§
Source§impl<'arbitrary> Arbitrary<'arbitrary> for StreamId
Source§fn arbitrary(u: &mut Unstructured<'arbitrary>) -> Result<StreamId, Error>
Generate an arbitrary value of Self from the given unstructured data. Read moreSource§fn arbitrary_take_rest(u: Unstructured<'arbitrary>) -> Result<StreamId, Error>
Generate an arbitrary value of Self from the entirety of the given
-unstructured data. Read moreSource§fn size_hint(depth: usize) -> (usize, Option<usize>)
Get a size hint for how many bytes out of an Unstructured this type
-needs to construct itself. Read moreSource§fn try_size_hint(
+StreamId in iroh_quinn - Rust StreamId
pub struct StreamId(/* private fields */);
Expand description
Identifier for a stream within a particular connection
+Implementations§
Trait Implementations§
Source§impl<'arbitrary> Arbitrary<'arbitrary> for StreamId
Source§fn arbitrary(u: &mut Unstructured<'arbitrary>) -> Result<StreamId, Error>
Generate an arbitrary value of Self from the given unstructured data. Read moreSource§fn arbitrary_take_rest(u: Unstructured<'arbitrary>) -> Result<StreamId, Error>
Generate an arbitrary value of Self from the entirety of the given
+unstructured data. Read moreSource§impl Ord for StreamId
Source§impl PartialOrd for StreamId
Source§impl PartialOrd for StreamId
Source§impl Copy for StreamId
Source§impl Eq for StreamId
Source§impl StructuralPartialEq for StreamId
Auto Trait Implementations§
§impl Freeze for StreamId
§impl RefUnwindSafe for StreamId
§impl Send for StreamId
§impl Sync for StreamId
§impl Unpin for StreamId
§impl UnwindSafe for StreamId
Blanket Implementations§
Source§impl Copy for StreamId
Source§impl Eq for StreamId
Source§impl StructuralPartialEq for StreamId
Auto Trait Implementations§
§impl Freeze for StreamId
§impl RefUnwindSafe for StreamId
§impl Send for StreamId
§impl Sync for StreamId
§impl Unpin for StreamId
§impl UnwindSafe for StreamId
Blanket Implementations§
Source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
Source§fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read moreSource§impl<T> CloneToUninit for Twhere
diff --git a/pr/255/docs/iroh_quinn/struct.Transmit.html b/pr/255/docs/iroh_quinn/struct.Transmit.html
index c36db78b0..10970ac6e 100644
--- a/pr/255/docs/iroh_quinn/struct.Transmit.html
+++ b/pr/255/docs/iroh_quinn/struct.Transmit.html
@@ -1,4 +1,4 @@
-Transmit in iroh_quinn - Rust Transmit
pub struct Transmit {
+Transmit in iroh_quinn - Rust Transmit
pub struct Transmit {
pub destination: SocketAddr,
pub ecn: Option<EcnCodepoint>,
pub size: usize,
@@ -11,7 +11,7 @@
§segment_size: Option<usize>The segment size if this transmission contains multiple datagrams.
This is None if the transmit only contains a single datagram
§src_ip: Option<IpAddr>Optional source IP address for the datagram
-Trait Implementations§