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§
- Bbr3
- Experimental! Use at your own risk.
- Bbr3
Config - Configuration for the
Bbr3congestion controller - Controller
Metrics - Common congestion controller metrics used both for logging purposes
but also to alter the pacing of the connection with
pacing_rateandsend_quantum - 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
Module crypto
Expand description
Traits and implementations for the QUIC cryptography protocol
+Module crypto
Expand description
Traits and implementations for the QUIC cryptography protocol
The protocol logic in noq is contained in types that abstract over the actual cryptographic protocol used. This module contains the traits used for this abstraction layer as well as a single implementation of these traits that uses diff --git a/pr/617/docs/noq/enum.ClosePathError.html b/pr/617/docs/noq/enum.ClosePathError.html index e09239da0..53efcf582 100644 --- a/pr/617/docs/noq/enum.ClosePathError.html +++ b/pr/617/docs/noq/enum.ClosePathError.html @@ -1,4 +1,4 @@ -
ClosePathError
pub enum ClosePathError {
+ClosePathError in noq - Rust ClosePathError
pub enum ClosePathError {
MultipathNotNegotiated,
ClosedPath,
LastOpenPath,
@@ -7,8 +7,8 @@
§ClosedPath
The path is already closed or was never opened
§LastOpenPath
Cannot close the last remaining open path via the local API.
Use Connection::close to end the connection instead.
-Trait Implementations§
Source§impl Clone for ClosePathError
impl Clone for ClosePathError
Source§fn clone(&self) -> ClosePathError
fn clone(&self) -> ClosePathError
1.0.0 · Source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source. Read moreSource§impl Debug for ClosePathError
impl Debug for ClosePathError
Source§impl Display for ClosePathError
impl Display for ClosePathError
Source§impl Error for ClosePathError
impl Error for ClosePathError
1.30.0 · Source§fn source(&self) -> Option<&(dyn Error + 'static)>
fn source(&self) -> Option<&(dyn Error + 'static)>
1.0.0 · Source§fn description(&self) -> &str
fn description(&self) -> &str
Source§impl PartialEq for ClosePathError
impl PartialEq for ClosePathError
impl Eq for ClosePathError
impl StructuralPartialEq for ClosePathError
Auto Trait Implementations§
impl Freeze for ClosePathError
impl RefUnwindSafe for ClosePathError
impl Send for ClosePathError
impl Sync for ClosePathError
impl Unpin for ClosePathError
impl UnwindSafe for ClosePathError
Blanket Implementations§
Trait Implementations§
Source§impl Clone for ClosePathError
impl Clone for ClosePathError
Source§fn clone(&self) -> ClosePathError
fn clone(&self) -> ClosePathError
1.0.0 · Source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source. Read moreSource§impl Debug for ClosePathError
impl Debug for ClosePathError
Source§impl Display for ClosePathError
impl Display for ClosePathError
Source§impl Error for ClosePathError
impl Error for ClosePathError
1.30.0 · Source§fn source(&self) -> Option<&(dyn Error + 'static)>
fn source(&self) -> Option<&(dyn Error + 'static)>
1.0.0 · Source§fn description(&self) -> &str
fn description(&self) -> &str
Source§impl PartialEq for ClosePathError
impl PartialEq for ClosePathError
impl Eq for ClosePathError
impl StructuralPartialEq for ClosePathError
Auto Trait Implementations§
impl Freeze for ClosePathError
impl RefUnwindSafe for ClosePathError
impl Send for ClosePathError
impl Sync for ClosePathError
impl Unpin for ClosePathError
impl UnwindSafe for ClosePathError
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/617/docs/noq/enum.ConfigError.html b/pr/617/docs/noq/enum.ConfigError.html
index e04597bbe..5e526b4b2 100644
--- a/pr/617/docs/noq/enum.ConfigError.html
+++ b/pr/617/docs/noq/enum.ConfigError.html
@@ -1,9 +1,9 @@
-ConfigError in noq - Rust ConfigError
#[non_exhaustive]pub enum ConfigError {
+ConfigError in noq - 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/617/docs/noq/enum.ConnectionError.html b/pr/617/docs/noq/enum.ConnectionError.html
index d9e87d540..21a2c4a10 100644
--- a/pr/617/docs/noq/enum.ConnectionError.html
+++ b/pr/617/docs/noq/enum.ConnectionError.html
@@ -1,4 +1,4 @@
-ConnectionError in noq - Rust ConnectionError
pub enum ConnectionError {
+ConnectionError in noq - 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/617/docs/noq/enum.Dir.html b/pr/617/docs/noq/enum.Dir.html
index 43d1fb0f4..5e2e27f31 100644
--- a/pr/617/docs/noq/enum.Dir.html
+++ b/pr/617/docs/noq/enum.Dir.html
@@ -1,25 +1,25 @@
-Dir in noq - Rust Dir
pub enum Dir {
+Dir in noq - 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/617/docs/noq/enum.PathError.html b/pr/617/docs/noq/enum.PathError.html
index b2129d2f5..715d048e9 100644
--- a/pr/617/docs/noq/enum.PathError.html
+++ b/pr/617/docs/noq/enum.PathError.html
@@ -1,4 +1,4 @@
-PathError in noq - Rust PathError
pub enum PathError {
+PathError in noq - Rust PathError
pub enum PathError {
MultipathNotNegotiated,
ServerSideNotAllowed,
MaxPathIdReached,
@@ -12,8 +12,8 @@
§RemoteCidsExhausted
No remote CIDs available to open a new path
§ValidationFailed
Path could not be validated and will be abandoned
§InvalidRemoteAddress(SocketAddr)
The remote address for the path is not supported by the endpoint
-
Trait Implementations§
Source§impl Error for PathError
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 Copy for PathError
Source§impl Eq for PathError
Source§impl StructuralPartialEq for PathError
Auto Trait Implementations§
§impl Freeze for PathError
§impl RefUnwindSafe for PathError
§impl Send for PathError
§impl Sync for PathError
§impl Unpin for PathError
§impl UnwindSafe for PathError
Blanket Implementations§
Trait Implementations§
Source§impl Error for PathError
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 Copy for PathError
Source§impl Eq for PathError
Source§impl StructuralPartialEq for PathError
Auto Trait Implementations§
§impl Freeze for PathError
§impl RefUnwindSafe for PathError
§impl Send for PathError
§impl Sync for PathError
§impl Unpin for PathError
§impl UnwindSafe for PathError
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/617/docs/noq/enum.PathEvent.html b/pr/617/docs/noq/enum.PathEvent.html
index da4b6dad6..6a54cac03 100644
--- a/pr/617/docs/noq/enum.PathEvent.html
+++ b/pr/617/docs/noq/enum.PathEvent.html
@@ -1,4 +1,4 @@
-PathEvent in noq - Rust PathEvent
pub enum PathEvent {
+PathEvent in noq - Rust PathEvent
pub enum PathEvent {
Opened {
id: PathId,
},
@@ -39,8 +39,8 @@ changes the status.
Fields
§id: PathIdPath over which the observed address was reported, PathId::ZERO when multipath is
not negotiated
§addr: SocketAddrThe address observed by the remote over this path
-
Trait Implementations§
Source§impl Eq for PathEvent
Source§impl StructuralPartialEq for PathEvent
Auto Trait Implementations§
§impl Freeze for PathEvent
§impl RefUnwindSafe for PathEvent
§impl Send for PathEvent
§impl Sync for PathEvent
§impl Unpin for PathEvent
§impl UnwindSafe for PathEvent
Blanket Implementations§
Trait Implementations§
Source§impl Eq for PathEvent
Source§impl StructuralPartialEq for PathEvent
Auto Trait Implementations§
§impl Freeze for PathEvent
§impl RefUnwindSafe for PathEvent
§impl Send for PathEvent
§impl Sync for PathEvent
§impl Unpin for PathEvent
§impl UnwindSafe for PathEvent
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/617/docs/noq/enum.PathStatus.html b/pr/617/docs/noq/enum.PathStatus.html
index 4422c371b..9298a8940 100644
--- a/pr/617/docs/noq/enum.PathStatus.html
+++ b/pr/617/docs/noq/enum.PathStatus.html
@@ -1,4 +1,4 @@
-PathStatus in noq - Rust PathStatus
pub enum PathStatus {
+PathStatus in noq - Rust PathStatus
pub enum PathStatus {
Available,
Backup,
}
Expand description
The QUIC-MULTIPATH path status
@@ -10,8 +10,8 @@ capacity.
§Backup
Paths marked as backup will only be used if there are no available paths
If the max_idle_timeout is specified the path will be kept alive so that it does not
expire.
-Trait Implementations§
Source§impl Clone for PathStatus
Source§fn clone(&self) -> PathStatus
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 PathStatus
Source§impl Default for PathStatus
Source§fn default() -> PathStatus
Returns the “default value” for a type. Read moreSource§impl PartialEq for PathStatus
Source§impl Copy for PathStatus
Source§impl Eq for PathStatus
Source§impl StructuralPartialEq for PathStatus
Auto Trait Implementations§
§impl Freeze for PathStatus
§impl RefUnwindSafe for PathStatus
§impl Send for PathStatus
§impl Sync for PathStatus
§impl Unpin for PathStatus
§impl UnwindSafe for PathStatus
Blanket Implementations§
Trait Implementations§
Source§impl Clone for PathStatus
Source§fn clone(&self) -> PathStatus
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 PathStatus
Source§impl Default for PathStatus
Source§fn default() -> PathStatus
Returns the “default value” for a type. Read moreSource§impl PartialEq for PathStatus
Source§impl Copy for PathStatus
Source§impl Eq for PathStatus
Source§impl StructuralPartialEq for PathStatus
Auto Trait Implementations§
§impl Freeze for PathStatus
§impl RefUnwindSafe for PathStatus
§impl Send for PathStatus
§impl Sync for PathStatus
§impl Unpin for PathStatus
§impl UnwindSafe for PathStatus
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/617/docs/noq/enum.SendDatagramError.html b/pr/617/docs/noq/enum.SendDatagramError.html
index 4ac61c63c..dbf07e2a6 100644
--- a/pr/617/docs/noq/enum.SendDatagramError.html
+++ b/pr/617/docs/noq/enum.SendDatagramError.html
@@ -1,4 +1,4 @@
-SendDatagramError in noq - Rust SendDatagramError
pub enum SendDatagramError {
+SendDatagramError in noq - Rust SendDatagramError
pub enum SendDatagramError {
UnsupportedByPeer,
Disabled,
TooLarge,
@@ -10,8 +10,8 @@
Indicates that the path MTU minus overhead or the limit advertised by the peer has been
exceeded.
§ConnectionLost(ConnectionError)
The connection was lost
-
Trait Implementations§
Source§impl Clone for SendDatagramError
Source§fn clone(&self) -> SendDatagramError
Returns a duplicate of the value. Read more1.0.0 · Source§fn clone_from(&mut self, source: &Self)
Performs copy-assignment from source. Read moreSource§impl Debug for SendDatagramError
Source§impl Display for SendDatagramError
Source§impl Error for SendDatagramError
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 SendDatagramError
Source§fn from(source: ConnectionError) -> Self
Converts to this type from the input type.Source§impl PartialEq for SendDatagramError
Source§impl Eq for SendDatagramError
Source§impl StructuralPartialEq for SendDatagramError
Auto Trait Implementations§
§impl !Freeze for SendDatagramError
§impl !RefUnwindSafe for SendDatagramError
§impl Send for SendDatagramError
§impl Sync for SendDatagramError
§impl Unpin for SendDatagramError
§impl !UnwindSafe for SendDatagramError
Blanket Implementations§
Trait Implementations§
Source§impl Clone for SendDatagramError
Source§fn clone(&self) -> SendDatagramError
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 SendDatagramError
Source§impl Display for SendDatagramError
Source§impl Error for SendDatagramError
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 SendDatagramError
Source§fn from(source: ConnectionError) -> Self
Converts to this type from the input type.Source§impl PartialEq for SendDatagramError
Source§impl Eq for SendDatagramError
Source§impl StructuralPartialEq for SendDatagramError
Auto Trait Implementations§
§impl !Freeze for SendDatagramError
§impl !RefUnwindSafe for SendDatagramError
§impl Send for SendDatagramError
§impl Sync for SendDatagramError
§impl Unpin for SendDatagramError
§impl !UnwindSafe for SendDatagramError
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/617/docs/noq/enum.SetPathStatusError.html b/pr/617/docs/noq/enum.SetPathStatusError.html
index 2a9557440..3bb2857be 100644
--- a/pr/617/docs/noq/enum.SetPathStatusError.html
+++ b/pr/617/docs/noq/enum.SetPathStatusError.html
@@ -1,11 +1,11 @@
-SetPathStatusError in noq - Rust SetPathStatusError
pub enum SetPathStatusError {
+SetPathStatusError in noq - Rust SetPathStatusError
pub enum SetPathStatusError {
ClosedPath,
MultipathNotNegotiated,
}
Expand description
Error from setting path status
Variants§
§ClosedPath
Error indicating that a path has not been opened or has already been abandoned
§MultipathNotNegotiated
Error indicating that this operation requires multipath to be negotiated whereas it hasn’t been
-Trait Implementations§
Source§impl Clone for SetPathStatusError
Source§fn clone(&self) -> SetPathStatusError
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 SetPathStatusError
Source§impl Display for SetPathStatusError
Source§impl Error for SetPathStatusError
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 PartialEq for SetPathStatusError
Source§impl Eq for SetPathStatusError
Source§impl StructuralPartialEq for SetPathStatusError
Auto Trait Implementations§
§impl Freeze for SetPathStatusError
§impl RefUnwindSafe for SetPathStatusError
§impl Send for SetPathStatusError
§impl Sync for SetPathStatusError
§impl Unpin for SetPathStatusError
§impl UnwindSafe for SetPathStatusError
Blanket Implementations§
Trait Implementations§
Source§impl Clone for SetPathStatusError
Source§fn clone(&self) -> SetPathStatusError
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 SetPathStatusError
Source§impl Display for SetPathStatusError
Source§impl Error for SetPathStatusError
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 PartialEq for SetPathStatusError
Source§impl Eq for SetPathStatusError
Source§impl StructuralPartialEq for SetPathStatusError
Auto Trait Implementations§
§impl Freeze for SetPathStatusError
§impl RefUnwindSafe for SetPathStatusError
§impl Send for SetPathStatusError
§impl Sync for SetPathStatusError
§impl Unpin for SetPathStatusError
§impl UnwindSafe for SetPathStatusError
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/617/docs/noq/enum.Side.html b/pr/617/docs/noq/enum.Side.html
index 211e245d6..2a88b859f 100644
--- a/pr/617/docs/noq/enum.Side.html
+++ b/pr/617/docs/noq/enum.Side.html
@@ -1,27 +1,27 @@
-Side in noq - Rust Side
pub enum Side {
+Side in noq - 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/617/docs/noq/struct.AcceptBi.html b/pr/617/docs/noq/struct.AcceptBi.html
index e2b6da590..213f9b881 100644
--- a/pr/617/docs/noq/struct.AcceptBi.html
+++ b/pr/617/docs/noq/struct.AcceptBi.html
@@ -1,6 +1,6 @@
-AcceptBi in noq - Rust AcceptBi
pub struct AcceptBi<'a> { /* private fields */ }
Expand description
Future produced by Connection::accept_bi
-Trait Implementations§
Source§impl Future for AcceptBi<'_>
Source§type Output = Result<(SendStream, RecvStream), ConnectionError>
The type of value produced on completion.Source§impl<'__pin, 'a> Unpin for AcceptBi<'a>where
+AcceptBi in noq - Rust AcceptBi
pub struct AcceptBi<'a> { /* private fields */ }
Expand description
Future produced by Connection::accept_bi
+Trait Implementations§
Source§impl Future for AcceptBi<'_>
Source§type Output = Result<(SendStream, RecvStream), ConnectionError>
The type of value produced on completion.Source§impl<'__pin, 'a> Unpin for AcceptBi<'a>where
PinnedFieldsOf<__Origin<'__pin, 'a>>: Unpin,
Auto Trait Implementations§
§impl<'a> !Freeze for AcceptBi<'a>
§impl<'a> !RefUnwindSafe for AcceptBi<'a>
§impl<'a> Send for AcceptBi<'a>
§impl<'a> Sync for AcceptBi<'a>
§impl<'a> !UnwindSafe for AcceptBi<'a>
Blanket Implementations§
Source§impl<T> BorrowMut<T> for Twhere
diff --git a/pr/617/docs/noq/struct.AcceptUni.html b/pr/617/docs/noq/struct.AcceptUni.html
index 725d4cf6f..485306ebe 100644
--- a/pr/617/docs/noq/struct.AcceptUni.html
+++ b/pr/617/docs/noq/struct.AcceptUni.html
@@ -1,6 +1,6 @@
-AcceptUni in noq - Rust AcceptUni
pub struct AcceptUni<'a> { /* private fields */ }
Expand description
Future produced by Connection::accept_uni
-Trait Implementations§
Source§impl Future for AcceptUni<'_>
Source§type Output = Result<RecvStream, ConnectionError>
The type of value produced on completion.Source§impl<'__pin, 'a> Unpin for AcceptUni<'a>where
+AcceptUni in noq - Rust AcceptUni
pub struct AcceptUni<'a> { /* private fields */ }
Expand description
Future produced by Connection::accept_uni
+Trait Implementations§
Source§impl Future for AcceptUni<'_>
Source§type Output = Result<RecvStream, ConnectionError>
The type of value produced on completion.Source§impl<'__pin, 'a> Unpin for AcceptUni<'a>where
PinnedFieldsOf<__Origin<'__pin, 'a>>: Unpin,
Auto Trait Implementations§
§impl<'a> !Freeze for AcceptUni<'a>
§impl<'a> !RefUnwindSafe for AcceptUni<'a>
§impl<'a> Send for AcceptUni<'a>
§impl<'a> Sync for AcceptUni<'a>
§impl<'a> !UnwindSafe for AcceptUni<'a>
Blanket Implementations§
Source§impl<T> BorrowMut<T> for Twhere
diff --git a/pr/617/docs/noq/struct.AckFrequencyConfig.html b/pr/617/docs/noq/struct.AckFrequencyConfig.html
index 2d3d900e9..20a7cff00 100644
--- a/pr/617/docs/noq/struct.AckFrequencyConfig.html
+++ b/pr/617/docs/noq/struct.AckFrequencyConfig.html
@@ -1,4 +1,4 @@
-AckFrequencyConfig in noq - Rust AckFrequencyConfig
pub struct AckFrequencyConfig { /* private fields */ }
Expand description
Parameters for controlling the peer’s acknowledgement frequency
+AckFrequencyConfig in noq - Rust AckFrequencyConfig
pub struct AckFrequencyConfig { /* private fields */ }
Expand description
Parameters for controlling the peer’s acknowledgement frequency
The parameters provided in this config will be sent to the peer at the beginning of the
connection, so it can take them into account when sending acknowledgements (see each parameter’s
description for details on how it influences acknowledgement frequency).
@@ -7,7 +7,7 @@ description for details on how it influences acknowledgement frequency).
The defaults produce behavior slightly different than the behavior without this extension,
because they change the way reordered packets are handled (see
AckFrequencyConfig::reordering_threshold for details).
-Implementations§
Source§impl AckFrequencyConfig
Sourcepub fn ack_eliciting_threshold(
+
Implementations§
Source§impl AckFrequencyConfig
Sourcepub fn ack_eliciting_threshold(
&mut self,
value: VarInt,
) -> &mut AckFrequencyConfig
The ack-eliciting threshold we will request the peer to use
@@ -17,7 +17,7 @@ without immediately sending an ACK.
ack-eliciting packets have been received. A value of 0 results in a receiver immediately
acknowledging every ack-eliciting packet.
Defaults to 1, which sends ACK frames for every other ack-eliciting packet.
-Sourcepub fn max_ack_delay(
+
Sourcepub fn max_ack_delay(
&mut self,
value: Option<Duration>,
) -> &mut AckFrequencyConfig
The max_ack_delay we will request the peer to use
@@ -27,7 +27,7 @@ an ACK when the ack-eliciting threshold hasn’t been reached.
transport parameter, and at most the greater of the current path RTT or 25ms.
Defaults to None, in which case the peer’s original max_ack_delay will be used, as
obtained from its transport parameters.
-Sourcepub fn reordering_threshold(&mut self, value: VarInt) -> &mut AckFrequencyConfig
The reordering threshold we will request the peer to use
+Sourcepub fn reordering_threshold(&mut self, value: VarInt) -> &mut AckFrequencyConfig
The reordering threshold we will request the peer to use
This threshold represents the amount of out-of-order packets that will trigger an endpoint
to send an ACK, without waiting for ack_eliciting_threshold to be exceeded or for
max_ack_delay to be elapsed.
@@ -37,7 +37,7 @@ behavior when the extension is disabled).
It is recommended to set this value to TransportConfig::packet_threshold minus one.
Since the default value for TransportConfig::packet_threshold is 3, this value defaults
to 2.
-Trait Implementations§
Source§impl Clone for AckFrequencyConfig
Source§fn clone(&self) -> AckFrequencyConfig
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 AckFrequencyConfig
Source§impl Default for AckFrequencyConfig
Source§fn default() -> AckFrequencyConfig
Returns the “default value” for a type. Read moreAuto Trait Implementations§
§impl Freeze for AckFrequencyConfig
§impl RefUnwindSafe for AckFrequencyConfig
§impl Send for AckFrequencyConfig
§impl Sync for AckFrequencyConfig
§impl Unpin for AckFrequencyConfig
§impl UnwindSafe for AckFrequencyConfig
Blanket Implementations§
Trait Implementations§
Source§impl Clone for AckFrequencyConfig
Source§fn clone(&self) -> AckFrequencyConfig
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 AckFrequencyConfig
Source§impl Default for AckFrequencyConfig
Source§fn default() -> AckFrequencyConfig
Returns the “default value” for a type. Read moreAuto Trait Implementations§
§impl Freeze for AckFrequencyConfig
§impl RefUnwindSafe for AckFrequencyConfig
§impl Send for AckFrequencyConfig
§impl Sync for AckFrequencyConfig
§impl Unpin for AckFrequencyConfig
§impl UnwindSafe for AckFrequencyConfig
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/617/docs/noq/struct.AddressDiscovery.html b/pr/617/docs/noq/struct.AddressDiscovery.html
index b14c5a0cd..22a2d8d82 100644
--- a/pr/617/docs/noq/struct.AddressDiscovery.html
+++ b/pr/617/docs/noq/struct.AddressDiscovery.html
@@ -1,7 +1,7 @@
-AddressDiscovery in noq - Rust AddressDiscovery
pub struct AddressDiscovery { /* private fields */ }
Expand description
Stream produced by Path::observed_external_addr
+AddressDiscovery in noq - 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
Trait Implementations§
Source§impl Stream for AddressDiscovery
Source§type Item = SocketAddr
Values yielded by the stream.Source§fn poll_next(
self: Pin<&mut Self>,
cx: &mut Context<'_>,
) -> Poll<Option<Self::Item>>
Attempt to pull out the next value of this stream, registering the
diff --git a/pr/617/docs/noq/struct.ClientConfig.html b/pr/617/docs/noq/struct.ClientConfig.html
index 8253ad80d..db7008c26 100644
--- a/pr/617/docs/noq/struct.ClientConfig.html
+++ b/pr/617/docs/noq/struct.ClientConfig.html
@@ -1,7 +1,7 @@
-ClientConfig in noq - Rust ClientConfig
#[non_exhaustive]pub struct ClientConfig { /* private fields */ }
Expand description
Configuration for outgoing connections
+ClientConfig in noq - 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(
+
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(
&mut self,
initial_dst_cid_provider: Arc<dyn Fn() -> ConnectionId + Send + Sync>,
) -> &mut ClientConfig
Configure how to populate the destination CID of the initial packet when attempting to
@@ -10,18 +10,18 @@ establish a new connection
a good reason, you do not need to change it.
When prefer to override the default, please note that the generated connection ID MUST be
at least 8 bytes long and unpredictable, as per section 7.2 of RFC 9000.
-Sourcepub fn transport_config(
+
Sourcepub fn transport_config(
&mut self,
transport: Arc<TransportConfig>,
) -> &mut ClientConfig
Set a custom TransportConfig
-Sourcepub fn token_store(&mut self, store: Arc<dyn TokenStore>) -> &mut ClientConfig
Set a custom TokenStore
+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 try_with_platform_verifier() -> Result<ClientConfig, Error>
Create a client configuration that trusts the platform’s native roots
-Sourcepub fn with_root_certificates(
+
Sourcepub fn version(&mut self, version: u32) -> &mut ClientConfig
Set the QUIC version to use
+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/617/docs/noq/struct.Closed.html b/pr/617/docs/noq/struct.Closed.html
index 51bccab3a..4bd279633 100644
--- a/pr/617/docs/noq/struct.Closed.html
+++ b/pr/617/docs/noq/struct.Closed.html
@@ -1,4 +1,4 @@
-Closed in noq - Rust Closed
#[non_exhaustive]pub struct Closed {
+Closed in noq - Rust Closed
#[non_exhaustive]pub struct Closed {
pub reason: ConnectionError,
pub stats: ConnectionStats,
pub path_stats: BTreeMap<PathId, PathStats>,
@@ -10,7 +10,7 @@
This includes paths that haven’t been discarded at close time, plus any
already-discarded paths whose final stats had been retained because a Path
or WeakPathHandle handle was kept alive.
-
Trait Implementations§
Auto Trait Implementations§
§impl !Freeze for Closed
§impl !RefUnwindSafe for Closed
§impl Send for Closed
§impl Sync for Closed
§impl Unpin for Closed
§impl !UnwindSafe for Closed
Blanket Implementations§
Source§impl<T> Any for Twhere
+Trait Implementations§
Auto Trait Implementations§
§impl !Freeze for Closed
§impl !RefUnwindSafe for Closed
§impl Send for Closed
§impl Sync for Closed
§impl Unpin for Closed
§impl !UnwindSafe for Closed
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/617/docs/noq/struct.ClosedPath.html b/pr/617/docs/noq/struct.ClosedPath.html
index 38e0c7a7a..5c7e83667 100644
--- a/pr/617/docs/noq/struct.ClosedPath.html
+++ b/pr/617/docs/noq/struct.ClosedPath.html
@@ -1,6 +1,6 @@
-ClosedPath in noq - Rust ClosedPath
pub struct ClosedPath { /* private fields */ }
Expand description
Error indicating that a path has not been opened or has already been abandoned
-Trait Implementations§
Source§impl Clone for ClosedPath
Source§fn clone(&self) -> ClosedPath
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 ClosedPath
Source§impl Default for ClosedPath
Source§fn default() -> ClosedPath
Returns the “default value” for a type. Read moreSource§impl Display for ClosedPath
Source§impl Error for ClosedPath
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 PartialEq for ClosedPath
Source§impl Eq for ClosedPath
Source§impl StructuralPartialEq for ClosedPath
Auto Trait Implementations§
§impl Freeze for ClosedPath
§impl RefUnwindSafe for ClosedPath
§impl Send for ClosedPath
§impl Sync for ClosedPath
§impl Unpin for ClosedPath
§impl UnwindSafe for ClosedPath
Blanket Implementations§
Source§impl<T> Any for Twhere
+ClosedPath in noq - Rust ClosedPath
pub struct ClosedPath { /* private fields */ }
Expand description
Error indicating that a path has not been opened or has already been abandoned
+Trait Implementations§
Source§impl Clone for ClosedPath
Source§fn clone(&self) -> ClosedPath
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 ClosedPath
Source§impl Default for ClosedPath
Source§fn default() -> ClosedPath
Returns the “default value” for a type. Read moreSource§impl Display for ClosedPath
Source§impl Error for ClosedPath
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 PartialEq for ClosedPath
Source§impl Eq for ClosedPath
Source§impl StructuralPartialEq for ClosedPath
Auto Trait Implementations§
§impl Freeze for ClosedPath
§impl RefUnwindSafe for ClosedPath
§impl Send for ClosedPath
§impl Sync for ClosedPath
§impl Unpin for ClosedPath
§impl UnwindSafe for ClosedPath
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/617/docs/noq/struct.Connecting.html b/pr/617/docs/noq/struct.Connecting.html
index fbd5cd159..989576043 100644
--- a/pr/617/docs/noq/struct.Connecting.html
+++ b/pr/617/docs/noq/struct.Connecting.html
@@ -1,5 +1,5 @@
Connecting in noq - Rust Connecting
pub struct Connecting { /* private fields */ }
Expand description
In-progress connection attempt future
-Implementations§
Source§impl Connecting
Sourcepub fn into_0rtt(self) -> Result<(Connection, ZeroRttAccepted), Self>
Convert into a 0-RTT or 0.5-RTT connection at the cost of weakened security
+Implementations§
Source§impl Connecting
Sourcepub fn into_0rtt(self) -> Result<(Connection, ZeroRttAccepted), Self>
Convert into a 0-RTT or 0.5-RTT connection at the cost of weakened security
Returns Ok immediately if the local endpoint is able to attempt sending 0/0.5-RTT data.
If so, the returned Connection can be used to send application data without waiting for
the rest of the handshake to complete, at the cost of weakened cryptographic security
@@ -45,9 +45,9 @@ the endpoint is bound to a wildcard address like 0.0.0.0 or :
information. See noq_udp::RecvMeta::dst_ip for a list of
supported platforms when using noq_udp for I/O, which is the default.
Will panic if called after poll has returned Ready.
-Sourcepub fn remote_address(&self) -> SocketAddr
The peer’s UDP addresses
+Sourcepub fn remote_address(&self) -> SocketAddr
The peer’s UDP addresses
Will panic if called after poll has returned Ready.
-Trait Implementations§
Source§impl Debug for Connecting
Trait Implementations§
Source§impl Debug for Connecting
Source§impl Future for Connecting
Source§type Output = Result<Connection, ConnectionError>
The type of value produced on completion.Auto Trait Implementations§
§impl Freeze for Connecting
§impl !RefUnwindSafe for Connecting
§impl Send for Connecting
§impl Sync for Connecting
§impl Unpin for Connecting
§impl !UnwindSafe for Connecting
Blanket Implementations§
Source§impl<T> BorrowMut<T> for Twhere
diff --git a/pr/617/docs/noq/struct.Connection.html b/pr/617/docs/noq/struct.Connection.html
index fac0582c9..3d80f160f 100644
--- a/pr/617/docs/noq/struct.Connection.html
+++ b/pr/617/docs/noq/struct.Connection.html
@@ -1,4 +1,4 @@
-Connection in noq - Rust Connection
pub struct Connection(/* private fields */);
Expand description
A QUIC connection.
+Connection in noq - Rust Connection
pub struct Connection(/* private fields */);
Expand description
A QUIC connection.
If all references to a connection (including every clone of the Connection handle, streams of
incoming streams, and the various stream types) have been dropped, then the connection will be
automatically closed with an error_code of 0 and an empty reason. You can also close the
@@ -8,29 +8,29 @@ receiving CONNECTION_CLOSE the peer may drop any stream data not yet de
application. Connection::close() describes in more detail how to gracefully close a
connection without losing application data.
May be cloned to obtain another handle to the same connection.
-Implementations§
Source§impl Connection
Sourcepub fn weak_handle(&self) -> WeakConnectionHandle
Returns a weak reference to the inner connection struct.
-Implementations§
Source§impl Connection
Sourcepub fn weak_handle(&self) -> WeakConnectionHandle
Returns a weak reference to the inner connection struct.
+Sourcepub fn open_uni(&self) -> OpenUni<'_> ⓘ
Initiate a new outgoing unidirectional stream.
Streams are cheap and instantaneous to open unless blocked by flow control. As a
consequence, the peer won’t be notified that a stream has been opened until the stream is
actually used.
-Sourcepub fn open_bi(&self) -> OpenBi<'_> ⓘ
Initiate a new outgoing bidirectional stream.
Streams are cheap and instantaneous to open unless blocked by flow control. As a
consequence, the peer won’t be notified that a stream has been opened until the stream is
actually used. Calling open_bi() then waiting on the RecvStream without writing
anything to SendStream will never succeed.
-Sourcepub fn accept_uni(&self) -> AcceptUni<'_> ⓘ
Accept the next incoming uni-directional stream
-Sourcepub fn accept_uni(&self) -> AcceptUni<'_> ⓘ
Accept the next incoming uni-directional stream
+Sourcepub fn accept_bi(&self) -> AcceptBi<'_> ⓘ
Accept the next incoming bidirectional stream
Important Note: The Connection that calls open_bi() must write to its SendStream
before the other Connection is able to accept_bi(). Calling open_bi() then
waiting on the RecvStream without writing anything to SendStream will never succeed.
-Sourcepub fn read_datagram(&self) -> ReadDatagram<'_> ⓘ
Receive an application datagram
-Sourcepub fn open_path_ensure(
+
Sourcepub fn read_datagram(&self) -> ReadDatagram<'_> ⓘ
Receive an application datagram
+Sourcepub fn open_path_ensure(
&self,
addr: SocketAddr,
initial_status: PathStatus,
) -> OpenPath ⓘ
Opens a new path if no path exists yet for the remote address.
Otherwise behaves exactly as open_path.
-Sourcepub fn open_path(
&self,
addr: SocketAddr,
initial_status: PathStatus,
@@ -45,34 +45,34 @@ path opens. The P
future, or at a later time. If the failure is immediate OpenPath::path_id will
return None and the future will be ready immediately. If the failure happens
later, a PathEvent will be emitted.
-
Sourcepub fn path_events(&self) -> PathEvents
A stream of PathEvents for all paths in this connection.
+Sourcepub fn path_events(&self) -> PathEvents
A stream of PathEvents for all paths in this connection.
The stream will yield a PathEvent whenever there is a change in the state of any path in this connection.
The events need to be processed immediately, since there isn’t an unbounded buffer for them.
If processing of events lags behind too much, you will get an error of type crate::Lagged indicating
how many events were lost. The stream continues after a lag, delivering the oldest retained message next.
-Sourcepub fn nat_traversal_updates(&self) -> NatTraversalUpdates
A stream of NAT traversal updates for this connection.
+Sourcepub fn nat_traversal_updates(&self) -> NatTraversalUpdates
A stream of NAT traversal updates for this connection.
The events need to be processed immediately, since there isn’t an unbounded buffer for them.
If processing of events lags behind too much, you will get an error of type crate::Lagged indicating
how many events were lost. The stream continues after a lag, delivering the oldest retained message next.
-Sourcepub async fn closed(&self) -> ConnectionError
Wait for the connection to be closed for any reason
+Sourcepub async fn closed(&self) -> ConnectionError
Wait for the connection to be closed for any reason
Despite the return type’s name, closed connections are often not an error condition at the
application layer. Cases that might be routine include ConnectionError::LocallyClosed
and ConnectionError::ApplicationClosed.
-Sourcepub fn on_closed(&self) -> OnClosed ⓘ
Wait for the connection to be closed without keeping a strong reference to the connection
+Sourcepub fn on_closed(&self) -> OnClosed ⓘ
Wait for the connection to be closed without keeping a strong reference to the connection
Returns a future that resolves, once the connection is closed, to a Closed struct
describing the close reason and final connection and per-path statistics.
Calling Self::closed keeps the connection alive until it is either closed locally via Connection::close
or closed by the remote peer. This function instead does not keep the connection itself alive,
so if all other clones of the connection are dropped, the connection will be closed implicitly even
if there are futures returned from this function still being awaited.
-Sourcepub fn close_reason(&self) -> Option<ConnectionError>
Whether the connection is closed, and why.
+Sourcepub fn close_reason(&self) -> Option<ConnectionError>
Whether the connection is closed, and why.
The close_reason is always set to Some(ConnectionError) when a socket is
closed; whether it was closed manually by calling Connection::close() or due to
an internal error (such as an idle timeout or the peer closing the
connection).
Note: when the connection is closed, connection.close_reason().is_some() will always be true.
-Sourcepub fn close(&self, error_code: VarInt, reason: &[u8])
Close the connection immediately.
Pending operations will fail immediately with ConnectionError::LocallyClosed. No
more data is sent to the peer and the peer may drop buffered data upon receiving
the CONNECTION_CLOSE frame.
@@ -93,7 +93,7 @@ endpoint. Once the local side sends a CONNECTION_CLOSE frame in response to call
close() the remote endpoint may drop any data it received but is as yet
undelivered to the application, including data that was acknowledged as received to
the local endpoint.
-Sourcepub async fn handshake_confirmed(&self) -> Result<(), ConnectionError>
Wait for the handshake to be confirmed.
+Sourcepub async fn handshake_confirmed(&self) -> Result<(), ConnectionError>
Wait for the handshake to be confirmed.
As a server, who must be authenticated by clients,
this happens when the handshake completes
upon receiving a TLS Finished message from the client.
@@ -101,56 +101,44 @@ In return, the server send a HANDSHAKE_DONE frame.
As a client, this happens when receiving a HANDSHAKE_DONE frame.
At this point, the server has either accepted our authentication,
or, if client authentication is not required, accepted our lack of authentication.
-Sourcepub fn send_datagram(&self, data: Bytes) -> Result<(), SendDatagramError>
Transmit data as an unreliable, unordered application datagram
+Sourcepub fn send_datagram(&self, data: Bytes) -> Result<(), SendDatagramError>
Transmit data as an unreliable, unordered application datagram
Application datagrams are a low-level primitive. They may be lost or delivered out of order,
and data must both fit inside a single QUIC packet and be smaller than the maximum
dictated by the peer.
Previously queued datagrams which are still unsent may be discarded to make space for this
datagram, in order of oldest to newest.
-Sourcepub fn send_datagram_wait(&self, data: Bytes) -> SendDatagram<'_> ⓘ
Transmit data as an unreliable, unordered application datagram
+Sourcepub fn send_datagram_wait(&self, data: Bytes) -> SendDatagram<'_> ⓘ
Transmit data as an unreliable, unordered application datagram
Unlike send_datagram(), this method will wait for buffer space during congestion
conditions, which effectively prioritizes old datagrams over new datagrams.
See send_datagram() for details.
-Sourcepub fn max_datagram_size(&self) -> Option<usize>
Compute the maximum size of datagrams that may be passed to send_datagram().
+Sourcepub fn max_datagram_size(&self) -> Option<usize>
Compute the maximum size of datagrams that may be passed to send_datagram().
Returns None if datagrams are unsupported by the peer or disabled locally.
This may change over the lifetime of a connection according to variation in the path MTU
estimate. The peer can also enforce an arbitrarily small fixed limit, but if the peer’s
limit is large this is guaranteed to be a little over a kilobyte at minimum.
Not necessarily the maximum size of received datagrams.
-Sourcepub fn datagram_send_buffer_space(&self) -> usize
Bytes available in the outgoing datagram buffer
+Sourcepub fn datagram_send_buffer_space(&self) -> usize
Bytes available in the outgoing datagram buffer
When greater than zero, calling send_datagram() with a datagram of
at most this size is guaranteed not to cause older datagrams to be dropped.
-Sourcepub fn remote_address(&self) -> SocketAddr
The peer’s UDP address
-If ServerConfig::migration is true, clients may change addresses at will,
-e.g. when switching to a cellular internet connection.
-If multipath is enabled this will return the address of any
-path, and may not be consistent. Prefer Path::remote_address instead.
-Sourcepub fn local_ip(&self) -> Option<IpAddr>
The local IP address which was used when the peer established
-the connection
-This can be different from the address the endpoint is bound to, in case
-the endpoint is bound to a wildcard address like 0.0.0.0 or ::.
-This will return None for clients, or when the platform does not expose this
-information. See noq_udp::RecvMeta::dst_ip for a list of
-supported platforms when using noq_udp for I/O, which is the default.
-Sourcepub fn rtt(&self, path_id: PathId) -> Option<Duration>
Current best estimate of this connection’s latency (round-trip-time)
-Sourcepub fn stats(&self) -> ConnectionStats
Returns connection statistics
-Sourcepub fn path_stats(&self, path_id: PathId) -> Option<PathStats>
Returns path statistics
-Sourcepub fn congestion_state(&self, path_id: PathId) -> Option<Box<dyn Controller>>
Current state of the congestion control algorithm, for debugging purposes
-Sourcepub fn handshake_data(&self) -> Option<Box<dyn Any>>
Parameters negotiated during the handshake
+Sourcepub fn rtt(&self, path_id: PathId) -> Option<Duration>
Current best estimate of this connection’s latency (round-trip-time)
+Sourcepub fn stats(&self) -> ConnectionStats
Returns connection statistics
+Sourcepub fn path_stats(&self, path_id: PathId) -> Option<PathStats>
Returns path statistics
+Sourcepub fn congestion_state(&self, path_id: PathId) -> Option<Box<dyn Controller>>
Current state of the congestion control algorithm, for debugging purposes
+Sourcepub fn handshake_data(&self) -> Option<Box<dyn Any>>
Parameters negotiated during the handshake
Guaranteed to return Some on fully established connections or after
Connecting::handshake_data() succeeds. See that method’s documentations for details on
the returned value.
-Sourcepub fn peer_identity(&self) -> Option<Box<dyn Any>>
Cryptographic identity of the peer
+Sourcepub fn peer_identity(&self) -> Option<Box<dyn Any>>
Sourcepub fn stable_id(&self) -> usize
A stable identifier for this connection
Peer addresses and connection IDs can change, but this value will remain
fixed for the lifetime of the connection.
-Sourcepub fn force_key_update(&self)
Update traffic keys spontaneously
+Sourcepub fn force_key_update(&self)
Update traffic keys spontaneously
This primarily exists for testing purposes.
-Sourcepub fn export_keying_material(
+
Sourcepub fn export_keying_material(
&self,
output: &mut [u8],
label: &[u8],
@@ -161,17 +149,17 @@ arguments and output buffers of equal length, they will get the
same sequence of bytes in output. These bytes are cryptographically
strong and pseudorandom, and are suitable for use as keying material.
See RFC5705 for more information.
-
Sourcepub fn set_max_concurrent_uni_streams(&self, count: VarInt)
Modify the number of remotely initiated unidirectional streams that may be concurrently open
+Sourcepub fn set_max_concurrent_uni_streams(&self, count: VarInt)
Modify the number of remotely initiated unidirectional streams that may be concurrently open
No streams may be opened by the peer unless fewer than count are already open. Large
counts increase both minimum and worst-case memory consumption.
-Sourcepub fn set_send_window(&self, send_window: u64)
Sourcepub fn set_receive_window(&self, receive_window: VarInt)
Sourcepub fn set_max_concurrent_bi_streams(&self, count: VarInt)
Modify the number of remotely initiated bidirectional streams that may be concurrently open
+Sourcepub fn set_send_window(&self, send_window: u64)
Sourcepub fn set_receive_window(&self, receive_window: VarInt)
Sourcepub fn set_max_concurrent_bi_streams(&self, count: VarInt)
Modify the number of remotely initiated bidirectional streams that may be concurrently open
No streams may be opened by the peer unless fewer than count are already open. Large
counts increase both minimum and worst-case memory consumption.
-Sourcepub fn observed_external_addr(&self) -> ObservedExternalAddr
Track changes on our external address as reported by the peer.
-Sourcepub fn is_multipath_enabled(&self) -> bool
Is multipath enabled?
-Sourcepub fn add_nat_traversal_address(
+
Sourcepub fn observed_external_addr(&self) -> ObservedExternalAddr
Track changes on our external address as reported by the peer.
+Sourcepub fn is_multipath_enabled(&self) -> bool
Is multipath enabled?
+Sourcepub fn add_nat_traversal_address(
&self,
address: SocketAddr,
) -> Result<(), Error>
Registers one address at which this endpoint might be reachable
@@ -179,7 +167,7 @@ strong and pseudorandom, and are suitable for use as keying material.
ADD_ADDRESS frames. This allows clients to obtain server address candidates to initiate
NAT traversal attempts. Clients provide their own reachable addresses in REACH_OUT frames
when Self::initiate_nat_traversal_round is called.
-Sourcepub fn remove_nat_traversal_address(
+
Sourcepub fn remove_nat_traversal_address(
&self,
address: SocketAddr,
) -> Result<(), Error>
Removes one or more addresses from the set of addresses at which this endpoint is reachable
@@ -188,18 +176,18 @@ clients in REMOVE_ADDRESS frames. This allows clients to stop using
server address candidates that are no longer valid for NAT traversal.
For clients, removed addresses will no longer be advertised in REACH_OUT frames.
Addresses not present in the set will be silently ignored.
-Sourcepub fn get_local_nat_traversal_addresses(
+
Sourcepub fn get_local_nat_traversal_addresses(
&self,
) -> Result<Vec<SocketAddr>, Error>
Get the current local nat traversal addresses
-Sourcepub fn get_remote_nat_traversal_addresses(
+
Sourcepub fn get_remote_nat_traversal_addresses(
&self,
) -> Result<Vec<SocketAddr>, Error>
Get the currently advertised nat traversal addresses by the server
-Sourcepub fn initiate_nat_traversal_round(&self) -> Result<Vec<SocketAddr>, Error>
Initiates a new nat traversal round
+Sourcepub fn initiate_nat_traversal_round(&self) -> Result<Vec<SocketAddr>, Error>
Initiates a new nat traversal round
A nat traversal round involves advertising the client’s local addresses in REACH_OUT
frames, and initiating probing of the known remote addresses. When a new round is
initiated, the previous one is cancelled, and paths that have not been opened are closed.
Returns the server addresses that are now being probed.
-Trait Implementations§
Source§impl Clone for Connection
Source§fn clone(&self) -> Connection
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 Connection
§impl RefUnwindSafe for Connection
§impl Send for Connection
§impl Sync for Connection
§impl Unpin for Connection
§impl UnwindSafe for Connection
Blanket Implementations§
Trait Implementations§
Source§impl Clone for Connection
Source§fn clone(&self) -> Connection
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 Connection
§impl RefUnwindSafe for Connection
§impl Send for Connection
§impl Sync for Connection
§impl Unpin for Connection
§impl UnwindSafe for Connection
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/617/docs/noq/struct.EndpointConfig.html b/pr/617/docs/noq/struct.EndpointConfig.html
index 5db8f93f3..e8d394ce3 100644
--- a/pr/617/docs/noq/struct.EndpointConfig.html
+++ b/pr/617/docs/noq/struct.EndpointConfig.html
@@ -1,7 +1,7 @@
-EndpointConfig in noq - Rust EndpointConfig
pub struct EndpointConfig { /* private fields */ }
Expand description
Global configuration for the endpoint, affecting all connections
+EndpointConfig in noq - Rust EndpointConfig
pub struct EndpointConfig { /* private fields */ }
Expand description
Global configuration for the endpoint, affecting all connections
Default values should be suitable for most internet applications.
-Implementations§
Source§impl EndpointConfig
Sourcepub fn new(reset_key: Arc<dyn HmacKey>) -> EndpointConfig
Create a default config with a particular reset_key
-Sourcepub fn cid_generator(
+
Implementations§
Source§impl EndpointConfig
Sourcepub fn new(reset_key: Arc<dyn HmacKey>) -> EndpointConfig
Create a default config with a particular reset_key
+Sourcepub fn cid_generator(
&mut self,
factory: Arc<dyn Fn() -> Box<dyn ConnectionIdGenerator> + Send + Sync>,
) -> &mut EndpointConfig
Supply a custom connection ID generator factory
@@ -10,9 +10,9 @@ generator which will be used to generate the CIDs used for incoming packets on a
connections involving that Endpoint. A custom CID generator allows applications to embed
information in local connection IDs, e.g. to support stateless packet-level load balancers.
Defaults to HashedConnectionIdGenerator.
-Sourcepub fn reset_key(&mut self, key: Arc<dyn HmacKey>) -> &mut EndpointConfig
Private key used to send authenticated connection resets to peers who were
+
Sourcepub fn reset_key(&mut self, key: Arc<dyn HmacKey>) -> &mut EndpointConfig
Private key used to send authenticated connection resets to peers who were
communicating with a previous instance of this endpoint.
-Sourcepub fn max_udp_payload_size(
+
Sourcepub fn max_udp_payload_size(
&mut self,
value: u16,
) -> Result<&mut EndpointConfig, ConfigError>
Maximum UDP payload size accepted from peers (excluding UDP and IP overhead).
@@ -21,27 +21,27 @@ communicating with a previous instance of this endpoint.
1500 byte Ethernet MTU. Deployments on links with larger MTUs (e.g. loopback or Ethernet
with jumbo frames) can raise this to improve performance at the cost of a linear increase in
datagram receive buffer size.
-Sourcepub fn get_max_udp_payload_size(&self) -> u64
Get the current value of max_udp_payload_size
-Sourcepub fn supported_versions(
+
Sourcepub fn get_max_udp_payload_size(&self) -> u64
Get the current value of max_udp_payload_size
+Sourcepub fn supported_versions(
&mut self,
supported_versions: Vec<u32>,
) -> &mut EndpointConfig
Override supported QUIC versions
-Sourcepub fn grease_quic_bit(&mut self, value: bool) -> &mut EndpointConfig
Whether to accept QUIC packets containing any value for the fixed bit
+Sourcepub fn grease_quic_bit(&mut self, value: bool) -> &mut EndpointConfig
Whether to accept QUIC packets containing any value for the fixed bit
Enabled by default. Helps protect against protocol ossification and makes traffic less
identifiable to observers. Disable if helping observers identify this traffic as QUIC is
desired.
-Sourcepub fn min_reset_interval(&mut self, value: Duration) -> &mut EndpointConfig
Minimum interval between outgoing stateless reset packets
+Sourcepub fn min_reset_interval(&mut self, value: Duration) -> &mut EndpointConfig
Minimum interval between outgoing stateless reset packets
Defaults to 20ms. Limits the impact of attacks which flood an endpoint with garbage packets,
e.g. ISAKMP/IKE amplification. Larger values provide a stronger defense, but may delay
detection of some error conditions by clients. Using a ConnectionIdGenerator with a low
rate of false positives in validate reduces the risk
incurred by a small minimum reset interval.
-Sourcepub fn rng_seed(&mut self, seed: Option<[u8; 32]>) -> &mut EndpointConfig
Optional seed to be used internally for random number generation
+Sourcepub fn rng_seed(&mut self, seed: Option<[u8; 32]>) -> &mut EndpointConfig
Optional seed to be used internally for random number generation
By default, noq will initialize an endpoint’s rng using a platform entropy source.
However, you can seed the rng yourself through this method (e.g. if you need to run noq
deterministically or if you are using noq in an environment that doesn’t have a source of
entropy available).
-Trait Implementations§
Source§impl Clone for EndpointConfig
Source§fn clone(&self) -> EndpointConfig
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 EndpointConfig
Source§impl Default for EndpointConfig
Source§fn default() -> EndpointConfig
Returns the “default value” for a type. Read moreAuto Trait Implementations§
§impl Freeze for EndpointConfig
§impl !RefUnwindSafe for EndpointConfig
§impl Send for EndpointConfig
§impl Sync for EndpointConfig
§impl Unpin for EndpointConfig
§impl !UnwindSafe for EndpointConfig
Blanket Implementations§
Trait Implementations§
Source§impl Clone for EndpointConfig
Source§fn clone(&self) -> EndpointConfig
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 EndpointConfig
Source§impl Default for EndpointConfig
Source§fn default() -> EndpointConfig
Returns the “default value” for a type. Read moreAuto Trait Implementations§
§impl Freeze for EndpointConfig
§impl !RefUnwindSafe for EndpointConfig
§impl Send for EndpointConfig
§impl Sync for EndpointConfig
§impl Unpin for EndpointConfig
§impl !UnwindSafe for EndpointConfig
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/617/docs/noq/struct.IdleTimeout.html b/pr/617/docs/noq/struct.IdleTimeout.html
index ace1e130b..7a08b236d 100644
--- a/pr/617/docs/noq/struct.IdleTimeout.html
+++ b/pr/617/docs/noq/struct.IdleTimeout.html
@@ -1,4 +1,4 @@
-IdleTimeout in noq - Rust IdleTimeout
pub struct IdleTimeout(/* private fields */);
Expand description
Maximum duration of inactivity to accept before timing out the connection
+IdleTimeout in noq - Rust IdleTimeout
pub struct IdleTimeout(/* private fields */);
Expand description
Maximum duration of inactivity to accept before timing out the connection
This wraps an underlying VarInt, representing the duration in milliseconds. Values can be
constructed by converting directly from VarInt, or using TryFrom<Duration>.
@@ -6,19 +6,19 @@ constructed by converting directly from VarInt, or using TryF
let timeout = IdleTimeout::from(VarInt::from_u32(10_000));
// Try to convert a `Duration` into a `VarInt`-encoded timeout
-let timeout = IdleTimeout::try_from(Duration::from_secs(10))?;Trait Implementations§
Source§impl Clone for IdleTimeout
Source§fn clone(&self) -> IdleTimeout
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 IdleTimeout
Source§impl Default for IdleTimeout
Source§fn default() -> IdleTimeout
Returns the “default value” for a type. Read moreSource§impl From<VarInt> for IdleTimeout
Source§fn from(inner: VarInt) -> IdleTimeout
Converts to this type from the input type.Source§impl Hash for IdleTimeout
Trait Implementations§
Source§impl Clone for IdleTimeout
Source§fn clone(&self) -> IdleTimeout
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 IdleTimeout
Source§impl Default for IdleTimeout
Source§fn default() -> IdleTimeout
Returns the “default value” for a type. Read moreSource§impl From<VarInt> for IdleTimeout
Source§fn from(inner: VarInt) -> IdleTimeout
Converts to this type from the input type.Source§impl Hash for IdleTimeout
Source§impl Ord for IdleTimeout
Source§impl Ord for IdleTimeout
Source§fn cmp(&self, other: &IdleTimeout) -> Ordering
1.21.0 · Source§fn max(self, other: Self) -> Selfwhere
Self: Sized,
Compares and returns the maximum of two values. Read moreSource§impl PartialEq for IdleTimeout
Source§impl PartialOrd for IdleTimeout
Source§impl PartialEq for IdleTimeout
Source§impl TryFrom<Duration> for IdleTimeout
Source§type Error = VarIntBoundsExceeded
The type returned in the event of a conversion error.Source§fn try_from(
timeout: Duration,
-) -> Result<IdleTimeout, <IdleTimeout as TryFrom<Duration>>::Error>
Performs the conversion.Source§impl Copy for IdleTimeout
Source§impl Eq for IdleTimeout
Source§impl StructuralPartialEq for IdleTimeout
Auto Trait Implementations§
§impl Freeze for IdleTimeout
§impl RefUnwindSafe for IdleTimeout
§impl Send for IdleTimeout
§impl Sync for IdleTimeout
§impl Unpin for IdleTimeout
§impl UnwindSafe for IdleTimeout
Blanket Implementations§
Source§impl Copy for IdleTimeout
Source§impl Eq for IdleTimeout
Source§impl StructuralPartialEq for IdleTimeout
Auto Trait Implementations§
§impl Freeze for IdleTimeout
§impl RefUnwindSafe for IdleTimeout
§impl Send for IdleTimeout
§impl Sync for IdleTimeout
§impl Unpin for IdleTimeout
§impl UnwindSafe for IdleTimeout
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/617/docs/noq/struct.MtuDiscoveryConfig.html b/pr/617/docs/noq/struct.MtuDiscoveryConfig.html
index 07fb6950d..648670fe2 100644
--- a/pr/617/docs/noq/struct.MtuDiscoveryConfig.html
+++ b/pr/617/docs/noq/struct.MtuDiscoveryConfig.html
@@ -1,4 +1,4 @@
-MtuDiscoveryConfig in noq - Rust MtuDiscoveryConfig
pub struct MtuDiscoveryConfig { /* private fields */ }
Expand description
Parameters governing MTU discovery.
+MtuDiscoveryConfig in noq - Rust
impl<T> CloneToUninit for Twhere
diff --git a/pr/617/docs/noq/enum.ConfigError.html b/pr/617/docs/noq/enum.ConfigError.html
index e04597bbe..5e526b4b2 100644
--- a/pr/617/docs/noq/enum.ConfigError.html
+++ b/pr/617/docs/noq/enum.ConfigError.html
@@ -1,9 +1,9 @@
-ConfigError in noq - Rust ConfigError
#[non_exhaustive]pub enum ConfigError {
+ConfigError in noq - 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/617/docs/noq/enum.ConnectionError.html b/pr/617/docs/noq/enum.ConnectionError.html
index d9e87d540..21a2c4a10 100644
--- a/pr/617/docs/noq/enum.ConnectionError.html
+++ b/pr/617/docs/noq/enum.ConnectionError.html
@@ -1,4 +1,4 @@
-ConnectionError in noq - Rust ConnectionError
pub enum ConnectionError {
+ConnectionError in noq - 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/617/docs/noq/enum.Dir.html b/pr/617/docs/noq/enum.Dir.html
index 43d1fb0f4..5e2e27f31 100644
--- a/pr/617/docs/noq/enum.Dir.html
+++ b/pr/617/docs/noq/enum.Dir.html
@@ -1,25 +1,25 @@
-Dir in noq - Rust Dir
pub enum Dir {
+Dir in noq - 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/617/docs/noq/enum.PathError.html b/pr/617/docs/noq/enum.PathError.html
index b2129d2f5..715d048e9 100644
--- a/pr/617/docs/noq/enum.PathError.html
+++ b/pr/617/docs/noq/enum.PathError.html
@@ -1,4 +1,4 @@
-PathError in noq - Rust PathError
pub enum PathError {
+PathError in noq - Rust PathError
pub enum PathError {
MultipathNotNegotiated,
ServerSideNotAllowed,
MaxPathIdReached,
@@ -12,8 +12,8 @@
§RemoteCidsExhausted
No remote CIDs available to open a new path
§ValidationFailed
Path could not be validated and will be abandoned
§InvalidRemoteAddress(SocketAddr)
The remote address for the path is not supported by the endpoint
-
Trait Implementations§
Source§impl Error for PathError
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 Copy for PathError
Source§impl Eq for PathError
Source§impl StructuralPartialEq for PathError
Auto Trait Implementations§
§impl Freeze for PathError
§impl RefUnwindSafe for PathError
§impl Send for PathError
§impl Sync for PathError
§impl Unpin for PathError
§impl UnwindSafe for PathError
Blanket Implementations§
Trait Implementations§
Source§impl Error for PathError
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 Copy for PathError
Source§impl Eq for PathError
Source§impl StructuralPartialEq for PathError
Auto Trait Implementations§
§impl Freeze for PathError
§impl RefUnwindSafe for PathError
§impl Send for PathError
§impl Sync for PathError
§impl Unpin for PathError
§impl UnwindSafe for PathError
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/617/docs/noq/enum.PathEvent.html b/pr/617/docs/noq/enum.PathEvent.html
index da4b6dad6..6a54cac03 100644
--- a/pr/617/docs/noq/enum.PathEvent.html
+++ b/pr/617/docs/noq/enum.PathEvent.html
@@ -1,4 +1,4 @@
-PathEvent in noq - Rust PathEvent
pub enum PathEvent {
+PathEvent in noq - Rust PathEvent
pub enum PathEvent {
Opened {
id: PathId,
},
@@ -39,8 +39,8 @@ changes the status.
Fields
§id: PathIdPath over which the observed address was reported, PathId::ZERO when multipath is
not negotiated
§addr: SocketAddrThe address observed by the remote over this path
-
Trait Implementations§
Source§impl Eq for PathEvent
Source§impl StructuralPartialEq for PathEvent
Auto Trait Implementations§
§impl Freeze for PathEvent
§impl RefUnwindSafe for PathEvent
§impl Send for PathEvent
§impl Sync for PathEvent
§impl Unpin for PathEvent
§impl UnwindSafe for PathEvent
Blanket Implementations§
Trait Implementations§
Source§impl Eq for PathEvent
Source§impl StructuralPartialEq for PathEvent
Auto Trait Implementations§
§impl Freeze for PathEvent
§impl RefUnwindSafe for PathEvent
§impl Send for PathEvent
§impl Sync for PathEvent
§impl Unpin for PathEvent
§impl UnwindSafe for PathEvent
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/617/docs/noq/enum.PathStatus.html b/pr/617/docs/noq/enum.PathStatus.html
index 4422c371b..9298a8940 100644
--- a/pr/617/docs/noq/enum.PathStatus.html
+++ b/pr/617/docs/noq/enum.PathStatus.html
@@ -1,4 +1,4 @@
-PathStatus in noq - Rust PathStatus
pub enum PathStatus {
+PathStatus in noq - Rust PathStatus
pub enum PathStatus {
Available,
Backup,
}
Expand description
The QUIC-MULTIPATH path status
@@ -10,8 +10,8 @@ capacity.
§Backup
Paths marked as backup will only be used if there are no available paths
If the max_idle_timeout is specified the path will be kept alive so that it does not
expire.
-Trait Implementations§
Source§impl Clone for PathStatus
Source§fn clone(&self) -> PathStatus
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 PathStatus
Source§impl Default for PathStatus
Source§fn default() -> PathStatus
Returns the “default value” for a type. Read moreSource§impl PartialEq for PathStatus
Source§impl Copy for PathStatus
Source§impl Eq for PathStatus
Source§impl StructuralPartialEq for PathStatus
Auto Trait Implementations§
§impl Freeze for PathStatus
§impl RefUnwindSafe for PathStatus
§impl Send for PathStatus
§impl Sync for PathStatus
§impl Unpin for PathStatus
§impl UnwindSafe for PathStatus
Blanket Implementations§
Trait Implementations§
Source§impl Clone for PathStatus
Source§fn clone(&self) -> PathStatus
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 PathStatus
Source§impl Default for PathStatus
Source§fn default() -> PathStatus
Returns the “default value” for a type. Read moreSource§impl PartialEq for PathStatus
Source§impl Copy for PathStatus
Source§impl Eq for PathStatus
Source§impl StructuralPartialEq for PathStatus
Auto Trait Implementations§
§impl Freeze for PathStatus
§impl RefUnwindSafe for PathStatus
§impl Send for PathStatus
§impl Sync for PathStatus
§impl Unpin for PathStatus
§impl UnwindSafe for PathStatus
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/617/docs/noq/enum.SendDatagramError.html b/pr/617/docs/noq/enum.SendDatagramError.html
index 4ac61c63c..dbf07e2a6 100644
--- a/pr/617/docs/noq/enum.SendDatagramError.html
+++ b/pr/617/docs/noq/enum.SendDatagramError.html
@@ -1,4 +1,4 @@
-SendDatagramError in noq - Rust SendDatagramError
pub enum SendDatagramError {
+SendDatagramError in noq - Rust SendDatagramError
pub enum SendDatagramError {
UnsupportedByPeer,
Disabled,
TooLarge,
@@ -10,8 +10,8 @@
Indicates that the path MTU minus overhead or the limit advertised by the peer has been
exceeded.
§ConnectionLost(ConnectionError)
The connection was lost
-
Trait Implementations§
Source§impl Clone for SendDatagramError
Source§fn clone(&self) -> SendDatagramError
Returns a duplicate of the value. Read more1.0.0 · Source§fn clone_from(&mut self, source: &Self)
Performs copy-assignment from source. Read moreSource§impl Debug for SendDatagramError
Source§impl Display for SendDatagramError
Source§impl Error for SendDatagramError
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 SendDatagramError
Source§fn from(source: ConnectionError) -> Self
Converts to this type from the input type.Source§impl PartialEq for SendDatagramError
Source§impl Eq for SendDatagramError
Source§impl StructuralPartialEq for SendDatagramError
Auto Trait Implementations§
§impl !Freeze for SendDatagramError
§impl !RefUnwindSafe for SendDatagramError
§impl Send for SendDatagramError
§impl Sync for SendDatagramError
§impl Unpin for SendDatagramError
§impl !UnwindSafe for SendDatagramError
Blanket Implementations§
Trait Implementations§
Source§impl Clone for SendDatagramError
Source§fn clone(&self) -> SendDatagramError
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 SendDatagramError
Source§impl Display for SendDatagramError
Source§impl Error for SendDatagramError
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 SendDatagramError
Source§fn from(source: ConnectionError) -> Self
Converts to this type from the input type.Source§impl PartialEq for SendDatagramError
Source§impl Eq for SendDatagramError
Source§impl StructuralPartialEq for SendDatagramError
Auto Trait Implementations§
§impl !Freeze for SendDatagramError
§impl !RefUnwindSafe for SendDatagramError
§impl Send for SendDatagramError
§impl Sync for SendDatagramError
§impl Unpin for SendDatagramError
§impl !UnwindSafe for SendDatagramError
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/617/docs/noq/enum.SetPathStatusError.html b/pr/617/docs/noq/enum.SetPathStatusError.html
index 2a9557440..3bb2857be 100644
--- a/pr/617/docs/noq/enum.SetPathStatusError.html
+++ b/pr/617/docs/noq/enum.SetPathStatusError.html
@@ -1,11 +1,11 @@
-SetPathStatusError in noq - Rust SetPathStatusError
pub enum SetPathStatusError {
+SetPathStatusError in noq - Rust SetPathStatusError
pub enum SetPathStatusError {
ClosedPath,
MultipathNotNegotiated,
}
Expand description
Error from setting path status
Variants§
§ClosedPath
Error indicating that a path has not been opened or has already been abandoned
§MultipathNotNegotiated
Error indicating that this operation requires multipath to be negotiated whereas it hasn’t been
-Trait Implementations§
Source§impl Clone for SetPathStatusError
Source§fn clone(&self) -> SetPathStatusError
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 SetPathStatusError
Source§impl Display for SetPathStatusError
Source§impl Error for SetPathStatusError
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 PartialEq for SetPathStatusError
Source§impl Eq for SetPathStatusError
Source§impl StructuralPartialEq for SetPathStatusError
Auto Trait Implementations§
§impl Freeze for SetPathStatusError
§impl RefUnwindSafe for SetPathStatusError
§impl Send for SetPathStatusError
§impl Sync for SetPathStatusError
§impl Unpin for SetPathStatusError
§impl UnwindSafe for SetPathStatusError
Blanket Implementations§
Trait Implementations§
Source§impl Clone for SetPathStatusError
Source§fn clone(&self) -> SetPathStatusError
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 SetPathStatusError
Source§impl Display for SetPathStatusError
Source§impl Error for SetPathStatusError
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 PartialEq for SetPathStatusError
Source§impl Eq for SetPathStatusError
Source§impl StructuralPartialEq for SetPathStatusError
Auto Trait Implementations§
§impl Freeze for SetPathStatusError
§impl RefUnwindSafe for SetPathStatusError
§impl Send for SetPathStatusError
§impl Sync for SetPathStatusError
§impl Unpin for SetPathStatusError
§impl UnwindSafe for SetPathStatusError
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/617/docs/noq/enum.Side.html b/pr/617/docs/noq/enum.Side.html
index 211e245d6..2a88b859f 100644
--- a/pr/617/docs/noq/enum.Side.html
+++ b/pr/617/docs/noq/enum.Side.html
@@ -1,27 +1,27 @@
-Side in noq - Rust Side
pub enum Side {
+Side in noq - 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/617/docs/noq/struct.AcceptBi.html b/pr/617/docs/noq/struct.AcceptBi.html
index e2b6da590..213f9b881 100644
--- a/pr/617/docs/noq/struct.AcceptBi.html
+++ b/pr/617/docs/noq/struct.AcceptBi.html
@@ -1,6 +1,6 @@
-AcceptBi in noq - Rust AcceptBi
pub struct AcceptBi<'a> { /* private fields */ }
Expand description
Future produced by Connection::accept_bi
-Trait Implementations§
Source§impl Future for AcceptBi<'_>
Source§type Output = Result<(SendStream, RecvStream), ConnectionError>
The type of value produced on completion.Source§impl<'__pin, 'a> Unpin for AcceptBi<'a>where
+AcceptBi in noq - Rust AcceptBi
pub struct AcceptBi<'a> { /* private fields */ }
Expand description
Future produced by Connection::accept_bi
+Trait Implementations§
Source§impl Future for AcceptBi<'_>
Source§type Output = Result<(SendStream, RecvStream), ConnectionError>
The type of value produced on completion.Source§impl<'__pin, 'a> Unpin for AcceptBi<'a>where
PinnedFieldsOf<__Origin<'__pin, 'a>>: Unpin,
Auto Trait Implementations§
§impl<'a> !Freeze for AcceptBi<'a>
§impl<'a> !RefUnwindSafe for AcceptBi<'a>
§impl<'a> Send for AcceptBi<'a>
§impl<'a> Sync for AcceptBi<'a>
§impl<'a> !UnwindSafe for AcceptBi<'a>
Blanket Implementations§
Source§impl<T> BorrowMut<T> for Twhere
diff --git a/pr/617/docs/noq/struct.AcceptUni.html b/pr/617/docs/noq/struct.AcceptUni.html
index 725d4cf6f..485306ebe 100644
--- a/pr/617/docs/noq/struct.AcceptUni.html
+++ b/pr/617/docs/noq/struct.AcceptUni.html
@@ -1,6 +1,6 @@
-AcceptUni in noq - Rust AcceptUni
pub struct AcceptUni<'a> { /* private fields */ }
Expand description
Future produced by Connection::accept_uni
-Trait Implementations§
Source§impl Future for AcceptUni<'_>
Source§type Output = Result<RecvStream, ConnectionError>
The type of value produced on completion.Source§impl<'__pin, 'a> Unpin for AcceptUni<'a>where
+AcceptUni in noq - Rust AcceptUni
pub struct AcceptUni<'a> { /* private fields */ }
Expand description
Future produced by Connection::accept_uni
+Trait Implementations§
Source§impl Future for AcceptUni<'_>
Source§type Output = Result<RecvStream, ConnectionError>
The type of value produced on completion.Source§impl<'__pin, 'a> Unpin for AcceptUni<'a>where
PinnedFieldsOf<__Origin<'__pin, 'a>>: Unpin,
Auto Trait Implementations§
§impl<'a> !Freeze for AcceptUni<'a>
§impl<'a> !RefUnwindSafe for AcceptUni<'a>
§impl<'a> Send for AcceptUni<'a>
§impl<'a> Sync for AcceptUni<'a>
§impl<'a> !UnwindSafe for AcceptUni<'a>
Blanket Implementations§
Source§impl<T> BorrowMut<T> for Twhere
diff --git a/pr/617/docs/noq/struct.AckFrequencyConfig.html b/pr/617/docs/noq/struct.AckFrequencyConfig.html
index 2d3d900e9..20a7cff00 100644
--- a/pr/617/docs/noq/struct.AckFrequencyConfig.html
+++ b/pr/617/docs/noq/struct.AckFrequencyConfig.html
@@ -1,4 +1,4 @@
-AckFrequencyConfig in noq - Rust AckFrequencyConfig
pub struct AckFrequencyConfig { /* private fields */ }
Expand description
Parameters for controlling the peer’s acknowledgement frequency
+AckFrequencyConfig in noq - Rust AckFrequencyConfig
pub struct AckFrequencyConfig { /* private fields */ }
Expand description
Parameters for controlling the peer’s acknowledgement frequency
The parameters provided in this config will be sent to the peer at the beginning of the
connection, so it can take them into account when sending acknowledgements (see each parameter’s
description for details on how it influences acknowledgement frequency).
@@ -7,7 +7,7 @@ description for details on how it influences acknowledgement frequency).
The defaults produce behavior slightly different than the behavior without this extension,
because they change the way reordered packets are handled (see
AckFrequencyConfig::reordering_threshold for details).
-Implementations§
Source§impl AckFrequencyConfig
Sourcepub fn ack_eliciting_threshold(
+
Implementations§
Source§impl AckFrequencyConfig
Sourcepub fn ack_eliciting_threshold(
&mut self,
value: VarInt,
) -> &mut AckFrequencyConfig
The ack-eliciting threshold we will request the peer to use
@@ -17,7 +17,7 @@ without immediately sending an ACK.
ack-eliciting packets have been received. A value of 0 results in a receiver immediately
acknowledging every ack-eliciting packet.
Defaults to 1, which sends ACK frames for every other ack-eliciting packet.
-Sourcepub fn max_ack_delay(
+
Sourcepub fn max_ack_delay(
&mut self,
value: Option<Duration>,
) -> &mut AckFrequencyConfig
The max_ack_delay we will request the peer to use
@@ -27,7 +27,7 @@ an ACK when the ack-eliciting threshold hasn’t been reached.
transport parameter, and at most the greater of the current path RTT or 25ms.
Defaults to None, in which case the peer’s original max_ack_delay will be used, as
obtained from its transport parameters.
-Sourcepub fn reordering_threshold(&mut self, value: VarInt) -> &mut AckFrequencyConfig
The reordering threshold we will request the peer to use
+Sourcepub fn reordering_threshold(&mut self, value: VarInt) -> &mut AckFrequencyConfig
The reordering threshold we will request the peer to use
This threshold represents the amount of out-of-order packets that will trigger an endpoint
to send an ACK, without waiting for ack_eliciting_threshold to be exceeded or for
max_ack_delay to be elapsed.
@@ -37,7 +37,7 @@ behavior when the extension is disabled).
It is recommended to set this value to TransportConfig::packet_threshold minus one.
Since the default value for TransportConfig::packet_threshold is 3, this value defaults
to 2.
-Trait Implementations§
Source§impl Clone for AckFrequencyConfig
Source§fn clone(&self) -> AckFrequencyConfig
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 AckFrequencyConfig
Source§impl Default for AckFrequencyConfig
Source§fn default() -> AckFrequencyConfig
Returns the “default value” for a type. Read moreAuto Trait Implementations§
§impl Freeze for AckFrequencyConfig
§impl RefUnwindSafe for AckFrequencyConfig
§impl Send for AckFrequencyConfig
§impl Sync for AckFrequencyConfig
§impl Unpin for AckFrequencyConfig
§impl UnwindSafe for AckFrequencyConfig
Blanket Implementations§
Trait Implementations§
Source§impl Clone for AckFrequencyConfig
Source§fn clone(&self) -> AckFrequencyConfig
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 AckFrequencyConfig
Source§impl Default for AckFrequencyConfig
Source§fn default() -> AckFrequencyConfig
Returns the “default value” for a type. Read moreAuto Trait Implementations§
§impl Freeze for AckFrequencyConfig
§impl RefUnwindSafe for AckFrequencyConfig
§impl Send for AckFrequencyConfig
§impl Sync for AckFrequencyConfig
§impl Unpin for AckFrequencyConfig
§impl UnwindSafe for AckFrequencyConfig
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/617/docs/noq/struct.AddressDiscovery.html b/pr/617/docs/noq/struct.AddressDiscovery.html
index b14c5a0cd..22a2d8d82 100644
--- a/pr/617/docs/noq/struct.AddressDiscovery.html
+++ b/pr/617/docs/noq/struct.AddressDiscovery.html
@@ -1,7 +1,7 @@
-AddressDiscovery in noq - Rust AddressDiscovery
pub struct AddressDiscovery { /* private fields */ }
Expand description
Stream produced by Path::observed_external_addr
+AddressDiscovery in noq - 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
Trait Implementations§
Source§impl Stream for AddressDiscovery
Source§type Item = SocketAddr
Values yielded by the stream.Source§fn poll_next(
self: Pin<&mut Self>,
cx: &mut Context<'_>,
) -> Poll<Option<Self::Item>>
Attempt to pull out the next value of this stream, registering the
diff --git a/pr/617/docs/noq/struct.ClientConfig.html b/pr/617/docs/noq/struct.ClientConfig.html
index 8253ad80d..db7008c26 100644
--- a/pr/617/docs/noq/struct.ClientConfig.html
+++ b/pr/617/docs/noq/struct.ClientConfig.html
@@ -1,7 +1,7 @@
-ClientConfig in noq - Rust ClientConfig
#[non_exhaustive]pub struct ClientConfig { /* private fields */ }
Expand description
Configuration for outgoing connections
+ClientConfig in noq - 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(
+
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(
&mut self,
initial_dst_cid_provider: Arc<dyn Fn() -> ConnectionId + Send + Sync>,
) -> &mut ClientConfig
Configure how to populate the destination CID of the initial packet when attempting to
@@ -10,18 +10,18 @@ establish a new connection
a good reason, you do not need to change it.
When prefer to override the default, please note that the generated connection ID MUST be
at least 8 bytes long and unpredictable, as per section 7.2 of RFC 9000.
-Sourcepub fn transport_config(
+
Sourcepub fn transport_config(
&mut self,
transport: Arc<TransportConfig>,
) -> &mut ClientConfig
Set a custom TransportConfig
-Sourcepub fn token_store(&mut self, store: Arc<dyn TokenStore>) -> &mut ClientConfig
Set a custom TokenStore
+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 try_with_platform_verifier() -> Result<ClientConfig, Error>
Create a client configuration that trusts the platform’s native roots
-Sourcepub fn with_root_certificates(
+
Sourcepub fn version(&mut self, version: u32) -> &mut ClientConfig
Set the QUIC version to use
+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/617/docs/noq/struct.Closed.html b/pr/617/docs/noq/struct.Closed.html
index 51bccab3a..4bd279633 100644
--- a/pr/617/docs/noq/struct.Closed.html
+++ b/pr/617/docs/noq/struct.Closed.html
@@ -1,4 +1,4 @@
-Closed in noq - Rust Closed
#[non_exhaustive]pub struct Closed {
+Closed in noq - Rust Closed
#[non_exhaustive]pub struct Closed {
pub reason: ConnectionError,
pub stats: ConnectionStats,
pub path_stats: BTreeMap<PathId, PathStats>,
@@ -10,7 +10,7 @@
This includes paths that haven’t been discarded at close time, plus any
already-discarded paths whose final stats had been retained because a Path
or WeakPathHandle handle was kept alive.
-
Trait Implementations§
Auto Trait Implementations§
§impl !Freeze for Closed
§impl !RefUnwindSafe for Closed
§impl Send for Closed
§impl Sync for Closed
§impl Unpin for Closed
§impl !UnwindSafe for Closed
Blanket Implementations§
Source§impl<T> Any for Twhere
+Trait Implementations§
Auto Trait Implementations§
§impl !Freeze for Closed
§impl !RefUnwindSafe for Closed
§impl Send for Closed
§impl Sync for Closed
§impl Unpin for Closed
§impl !UnwindSafe for Closed
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/617/docs/noq/struct.ClosedPath.html b/pr/617/docs/noq/struct.ClosedPath.html
index 38e0c7a7a..5c7e83667 100644
--- a/pr/617/docs/noq/struct.ClosedPath.html
+++ b/pr/617/docs/noq/struct.ClosedPath.html
@@ -1,6 +1,6 @@
-ClosedPath in noq - Rust ClosedPath
pub struct ClosedPath { /* private fields */ }
Expand description
Error indicating that a path has not been opened or has already been abandoned
-Trait Implementations§
Source§impl Clone for ClosedPath
Source§fn clone(&self) -> ClosedPath
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 ClosedPath
Source§impl Default for ClosedPath
Source§fn default() -> ClosedPath
Returns the “default value” for a type. Read moreSource§impl Display for ClosedPath
Source§impl Error for ClosedPath
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 PartialEq for ClosedPath
Source§impl Eq for ClosedPath
Source§impl StructuralPartialEq for ClosedPath
Auto Trait Implementations§
§impl Freeze for ClosedPath
§impl RefUnwindSafe for ClosedPath
§impl Send for ClosedPath
§impl Sync for ClosedPath
§impl Unpin for ClosedPath
§impl UnwindSafe for ClosedPath
Blanket Implementations§
Source§impl<T> Any for Twhere
+ClosedPath in noq - Rust ClosedPath
pub struct ClosedPath { /* private fields */ }
Expand description
Error indicating that a path has not been opened or has already been abandoned
+Trait Implementations§
Source§impl Clone for ClosedPath
Source§fn clone(&self) -> ClosedPath
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 ClosedPath
Source§impl Default for ClosedPath
Source§fn default() -> ClosedPath
Returns the “default value” for a type. Read moreSource§impl Display for ClosedPath
Source§impl Error for ClosedPath
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 PartialEq for ClosedPath
Source§impl Eq for ClosedPath
Source§impl StructuralPartialEq for ClosedPath
Auto Trait Implementations§
§impl Freeze for ClosedPath
§impl RefUnwindSafe for ClosedPath
§impl Send for ClosedPath
§impl Sync for ClosedPath
§impl Unpin for ClosedPath
§impl UnwindSafe for ClosedPath
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/617/docs/noq/struct.Connecting.html b/pr/617/docs/noq/struct.Connecting.html
index fbd5cd159..989576043 100644
--- a/pr/617/docs/noq/struct.Connecting.html
+++ b/pr/617/docs/noq/struct.Connecting.html
@@ -1,5 +1,5 @@
Connecting in noq - Rust Connecting
pub struct Connecting { /* private fields */ }
Expand description
In-progress connection attempt future
-Implementations§
Source§impl Connecting
Sourcepub fn into_0rtt(self) -> Result<(Connection, ZeroRttAccepted), Self>
Convert into a 0-RTT or 0.5-RTT connection at the cost of weakened security
+Implementations§
Source§impl Connecting
Sourcepub fn into_0rtt(self) -> Result<(Connection, ZeroRttAccepted), Self>
Convert into a 0-RTT or 0.5-RTT connection at the cost of weakened security
Returns Ok immediately if the local endpoint is able to attempt sending 0/0.5-RTT data.
If so, the returned Connection can be used to send application data without waiting for
the rest of the handshake to complete, at the cost of weakened cryptographic security
@@ -45,9 +45,9 @@ the endpoint is bound to a wildcard address like 0.0.0.0 or :
information. See noq_udp::RecvMeta::dst_ip for a list of
supported platforms when using noq_udp for I/O, which is the default.
Will panic if called after poll has returned Ready.
-Sourcepub fn remote_address(&self) -> SocketAddr
The peer’s UDP addresses
+Sourcepub fn remote_address(&self) -> SocketAddr
The peer’s UDP addresses
Will panic if called after poll has returned Ready.
-Trait Implementations§
Source§impl Debug for Connecting
Trait Implementations§
Source§impl Debug for Connecting
Source§impl Future for Connecting
Source§type Output = Result<Connection, ConnectionError>
The type of value produced on completion.Auto Trait Implementations§
§impl Freeze for Connecting
§impl !RefUnwindSafe for Connecting
§impl Send for Connecting
§impl Sync for Connecting
§impl Unpin for Connecting
§impl !UnwindSafe for Connecting
Blanket Implementations§
Source§impl<T> BorrowMut<T> for Twhere
diff --git a/pr/617/docs/noq/struct.Connection.html b/pr/617/docs/noq/struct.Connection.html
index fac0582c9..3d80f160f 100644
--- a/pr/617/docs/noq/struct.Connection.html
+++ b/pr/617/docs/noq/struct.Connection.html
@@ -1,4 +1,4 @@
-Connection in noq - Rust Connection
pub struct Connection(/* private fields */);
Expand description
A QUIC connection.
+Connection in noq - Rust Connection
pub struct Connection(/* private fields */);
Expand description
A QUIC connection.
If all references to a connection (including every clone of the Connection handle, streams of
incoming streams, and the various stream types) have been dropped, then the connection will be
automatically closed with an error_code of 0 and an empty reason. You can also close the
@@ -8,29 +8,29 @@ receiving CONNECTION_CLOSE the peer may drop any stream data not yet de
application. Connection::close() describes in more detail how to gracefully close a
connection without losing application data.
May be cloned to obtain another handle to the same connection.
-Implementations§
Source§impl Connection
Sourcepub fn weak_handle(&self) -> WeakConnectionHandle
Returns a weak reference to the inner connection struct.
-Implementations§
Source§impl Connection
Sourcepub fn weak_handle(&self) -> WeakConnectionHandle
Returns a weak reference to the inner connection struct.
+Sourcepub fn open_uni(&self) -> OpenUni<'_> ⓘ
Initiate a new outgoing unidirectional stream.
Streams are cheap and instantaneous to open unless blocked by flow control. As a
consequence, the peer won’t be notified that a stream has been opened until the stream is
actually used.
-Sourcepub fn open_bi(&self) -> OpenBi<'_> ⓘ
Initiate a new outgoing bidirectional stream.
Streams are cheap and instantaneous to open unless blocked by flow control. As a
consequence, the peer won’t be notified that a stream has been opened until the stream is
actually used. Calling open_bi() then waiting on the RecvStream without writing
anything to SendStream will never succeed.
-Sourcepub fn accept_uni(&self) -> AcceptUni<'_> ⓘ
Accept the next incoming uni-directional stream
-Sourcepub fn accept_uni(&self) -> AcceptUni<'_> ⓘ
Accept the next incoming uni-directional stream
+Sourcepub fn accept_bi(&self) -> AcceptBi<'_> ⓘ
Accept the next incoming bidirectional stream
Important Note: The Connection that calls open_bi() must write to its SendStream
before the other Connection is able to accept_bi(). Calling open_bi() then
waiting on the RecvStream without writing anything to SendStream will never succeed.
-Sourcepub fn read_datagram(&self) -> ReadDatagram<'_> ⓘ
Receive an application datagram
-Sourcepub fn open_path_ensure(
+
Sourcepub fn read_datagram(&self) -> ReadDatagram<'_> ⓘ
Receive an application datagram
+Sourcepub fn open_path_ensure(
&self,
addr: SocketAddr,
initial_status: PathStatus,
) -> OpenPath ⓘ
Opens a new path if no path exists yet for the remote address.
Otherwise behaves exactly as open_path.
-Sourcepub fn open_path(
&self,
addr: SocketAddr,
initial_status: PathStatus,
@@ -45,34 +45,34 @@ path opens. The P
future, or at a later time. If the failure is immediate OpenPath::path_id will
return None and the future will be ready immediately. If the failure happens
later, a PathEvent will be emitted.
-
Sourcepub fn path_events(&self) -> PathEvents
A stream of PathEvents for all paths in this connection.
+Sourcepub fn path_events(&self) -> PathEvents
A stream of PathEvents for all paths in this connection.
The stream will yield a PathEvent whenever there is a change in the state of any path in this connection.
The events need to be processed immediately, since there isn’t an unbounded buffer for them.
If processing of events lags behind too much, you will get an error of type crate::Lagged indicating
how many events were lost. The stream continues after a lag, delivering the oldest retained message next.
-Sourcepub fn nat_traversal_updates(&self) -> NatTraversalUpdates
A stream of NAT traversal updates for this connection.
+Sourcepub fn nat_traversal_updates(&self) -> NatTraversalUpdates
A stream of NAT traversal updates for this connection.
The events need to be processed immediately, since there isn’t an unbounded buffer for them.
If processing of events lags behind too much, you will get an error of type crate::Lagged indicating
how many events were lost. The stream continues after a lag, delivering the oldest retained message next.
-Sourcepub async fn closed(&self) -> ConnectionError
Wait for the connection to be closed for any reason
+Sourcepub async fn closed(&self) -> ConnectionError
Wait for the connection to be closed for any reason
Despite the return type’s name, closed connections are often not an error condition at the
application layer. Cases that might be routine include ConnectionError::LocallyClosed
and ConnectionError::ApplicationClosed.
-Sourcepub fn on_closed(&self) -> OnClosed ⓘ
Wait for the connection to be closed without keeping a strong reference to the connection
+Sourcepub fn on_closed(&self) -> OnClosed ⓘ
Wait for the connection to be closed without keeping a strong reference to the connection
Returns a future that resolves, once the connection is closed, to a Closed struct
describing the close reason and final connection and per-path statistics.
Calling Self::closed keeps the connection alive until it is either closed locally via Connection::close
or closed by the remote peer. This function instead does not keep the connection itself alive,
so if all other clones of the connection are dropped, the connection will be closed implicitly even
if there are futures returned from this function still being awaited.
-Sourcepub fn close_reason(&self) -> Option<ConnectionError>
Whether the connection is closed, and why.
+Sourcepub fn close_reason(&self) -> Option<ConnectionError>
Whether the connection is closed, and why.
The close_reason is always set to Some(ConnectionError) when a socket is
closed; whether it was closed manually by calling Connection::close() or due to
an internal error (such as an idle timeout or the peer closing the
connection).
Note: when the connection is closed, connection.close_reason().is_some() will always be true.
-Sourcepub fn close(&self, error_code: VarInt, reason: &[u8])
Close the connection immediately.
Pending operations will fail immediately with ConnectionError::LocallyClosed. No
more data is sent to the peer and the peer may drop buffered data upon receiving
the CONNECTION_CLOSE frame.
@@ -93,7 +93,7 @@ endpoint. Once the local side sends a CONNECTION_CLOSE frame in response to call
close() the remote endpoint may drop any data it received but is as yet
undelivered to the application, including data that was acknowledged as received to
the local endpoint.
-Sourcepub async fn handshake_confirmed(&self) -> Result<(), ConnectionError>
Wait for the handshake to be confirmed.
+Sourcepub async fn handshake_confirmed(&self) -> Result<(), ConnectionError>
Wait for the handshake to be confirmed.
As a server, who must be authenticated by clients,
this happens when the handshake completes
upon receiving a TLS Finished message from the client.
@@ -101,56 +101,44 @@ In return, the server send a HANDSHAKE_DONE frame.
As a client, this happens when receiving a HANDSHAKE_DONE frame.
At this point, the server has either accepted our authentication,
or, if client authentication is not required, accepted our lack of authentication.
-Sourcepub fn send_datagram(&self, data: Bytes) -> Result<(), SendDatagramError>
Transmit data as an unreliable, unordered application datagram
+Sourcepub fn send_datagram(&self, data: Bytes) -> Result<(), SendDatagramError>
Transmit data as an unreliable, unordered application datagram
Application datagrams are a low-level primitive. They may be lost or delivered out of order,
and data must both fit inside a single QUIC packet and be smaller than the maximum
dictated by the peer.
Previously queued datagrams which are still unsent may be discarded to make space for this
datagram, in order of oldest to newest.
-Sourcepub fn send_datagram_wait(&self, data: Bytes) -> SendDatagram<'_> ⓘ
Transmit data as an unreliable, unordered application datagram
+Sourcepub fn send_datagram_wait(&self, data: Bytes) -> SendDatagram<'_> ⓘ
Transmit data as an unreliable, unordered application datagram
Unlike send_datagram(), this method will wait for buffer space during congestion
conditions, which effectively prioritizes old datagrams over new datagrams.
See send_datagram() for details.
-Sourcepub fn max_datagram_size(&self) -> Option<usize>
Compute the maximum size of datagrams that may be passed to send_datagram().
+Sourcepub fn max_datagram_size(&self) -> Option<usize>
Compute the maximum size of datagrams that may be passed to send_datagram().
Returns None if datagrams are unsupported by the peer or disabled locally.
This may change over the lifetime of a connection according to variation in the path MTU
estimate. The peer can also enforce an arbitrarily small fixed limit, but if the peer’s
limit is large this is guaranteed to be a little over a kilobyte at minimum.
Not necessarily the maximum size of received datagrams.
-Sourcepub fn datagram_send_buffer_space(&self) -> usize
Bytes available in the outgoing datagram buffer
+Sourcepub fn datagram_send_buffer_space(&self) -> usize
Bytes available in the outgoing datagram buffer
When greater than zero, calling send_datagram() with a datagram of
at most this size is guaranteed not to cause older datagrams to be dropped.
-Sourcepub fn remote_address(&self) -> SocketAddr
The peer’s UDP address
-If ServerConfig::migration is true, clients may change addresses at will,
-e.g. when switching to a cellular internet connection.
-If multipath is enabled this will return the address of any
-path, and may not be consistent. Prefer Path::remote_address instead.
-Sourcepub fn local_ip(&self) -> Option<IpAddr>
The local IP address which was used when the peer established
-the connection
-This can be different from the address the endpoint is bound to, in case
-the endpoint is bound to a wildcard address like 0.0.0.0 or ::.
-This will return None for clients, or when the platform does not expose this
-information. See noq_udp::RecvMeta::dst_ip for a list of
-supported platforms when using noq_udp for I/O, which is the default.
-Sourcepub fn rtt(&self, path_id: PathId) -> Option<Duration>
Current best estimate of this connection’s latency (round-trip-time)
-Sourcepub fn stats(&self) -> ConnectionStats
Returns connection statistics
-Sourcepub fn path_stats(&self, path_id: PathId) -> Option<PathStats>
Returns path statistics
-Sourcepub fn congestion_state(&self, path_id: PathId) -> Option<Box<dyn Controller>>
Current state of the congestion control algorithm, for debugging purposes
-Sourcepub fn handshake_data(&self) -> Option<Box<dyn Any>>
Parameters negotiated during the handshake
+Sourcepub fn rtt(&self, path_id: PathId) -> Option<Duration>
Current best estimate of this connection’s latency (round-trip-time)
+Sourcepub fn stats(&self) -> ConnectionStats
Returns connection statistics
+Sourcepub fn path_stats(&self, path_id: PathId) -> Option<PathStats>
Returns path statistics
+Sourcepub fn congestion_state(&self, path_id: PathId) -> Option<Box<dyn Controller>>
Current state of the congestion control algorithm, for debugging purposes
+Sourcepub fn handshake_data(&self) -> Option<Box<dyn Any>>
Parameters negotiated during the handshake
Guaranteed to return Some on fully established connections or after
Connecting::handshake_data() succeeds. See that method’s documentations for details on
the returned value.
-Sourcepub fn peer_identity(&self) -> Option<Box<dyn Any>>
Cryptographic identity of the peer
+Sourcepub fn peer_identity(&self) -> Option<Box<dyn Any>>
Sourcepub fn stable_id(&self) -> usize
A stable identifier for this connection
Peer addresses and connection IDs can change, but this value will remain
fixed for the lifetime of the connection.
-Sourcepub fn force_key_update(&self)
Update traffic keys spontaneously
+Sourcepub fn force_key_update(&self)
Update traffic keys spontaneously
This primarily exists for testing purposes.
-Sourcepub fn export_keying_material(
+
Sourcepub fn export_keying_material(
&self,
output: &mut [u8],
label: &[u8],
@@ -161,17 +149,17 @@ arguments and output buffers of equal length, they will get the
same sequence of bytes in output. These bytes are cryptographically
strong and pseudorandom, and are suitable for use as keying material.
See RFC5705 for more information.
-
Sourcepub fn set_max_concurrent_uni_streams(&self, count: VarInt)
Modify the number of remotely initiated unidirectional streams that may be concurrently open
+Sourcepub fn set_max_concurrent_uni_streams(&self, count: VarInt)
Modify the number of remotely initiated unidirectional streams that may be concurrently open
No streams may be opened by the peer unless fewer than count are already open. Large
counts increase both minimum and worst-case memory consumption.
-Sourcepub fn set_send_window(&self, send_window: u64)
Sourcepub fn set_receive_window(&self, receive_window: VarInt)
Sourcepub fn set_max_concurrent_bi_streams(&self, count: VarInt)
Modify the number of remotely initiated bidirectional streams that may be concurrently open
+Sourcepub fn set_send_window(&self, send_window: u64)
Sourcepub fn set_receive_window(&self, receive_window: VarInt)
Sourcepub fn set_max_concurrent_bi_streams(&self, count: VarInt)
Modify the number of remotely initiated bidirectional streams that may be concurrently open
No streams may be opened by the peer unless fewer than count are already open. Large
counts increase both minimum and worst-case memory consumption.
-Sourcepub fn observed_external_addr(&self) -> ObservedExternalAddr
Track changes on our external address as reported by the peer.
-Sourcepub fn is_multipath_enabled(&self) -> bool
Is multipath enabled?
-Sourcepub fn add_nat_traversal_address(
+
Sourcepub fn observed_external_addr(&self) -> ObservedExternalAddr
Track changes on our external address as reported by the peer.
+Sourcepub fn is_multipath_enabled(&self) -> bool
Is multipath enabled?
+Sourcepub fn add_nat_traversal_address(
&self,
address: SocketAddr,
) -> Result<(), Error>
Registers one address at which this endpoint might be reachable
@@ -179,7 +167,7 @@ strong and pseudorandom, and are suitable for use as keying material.
ADD_ADDRESS frames. This allows clients to obtain server address candidates to initiate
NAT traversal attempts. Clients provide their own reachable addresses in REACH_OUT frames
when Self::initiate_nat_traversal_round is called.
-Sourcepub fn remove_nat_traversal_address(
+
Sourcepub fn remove_nat_traversal_address(
&self,
address: SocketAddr,
) -> Result<(), Error>
Removes one or more addresses from the set of addresses at which this endpoint is reachable
@@ -188,18 +176,18 @@ clients in REMOVE_ADDRESS frames. This allows clients to stop using
server address candidates that are no longer valid for NAT traversal.
For clients, removed addresses will no longer be advertised in REACH_OUT frames.
Addresses not present in the set will be silently ignored.
-Sourcepub fn get_local_nat_traversal_addresses(
+
Sourcepub fn get_local_nat_traversal_addresses(
&self,
) -> Result<Vec<SocketAddr>, Error>
Get the current local nat traversal addresses
-Sourcepub fn get_remote_nat_traversal_addresses(
+
Sourcepub fn get_remote_nat_traversal_addresses(
&self,
) -> Result<Vec<SocketAddr>, Error>
Get the currently advertised nat traversal addresses by the server
-Sourcepub fn initiate_nat_traversal_round(&self) -> Result<Vec<SocketAddr>, Error>
Initiates a new nat traversal round
+Sourcepub fn initiate_nat_traversal_round(&self) -> Result<Vec<SocketAddr>, Error>
Initiates a new nat traversal round
A nat traversal round involves advertising the client’s local addresses in REACH_OUT
frames, and initiating probing of the known remote addresses. When a new round is
initiated, the previous one is cancelled, and paths that have not been opened are closed.
Returns the server addresses that are now being probed.
-Trait Implementations§
Source§impl Clone for Connection
Source§fn clone(&self) -> Connection
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 Connection
§impl RefUnwindSafe for Connection
§impl Send for Connection
§impl Sync for Connection
§impl Unpin for Connection
§impl UnwindSafe for Connection
Blanket Implementations§
Trait Implementations§
Source§impl Clone for Connection
Source§fn clone(&self) -> Connection
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 Connection
§impl RefUnwindSafe for Connection
§impl Send for Connection
§impl Sync for Connection
§impl Unpin for Connection
§impl UnwindSafe for Connection
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/617/docs/noq/struct.EndpointConfig.html b/pr/617/docs/noq/struct.EndpointConfig.html
index 5db8f93f3..e8d394ce3 100644
--- a/pr/617/docs/noq/struct.EndpointConfig.html
+++ b/pr/617/docs/noq/struct.EndpointConfig.html
@@ -1,7 +1,7 @@
-EndpointConfig in noq - Rust EndpointConfig
pub struct EndpointConfig { /* private fields */ }
Expand description
Global configuration for the endpoint, affecting all connections
+EndpointConfig in noq - Rust EndpointConfig
pub struct EndpointConfig { /* private fields */ }
Expand description
Global configuration for the endpoint, affecting all connections
Default values should be suitable for most internet applications.
-Implementations§
Source§impl EndpointConfig
Sourcepub fn new(reset_key: Arc<dyn HmacKey>) -> EndpointConfig
Create a default config with a particular reset_key
-Sourcepub fn cid_generator(
+
Implementations§
Source§impl EndpointConfig
Sourcepub fn new(reset_key: Arc<dyn HmacKey>) -> EndpointConfig
Create a default config with a particular reset_key
+Sourcepub fn cid_generator(
&mut self,
factory: Arc<dyn Fn() -> Box<dyn ConnectionIdGenerator> + Send + Sync>,
) -> &mut EndpointConfig
Supply a custom connection ID generator factory
@@ -10,9 +10,9 @@ generator which will be used to generate the CIDs used for incoming packets on a
connections involving that Endpoint. A custom CID generator allows applications to embed
information in local connection IDs, e.g. to support stateless packet-level load balancers.
Defaults to HashedConnectionIdGenerator.
-Sourcepub fn reset_key(&mut self, key: Arc<dyn HmacKey>) -> &mut EndpointConfig
Private key used to send authenticated connection resets to peers who were
+
Sourcepub fn reset_key(&mut self, key: Arc<dyn HmacKey>) -> &mut EndpointConfig
Private key used to send authenticated connection resets to peers who were
communicating with a previous instance of this endpoint.
-Sourcepub fn max_udp_payload_size(
+
Sourcepub fn max_udp_payload_size(
&mut self,
value: u16,
) -> Result<&mut EndpointConfig, ConfigError>
Maximum UDP payload size accepted from peers (excluding UDP and IP overhead).
@@ -21,27 +21,27 @@ communicating with a previous instance of this endpoint.
1500 byte Ethernet MTU. Deployments on links with larger MTUs (e.g. loopback or Ethernet
with jumbo frames) can raise this to improve performance at the cost of a linear increase in
datagram receive buffer size.
-Sourcepub fn get_max_udp_payload_size(&self) -> u64
Get the current value of max_udp_payload_size
-Sourcepub fn supported_versions(
+
Sourcepub fn get_max_udp_payload_size(&self) -> u64
Get the current value of max_udp_payload_size
+Sourcepub fn supported_versions(
&mut self,
supported_versions: Vec<u32>,
) -> &mut EndpointConfig
Override supported QUIC versions
-Sourcepub fn grease_quic_bit(&mut self, value: bool) -> &mut EndpointConfig
Whether to accept QUIC packets containing any value for the fixed bit
+Sourcepub fn grease_quic_bit(&mut self, value: bool) -> &mut EndpointConfig
Whether to accept QUIC packets containing any value for the fixed bit
Enabled by default. Helps protect against protocol ossification and makes traffic less
identifiable to observers. Disable if helping observers identify this traffic as QUIC is
desired.
-Sourcepub fn min_reset_interval(&mut self, value: Duration) -> &mut EndpointConfig
Minimum interval between outgoing stateless reset packets
+Sourcepub fn min_reset_interval(&mut self, value: Duration) -> &mut EndpointConfig
Minimum interval between outgoing stateless reset packets
Defaults to 20ms. Limits the impact of attacks which flood an endpoint with garbage packets,
e.g. ISAKMP/IKE amplification. Larger values provide a stronger defense, but may delay
detection of some error conditions by clients. Using a ConnectionIdGenerator with a low
rate of false positives in validate reduces the risk
incurred by a small minimum reset interval.
-Sourcepub fn rng_seed(&mut self, seed: Option<[u8; 32]>) -> &mut EndpointConfig
Optional seed to be used internally for random number generation
+Sourcepub fn rng_seed(&mut self, seed: Option<[u8; 32]>) -> &mut EndpointConfig
Optional seed to be used internally for random number generation
By default, noq will initialize an endpoint’s rng using a platform entropy source.
However, you can seed the rng yourself through this method (e.g. if you need to run noq
deterministically or if you are using noq in an environment that doesn’t have a source of
entropy available).
-Trait Implementations§
Source§impl Clone for EndpointConfig
Source§fn clone(&self) -> EndpointConfig
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 EndpointConfig
Source§impl Default for EndpointConfig
Source§fn default() -> EndpointConfig
Returns the “default value” for a type. Read moreAuto Trait Implementations§
§impl Freeze for EndpointConfig
§impl !RefUnwindSafe for EndpointConfig
§impl Send for EndpointConfig
§impl Sync for EndpointConfig
§impl Unpin for EndpointConfig
§impl !UnwindSafe for EndpointConfig
Blanket Implementations§
Trait Implementations§
Source§impl Clone for EndpointConfig
Source§fn clone(&self) -> EndpointConfig
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 EndpointConfig
Source§impl Default for EndpointConfig
Source§fn default() -> EndpointConfig
Returns the “default value” for a type. Read moreAuto Trait Implementations§
§impl Freeze for EndpointConfig
§impl !RefUnwindSafe for EndpointConfig
§impl Send for EndpointConfig
§impl Sync for EndpointConfig
§impl Unpin for EndpointConfig
§impl !UnwindSafe for EndpointConfig
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/617/docs/noq/struct.IdleTimeout.html b/pr/617/docs/noq/struct.IdleTimeout.html
index ace1e130b..7a08b236d 100644
--- a/pr/617/docs/noq/struct.IdleTimeout.html
+++ b/pr/617/docs/noq/struct.IdleTimeout.html
@@ -1,4 +1,4 @@
-IdleTimeout in noq - Rust IdleTimeout
pub struct IdleTimeout(/* private fields */);
Expand description
Maximum duration of inactivity to accept before timing out the connection
+IdleTimeout in noq - Rust IdleTimeout
pub struct IdleTimeout(/* private fields */);
Expand description
Maximum duration of inactivity to accept before timing out the connection
This wraps an underlying VarInt, representing the duration in milliseconds. Values can be
constructed by converting directly from VarInt, or using TryFrom<Duration>.
@@ -6,19 +6,19 @@ constructed by converting directly from VarInt, or using TryF
let timeout = IdleTimeout::from(VarInt::from_u32(10_000));
// Try to convert a `Duration` into a `VarInt`-encoded timeout
-let timeout = IdleTimeout::try_from(Duration::from_secs(10))?;Trait Implementations§
Source§impl Clone for IdleTimeout
Source§fn clone(&self) -> IdleTimeout
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 IdleTimeout
Source§impl Default for IdleTimeout
Source§fn default() -> IdleTimeout
Returns the “default value” for a type. Read moreSource§impl From<VarInt> for IdleTimeout
Source§fn from(inner: VarInt) -> IdleTimeout
Converts to this type from the input type.Source§impl Hash for IdleTimeout
Trait Implementations§
Source§impl Clone for IdleTimeout
Source§fn clone(&self) -> IdleTimeout
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 IdleTimeout
Source§impl Default for IdleTimeout
Source§fn default() -> IdleTimeout
Returns the “default value” for a type. Read moreSource§impl From<VarInt> for IdleTimeout
Source§fn from(inner: VarInt) -> IdleTimeout
Converts to this type from the input type.Source§impl Hash for IdleTimeout
Source§impl Ord for IdleTimeout
Source§impl Ord for IdleTimeout
Source§fn cmp(&self, other: &IdleTimeout) -> Ordering
1.21.0 · Source§fn max(self, other: Self) -> Selfwhere
Self: Sized,
Compares and returns the maximum of two values. Read moreSource§impl PartialEq for IdleTimeout
Source§impl PartialOrd for IdleTimeout
Source§impl PartialEq for IdleTimeout
Source§impl TryFrom<Duration> for IdleTimeout
Source§type Error = VarIntBoundsExceeded
The type returned in the event of a conversion error.Source§fn try_from(
timeout: Duration,
-) -> Result<IdleTimeout, <IdleTimeout as TryFrom<Duration>>::Error>
Performs the conversion.Source§impl Copy for IdleTimeout
Source§impl Eq for IdleTimeout
Source§impl StructuralPartialEq for IdleTimeout
Auto Trait Implementations§
§impl Freeze for IdleTimeout
§impl RefUnwindSafe for IdleTimeout
§impl Send for IdleTimeout
§impl Sync for IdleTimeout
§impl Unpin for IdleTimeout
§impl UnwindSafe for IdleTimeout
Blanket Implementations§
Source§impl Copy for IdleTimeout
Source§impl Eq for IdleTimeout
Source§impl StructuralPartialEq for IdleTimeout
Auto Trait Implementations§
§impl Freeze for IdleTimeout
§impl RefUnwindSafe for IdleTimeout
§impl Send for IdleTimeout
§impl Sync for IdleTimeout
§impl Unpin for IdleTimeout
§impl UnwindSafe for IdleTimeout
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/617/docs/noq/struct.MtuDiscoveryConfig.html b/pr/617/docs/noq/struct.MtuDiscoveryConfig.html
index 07fb6950d..648670fe2 100644
--- a/pr/617/docs/noq/struct.MtuDiscoveryConfig.html
+++ b/pr/617/docs/noq/struct.MtuDiscoveryConfig.html
@@ -1,4 +1,4 @@
-MtuDiscoveryConfig in noq - Rust MtuDiscoveryConfig
pub struct MtuDiscoveryConfig { /* private fields */ }
Expand description
Parameters governing MTU discovery.
+MtuDiscoveryConfig in noq - Rust
ConfigError
#[non_exhaustive]pub enum ConfigError {
+ConfigError in noq - 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/617/docs/noq/enum.ConnectionError.html b/pr/617/docs/noq/enum.ConnectionError.html
index d9e87d540..21a2c4a10 100644
--- a/pr/617/docs/noq/enum.ConnectionError.html
+++ b/pr/617/docs/noq/enum.ConnectionError.html
@@ -1,4 +1,4 @@
-ConnectionError in noq - Rust ConnectionError
pub enum ConnectionError {
+ConnectionError in noq - 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/617/docs/noq/enum.Dir.html b/pr/617/docs/noq/enum.Dir.html
index 43d1fb0f4..5e2e27f31 100644
--- a/pr/617/docs/noq/enum.Dir.html
+++ b/pr/617/docs/noq/enum.Dir.html
@@ -1,25 +1,25 @@
-Dir in noq - Rust Dir
pub enum Dir {
+Dir in noq - 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/617/docs/noq/enum.PathError.html b/pr/617/docs/noq/enum.PathError.html
index b2129d2f5..715d048e9 100644
--- a/pr/617/docs/noq/enum.PathError.html
+++ b/pr/617/docs/noq/enum.PathError.html
@@ -1,4 +1,4 @@
-PathError in noq - Rust PathError
pub enum PathError {
+PathError in noq - Rust PathError
pub enum PathError {
MultipathNotNegotiated,
ServerSideNotAllowed,
MaxPathIdReached,
@@ -12,8 +12,8 @@
§RemoteCidsExhausted
No remote CIDs available to open a new path
§ValidationFailed
Path could not be validated and will be abandoned
§InvalidRemoteAddress(SocketAddr)
The remote address for the path is not supported by the endpoint
-
Trait Implementations§
Source§impl Error for PathError
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 Copy for PathError
Source§impl Eq for PathError
Source§impl StructuralPartialEq for PathError
Auto Trait Implementations§
§impl Freeze for PathError
§impl RefUnwindSafe for PathError
§impl Send for PathError
§impl Sync for PathError
§impl Unpin for PathError
§impl UnwindSafe for PathError
Blanket Implementations§
Trait Implementations§
Source§impl Error for PathError
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 Copy for PathError
Source§impl Eq for PathError
Source§impl StructuralPartialEq for PathError
Auto Trait Implementations§
§impl Freeze for PathError
§impl RefUnwindSafe for PathError
§impl Send for PathError
§impl Sync for PathError
§impl Unpin for PathError
§impl UnwindSafe for PathError
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/617/docs/noq/enum.PathEvent.html b/pr/617/docs/noq/enum.PathEvent.html
index da4b6dad6..6a54cac03 100644
--- a/pr/617/docs/noq/enum.PathEvent.html
+++ b/pr/617/docs/noq/enum.PathEvent.html
@@ -1,4 +1,4 @@
-PathEvent in noq - Rust PathEvent
pub enum PathEvent {
+PathEvent in noq - Rust PathEvent
pub enum PathEvent {
Opened {
id: PathId,
},
@@ -39,8 +39,8 @@ changes the status.
Fields
§id: PathIdPath over which the observed address was reported, PathId::ZERO when multipath is
not negotiated
§addr: SocketAddrThe address observed by the remote over this path
-
Trait Implementations§
Source§impl Eq for PathEvent
Source§impl StructuralPartialEq for PathEvent
Auto Trait Implementations§
§impl Freeze for PathEvent
§impl RefUnwindSafe for PathEvent
§impl Send for PathEvent
§impl Sync for PathEvent
§impl Unpin for PathEvent
§impl UnwindSafe for PathEvent
Blanket Implementations§
Trait Implementations§
Source§impl Eq for PathEvent
Source§impl StructuralPartialEq for PathEvent
Auto Trait Implementations§
§impl Freeze for PathEvent
§impl RefUnwindSafe for PathEvent
§impl Send for PathEvent
§impl Sync for PathEvent
§impl Unpin for PathEvent
§impl UnwindSafe for PathEvent
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/617/docs/noq/enum.PathStatus.html b/pr/617/docs/noq/enum.PathStatus.html
index 4422c371b..9298a8940 100644
--- a/pr/617/docs/noq/enum.PathStatus.html
+++ b/pr/617/docs/noq/enum.PathStatus.html
@@ -1,4 +1,4 @@
-PathStatus in noq - Rust PathStatus
pub enum PathStatus {
+PathStatus in noq - Rust PathStatus
pub enum PathStatus {
Available,
Backup,
}
Expand description
The QUIC-MULTIPATH path status
@@ -10,8 +10,8 @@ capacity.
§Backup
Paths marked as backup will only be used if there are no available paths
If the max_idle_timeout is specified the path will be kept alive so that it does not
expire.
-Trait Implementations§
Source§impl Clone for PathStatus
Source§fn clone(&self) -> PathStatus
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 PathStatus
Source§impl Default for PathStatus
Source§fn default() -> PathStatus
Returns the “default value” for a type. Read moreSource§impl PartialEq for PathStatus
Source§impl Copy for PathStatus
Source§impl Eq for PathStatus
Source§impl StructuralPartialEq for PathStatus
Auto Trait Implementations§
§impl Freeze for PathStatus
§impl RefUnwindSafe for PathStatus
§impl Send for PathStatus
§impl Sync for PathStatus
§impl Unpin for PathStatus
§impl UnwindSafe for PathStatus
Blanket Implementations§
Trait Implementations§
Source§impl Clone for PathStatus
Source§fn clone(&self) -> PathStatus
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 PathStatus
Source§impl Default for PathStatus
Source§fn default() -> PathStatus
Returns the “default value” for a type. Read moreSource§impl PartialEq for PathStatus
Source§impl Copy for PathStatus
Source§impl Eq for PathStatus
Source§impl StructuralPartialEq for PathStatus
Auto Trait Implementations§
§impl Freeze for PathStatus
§impl RefUnwindSafe for PathStatus
§impl Send for PathStatus
§impl Sync for PathStatus
§impl Unpin for PathStatus
§impl UnwindSafe for PathStatus
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/617/docs/noq/enum.SendDatagramError.html b/pr/617/docs/noq/enum.SendDatagramError.html
index 4ac61c63c..dbf07e2a6 100644
--- a/pr/617/docs/noq/enum.SendDatagramError.html
+++ b/pr/617/docs/noq/enum.SendDatagramError.html
@@ -1,4 +1,4 @@
-SendDatagramError in noq - Rust SendDatagramError
pub enum SendDatagramError {
+SendDatagramError in noq - Rust SendDatagramError
pub enum SendDatagramError {
UnsupportedByPeer,
Disabled,
TooLarge,
@@ -10,8 +10,8 @@
Indicates that the path MTU minus overhead or the limit advertised by the peer has been
exceeded.
§ConnectionLost(ConnectionError)
The connection was lost
-
Trait Implementations§
Source§impl Clone for SendDatagramError
Source§fn clone(&self) -> SendDatagramError
Returns a duplicate of the value. Read more1.0.0 · Source§fn clone_from(&mut self, source: &Self)
Performs copy-assignment from source. Read moreSource§impl Debug for SendDatagramError
Source§impl Display for SendDatagramError
Source§impl Error for SendDatagramError
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 SendDatagramError
Source§fn from(source: ConnectionError) -> Self
Converts to this type from the input type.Source§impl PartialEq for SendDatagramError
Source§impl Eq for SendDatagramError
Source§impl StructuralPartialEq for SendDatagramError
Auto Trait Implementations§
§impl !Freeze for SendDatagramError
§impl !RefUnwindSafe for SendDatagramError
§impl Send for SendDatagramError
§impl Sync for SendDatagramError
§impl Unpin for SendDatagramError
§impl !UnwindSafe for SendDatagramError
Blanket Implementations§
Trait Implementations§
Source§impl Clone for SendDatagramError
Source§fn clone(&self) -> SendDatagramError
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 SendDatagramError
Source§impl Display for SendDatagramError
Source§impl Error for SendDatagramError
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 SendDatagramError
Source§fn from(source: ConnectionError) -> Self
Converts to this type from the input type.Source§impl PartialEq for SendDatagramError
Source§impl Eq for SendDatagramError
Source§impl StructuralPartialEq for SendDatagramError
Auto Trait Implementations§
§impl !Freeze for SendDatagramError
§impl !RefUnwindSafe for SendDatagramError
§impl Send for SendDatagramError
§impl Sync for SendDatagramError
§impl Unpin for SendDatagramError
§impl !UnwindSafe for SendDatagramError
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/617/docs/noq/enum.SetPathStatusError.html b/pr/617/docs/noq/enum.SetPathStatusError.html
index 2a9557440..3bb2857be 100644
--- a/pr/617/docs/noq/enum.SetPathStatusError.html
+++ b/pr/617/docs/noq/enum.SetPathStatusError.html
@@ -1,11 +1,11 @@
-SetPathStatusError in noq - Rust SetPathStatusError
pub enum SetPathStatusError {
+SetPathStatusError in noq - Rust SetPathStatusError
pub enum SetPathStatusError {
ClosedPath,
MultipathNotNegotiated,
}
Expand description
Error from setting path status
Variants§
§ClosedPath
Error indicating that a path has not been opened or has already been abandoned
§MultipathNotNegotiated
Error indicating that this operation requires multipath to be negotiated whereas it hasn’t been
-Trait Implementations§
Source§impl Clone for SetPathStatusError
Source§fn clone(&self) -> SetPathStatusError
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 SetPathStatusError
Source§impl Display for SetPathStatusError
Source§impl Error for SetPathStatusError
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 PartialEq for SetPathStatusError
Source§impl Eq for SetPathStatusError
Source§impl StructuralPartialEq for SetPathStatusError
Auto Trait Implementations§
§impl Freeze for SetPathStatusError
§impl RefUnwindSafe for SetPathStatusError
§impl Send for SetPathStatusError
§impl Sync for SetPathStatusError
§impl Unpin for SetPathStatusError
§impl UnwindSafe for SetPathStatusError
Blanket Implementations§
Trait Implementations§
Source§impl Clone for SetPathStatusError
Source§fn clone(&self) -> SetPathStatusError
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 SetPathStatusError
Source§impl Display for SetPathStatusError
Source§impl Error for SetPathStatusError
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 PartialEq for SetPathStatusError
Source§impl Eq for SetPathStatusError
Source§impl StructuralPartialEq for SetPathStatusError
Auto Trait Implementations§
§impl Freeze for SetPathStatusError
§impl RefUnwindSafe for SetPathStatusError
§impl Send for SetPathStatusError
§impl Sync for SetPathStatusError
§impl Unpin for SetPathStatusError
§impl UnwindSafe for SetPathStatusError
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/617/docs/noq/enum.Side.html b/pr/617/docs/noq/enum.Side.html
index 211e245d6..2a88b859f 100644
--- a/pr/617/docs/noq/enum.Side.html
+++ b/pr/617/docs/noq/enum.Side.html
@@ -1,27 +1,27 @@
-Side in noq - Rust Side
pub enum Side {
+Side in noq - 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/617/docs/noq/struct.AcceptBi.html b/pr/617/docs/noq/struct.AcceptBi.html
index e2b6da590..213f9b881 100644
--- a/pr/617/docs/noq/struct.AcceptBi.html
+++ b/pr/617/docs/noq/struct.AcceptBi.html
@@ -1,6 +1,6 @@
-AcceptBi in noq - Rust AcceptBi
pub struct AcceptBi<'a> { /* private fields */ }
Expand description
Future produced by Connection::accept_bi
-Trait Implementations§
Source§impl Future for AcceptBi<'_>
Source§type Output = Result<(SendStream, RecvStream), ConnectionError>
The type of value produced on completion.Source§impl<'__pin, 'a> Unpin for AcceptBi<'a>where
+AcceptBi in noq - Rust AcceptBi
pub struct AcceptBi<'a> { /* private fields */ }
Expand description
Future produced by Connection::accept_bi
+Trait Implementations§
Source§impl Future for AcceptBi<'_>
Source§type Output = Result<(SendStream, RecvStream), ConnectionError>
The type of value produced on completion.Source§impl<'__pin, 'a> Unpin for AcceptBi<'a>where
PinnedFieldsOf<__Origin<'__pin, 'a>>: Unpin,
Auto Trait Implementations§
§impl<'a> !Freeze for AcceptBi<'a>
§impl<'a> !RefUnwindSafe for AcceptBi<'a>
§impl<'a> Send for AcceptBi<'a>
§impl<'a> Sync for AcceptBi<'a>
§impl<'a> !UnwindSafe for AcceptBi<'a>
Blanket Implementations§
Source§impl<T> BorrowMut<T> for Twhere
diff --git a/pr/617/docs/noq/struct.AcceptUni.html b/pr/617/docs/noq/struct.AcceptUni.html
index 725d4cf6f..485306ebe 100644
--- a/pr/617/docs/noq/struct.AcceptUni.html
+++ b/pr/617/docs/noq/struct.AcceptUni.html
@@ -1,6 +1,6 @@
-AcceptUni in noq - Rust AcceptUni
pub struct AcceptUni<'a> { /* private fields */ }
Expand description
Future produced by Connection::accept_uni
-Trait Implementations§
Source§impl Future for AcceptUni<'_>
Source§type Output = Result<RecvStream, ConnectionError>
The type of value produced on completion.Source§impl<'__pin, 'a> Unpin for AcceptUni<'a>where
+AcceptUni in noq - Rust AcceptUni
pub struct AcceptUni<'a> { /* private fields */ }
Expand description
Future produced by Connection::accept_uni
+Trait Implementations§
Source§impl Future for AcceptUni<'_>
Source§type Output = Result<RecvStream, ConnectionError>
The type of value produced on completion.Source§impl<'__pin, 'a> Unpin for AcceptUni<'a>where
PinnedFieldsOf<__Origin<'__pin, 'a>>: Unpin,
Auto Trait Implementations§
§impl<'a> !Freeze for AcceptUni<'a>
§impl<'a> !RefUnwindSafe for AcceptUni<'a>
§impl<'a> Send for AcceptUni<'a>
§impl<'a> Sync for AcceptUni<'a>
§impl<'a> !UnwindSafe for AcceptUni<'a>
Blanket Implementations§
Source§impl<T> BorrowMut<T> for Twhere
diff --git a/pr/617/docs/noq/struct.AckFrequencyConfig.html b/pr/617/docs/noq/struct.AckFrequencyConfig.html
index 2d3d900e9..20a7cff00 100644
--- a/pr/617/docs/noq/struct.AckFrequencyConfig.html
+++ b/pr/617/docs/noq/struct.AckFrequencyConfig.html
@@ -1,4 +1,4 @@
-AckFrequencyConfig in noq - Rust AckFrequencyConfig
pub struct AckFrequencyConfig { /* private fields */ }
Expand description
Parameters for controlling the peer’s acknowledgement frequency
+AckFrequencyConfig in noq - Rust AckFrequencyConfig
pub struct AckFrequencyConfig { /* private fields */ }
Expand description
Parameters for controlling the peer’s acknowledgement frequency
The parameters provided in this config will be sent to the peer at the beginning of the
connection, so it can take them into account when sending acknowledgements (see each parameter’s
description for details on how it influences acknowledgement frequency).
@@ -7,7 +7,7 @@ description for details on how it influences acknowledgement frequency).
The defaults produce behavior slightly different than the behavior without this extension,
because they change the way reordered packets are handled (see
AckFrequencyConfig::reordering_threshold for details).
-Implementations§
Source§impl AckFrequencyConfig
Sourcepub fn ack_eliciting_threshold(
+
Implementations§
Source§impl AckFrequencyConfig
Sourcepub fn ack_eliciting_threshold(
&mut self,
value: VarInt,
) -> &mut AckFrequencyConfig
The ack-eliciting threshold we will request the peer to use
@@ -17,7 +17,7 @@ without immediately sending an ACK.
ack-eliciting packets have been received. A value of 0 results in a receiver immediately
acknowledging every ack-eliciting packet.
Defaults to 1, which sends ACK frames for every other ack-eliciting packet.
-Sourcepub fn max_ack_delay(
+
Sourcepub fn max_ack_delay(
&mut self,
value: Option<Duration>,
) -> &mut AckFrequencyConfig
The max_ack_delay we will request the peer to use
@@ -27,7 +27,7 @@ an ACK when the ack-eliciting threshold hasn’t been reached.
transport parameter, and at most the greater of the current path RTT or 25ms.
Defaults to None, in which case the peer’s original max_ack_delay will be used, as
obtained from its transport parameters.
-Sourcepub fn reordering_threshold(&mut self, value: VarInt) -> &mut AckFrequencyConfig
The reordering threshold we will request the peer to use
+Sourcepub fn reordering_threshold(&mut self, value: VarInt) -> &mut AckFrequencyConfig
The reordering threshold we will request the peer to use
This threshold represents the amount of out-of-order packets that will trigger an endpoint
to send an ACK, without waiting for ack_eliciting_threshold to be exceeded or for
max_ack_delay to be elapsed.
@@ -37,7 +37,7 @@ behavior when the extension is disabled).
It is recommended to set this value to TransportConfig::packet_threshold minus one.
Since the default value for TransportConfig::packet_threshold is 3, this value defaults
to 2.
-Trait Implementations§
Source§impl Clone for AckFrequencyConfig
Source§fn clone(&self) -> AckFrequencyConfig
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 AckFrequencyConfig
Source§impl Default for AckFrequencyConfig
Source§fn default() -> AckFrequencyConfig
Returns the “default value” for a type. Read moreAuto Trait Implementations§
§impl Freeze for AckFrequencyConfig
§impl RefUnwindSafe for AckFrequencyConfig
§impl Send for AckFrequencyConfig
§impl Sync for AckFrequencyConfig
§impl Unpin for AckFrequencyConfig
§impl UnwindSafe for AckFrequencyConfig
Blanket Implementations§
Trait Implementations§
Source§impl Clone for AckFrequencyConfig
Source§fn clone(&self) -> AckFrequencyConfig
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 AckFrequencyConfig
Source§impl Default for AckFrequencyConfig
Source§fn default() -> AckFrequencyConfig
Returns the “default value” for a type. Read moreAuto Trait Implementations§
§impl Freeze for AckFrequencyConfig
§impl RefUnwindSafe for AckFrequencyConfig
§impl Send for AckFrequencyConfig
§impl Sync for AckFrequencyConfig
§impl Unpin for AckFrequencyConfig
§impl UnwindSafe for AckFrequencyConfig
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/617/docs/noq/struct.AddressDiscovery.html b/pr/617/docs/noq/struct.AddressDiscovery.html
index b14c5a0cd..22a2d8d82 100644
--- a/pr/617/docs/noq/struct.AddressDiscovery.html
+++ b/pr/617/docs/noq/struct.AddressDiscovery.html
@@ -1,7 +1,7 @@
-AddressDiscovery in noq - Rust AddressDiscovery
pub struct AddressDiscovery { /* private fields */ }
Expand description
Stream produced by Path::observed_external_addr
+AddressDiscovery in noq - 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
Trait Implementations§
Source§impl Stream for AddressDiscovery
Source§type Item = SocketAddr
Values yielded by the stream.Source§fn poll_next(
self: Pin<&mut Self>,
cx: &mut Context<'_>,
) -> Poll<Option<Self::Item>>
Attempt to pull out the next value of this stream, registering the
diff --git a/pr/617/docs/noq/struct.ClientConfig.html b/pr/617/docs/noq/struct.ClientConfig.html
index 8253ad80d..db7008c26 100644
--- a/pr/617/docs/noq/struct.ClientConfig.html
+++ b/pr/617/docs/noq/struct.ClientConfig.html
@@ -1,7 +1,7 @@
-ClientConfig in noq - Rust ClientConfig
#[non_exhaustive]pub struct ClientConfig { /* private fields */ }
Expand description
Configuration for outgoing connections
+ClientConfig in noq - 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(
+
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(
&mut self,
initial_dst_cid_provider: Arc<dyn Fn() -> ConnectionId + Send + Sync>,
) -> &mut ClientConfig
Configure how to populate the destination CID of the initial packet when attempting to
@@ -10,18 +10,18 @@ establish a new connection
a good reason, you do not need to change it.
When prefer to override the default, please note that the generated connection ID MUST be
at least 8 bytes long and unpredictable, as per section 7.2 of RFC 9000.
-Sourcepub fn transport_config(
+
Sourcepub fn transport_config(
&mut self,
transport: Arc<TransportConfig>,
) -> &mut ClientConfig
Set a custom TransportConfig
-Sourcepub fn token_store(&mut self, store: Arc<dyn TokenStore>) -> &mut ClientConfig
Set a custom TokenStore
+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 try_with_platform_verifier() -> Result<ClientConfig, Error>
Create a client configuration that trusts the platform’s native roots
-Sourcepub fn with_root_certificates(
+
Sourcepub fn version(&mut self, version: u32) -> &mut ClientConfig
Set the QUIC version to use
+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/617/docs/noq/struct.Closed.html b/pr/617/docs/noq/struct.Closed.html
index 51bccab3a..4bd279633 100644
--- a/pr/617/docs/noq/struct.Closed.html
+++ b/pr/617/docs/noq/struct.Closed.html
@@ -1,4 +1,4 @@
-Closed in noq - Rust Closed
#[non_exhaustive]pub struct Closed {
+Closed in noq - Rust Closed
#[non_exhaustive]pub struct Closed {
pub reason: ConnectionError,
pub stats: ConnectionStats,
pub path_stats: BTreeMap<PathId, PathStats>,
@@ -10,7 +10,7 @@
This includes paths that haven’t been discarded at close time, plus any
already-discarded paths whose final stats had been retained because a Path
or WeakPathHandle handle was kept alive.
-
Trait Implementations§
Auto Trait Implementations§
§impl !Freeze for Closed
§impl !RefUnwindSafe for Closed
§impl Send for Closed
§impl Sync for Closed
§impl Unpin for Closed
§impl !UnwindSafe for Closed
Blanket Implementations§
Source§impl<T> Any for Twhere
+Trait Implementations§
Auto Trait Implementations§
§impl !Freeze for Closed
§impl !RefUnwindSafe for Closed
§impl Send for Closed
§impl Sync for Closed
§impl Unpin for Closed
§impl !UnwindSafe for Closed
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/617/docs/noq/struct.ClosedPath.html b/pr/617/docs/noq/struct.ClosedPath.html
index 38e0c7a7a..5c7e83667 100644
--- a/pr/617/docs/noq/struct.ClosedPath.html
+++ b/pr/617/docs/noq/struct.ClosedPath.html
@@ -1,6 +1,6 @@
-ClosedPath in noq - Rust ClosedPath
pub struct ClosedPath { /* private fields */ }
Expand description
Error indicating that a path has not been opened or has already been abandoned
-Trait Implementations§
Source§impl Clone for ClosedPath
Source§fn clone(&self) -> ClosedPath
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 ClosedPath
Source§impl Default for ClosedPath
Source§fn default() -> ClosedPath
Returns the “default value” for a type. Read moreSource§impl Display for ClosedPath
Source§impl Error for ClosedPath
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 PartialEq for ClosedPath
Source§impl Eq for ClosedPath
Source§impl StructuralPartialEq for ClosedPath
Auto Trait Implementations§
§impl Freeze for ClosedPath
§impl RefUnwindSafe for ClosedPath
§impl Send for ClosedPath
§impl Sync for ClosedPath
§impl Unpin for ClosedPath
§impl UnwindSafe for ClosedPath
Blanket Implementations§
Source§impl<T> Any for Twhere
+ClosedPath in noq - Rust ClosedPath
pub struct ClosedPath { /* private fields */ }
Expand description
Error indicating that a path has not been opened or has already been abandoned
+Trait Implementations§
Source§impl Clone for ClosedPath
Source§fn clone(&self) -> ClosedPath
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 ClosedPath
Source§impl Default for ClosedPath
Source§fn default() -> ClosedPath
Returns the “default value” for a type. Read moreSource§impl Display for ClosedPath
Source§impl Error for ClosedPath
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 PartialEq for ClosedPath
Source§impl Eq for ClosedPath
Source§impl StructuralPartialEq for ClosedPath
Auto Trait Implementations§
§impl Freeze for ClosedPath
§impl RefUnwindSafe for ClosedPath
§impl Send for ClosedPath
§impl Sync for ClosedPath
§impl Unpin for ClosedPath
§impl UnwindSafe for ClosedPath
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/617/docs/noq/struct.Connecting.html b/pr/617/docs/noq/struct.Connecting.html
index fbd5cd159..989576043 100644
--- a/pr/617/docs/noq/struct.Connecting.html
+++ b/pr/617/docs/noq/struct.Connecting.html
@@ -1,5 +1,5 @@
Connecting in noq - Rust Connecting
pub struct Connecting { /* private fields */ }
Expand description
In-progress connection attempt future
-Implementations§
Source§impl Connecting
Sourcepub fn into_0rtt(self) -> Result<(Connection, ZeroRttAccepted), Self>
Convert into a 0-RTT or 0.5-RTT connection at the cost of weakened security
+Implementations§
Source§impl Connecting
Sourcepub fn into_0rtt(self) -> Result<(Connection, ZeroRttAccepted), Self>
Convert into a 0-RTT or 0.5-RTT connection at the cost of weakened security
Returns Ok immediately if the local endpoint is able to attempt sending 0/0.5-RTT data.
If so, the returned Connection can be used to send application data without waiting for
the rest of the handshake to complete, at the cost of weakened cryptographic security
@@ -45,9 +45,9 @@ the endpoint is bound to a wildcard address like 0.0.0.0 or :
information. See noq_udp::RecvMeta::dst_ip for a list of
supported platforms when using noq_udp for I/O, which is the default.
Will panic if called after poll has returned Ready.
-Sourcepub fn remote_address(&self) -> SocketAddr
The peer’s UDP addresses
+Sourcepub fn remote_address(&self) -> SocketAddr
The peer’s UDP addresses
Will panic if called after poll has returned Ready.
-Trait Implementations§
Source§impl Debug for Connecting
Trait Implementations§
Source§impl Debug for Connecting
Source§impl Future for Connecting
Source§type Output = Result<Connection, ConnectionError>
The type of value produced on completion.Auto Trait Implementations§
§impl Freeze for Connecting
§impl !RefUnwindSafe for Connecting
§impl Send for Connecting
§impl Sync for Connecting
§impl Unpin for Connecting
§impl !UnwindSafe for Connecting
Blanket Implementations§
Source§impl<T> BorrowMut<T> for Twhere
diff --git a/pr/617/docs/noq/struct.Connection.html b/pr/617/docs/noq/struct.Connection.html
index fac0582c9..3d80f160f 100644
--- a/pr/617/docs/noq/struct.Connection.html
+++ b/pr/617/docs/noq/struct.Connection.html
@@ -1,4 +1,4 @@
-Connection in noq - Rust Connection
pub struct Connection(/* private fields */);
Expand description
A QUIC connection.
+Connection in noq - Rust Connection
pub struct Connection(/* private fields */);
Expand description
A QUIC connection.
If all references to a connection (including every clone of the Connection handle, streams of
incoming streams, and the various stream types) have been dropped, then the connection will be
automatically closed with an error_code of 0 and an empty reason. You can also close the
@@ -8,29 +8,29 @@ receiving CONNECTION_CLOSE the peer may drop any stream data not yet de
application. Connection::close() describes in more detail how to gracefully close a
connection without losing application data.
May be cloned to obtain another handle to the same connection.
-Implementations§
Source§impl Connection
Sourcepub fn weak_handle(&self) -> WeakConnectionHandle
Returns a weak reference to the inner connection struct.
-Implementations§
Source§impl Connection
Sourcepub fn weak_handle(&self) -> WeakConnectionHandle
Returns a weak reference to the inner connection struct.
+Sourcepub fn open_uni(&self) -> OpenUni<'_> ⓘ
Initiate a new outgoing unidirectional stream.
Streams are cheap and instantaneous to open unless blocked by flow control. As a
consequence, the peer won’t be notified that a stream has been opened until the stream is
actually used.
-Sourcepub fn open_bi(&self) -> OpenBi<'_> ⓘ
Initiate a new outgoing bidirectional stream.
Streams are cheap and instantaneous to open unless blocked by flow control. As a
consequence, the peer won’t be notified that a stream has been opened until the stream is
actually used. Calling open_bi() then waiting on the RecvStream without writing
anything to SendStream will never succeed.
-Sourcepub fn accept_uni(&self) -> AcceptUni<'_> ⓘ
Accept the next incoming uni-directional stream
-Sourcepub fn accept_uni(&self) -> AcceptUni<'_> ⓘ
Accept the next incoming uni-directional stream
+Sourcepub fn accept_bi(&self) -> AcceptBi<'_> ⓘ
Accept the next incoming bidirectional stream
Important Note: The Connection that calls open_bi() must write to its SendStream
before the other Connection is able to accept_bi(). Calling open_bi() then
waiting on the RecvStream without writing anything to SendStream will never succeed.
-Sourcepub fn read_datagram(&self) -> ReadDatagram<'_> ⓘ
Receive an application datagram
-Sourcepub fn open_path_ensure(
+
Sourcepub fn read_datagram(&self) -> ReadDatagram<'_> ⓘ
Receive an application datagram
+Sourcepub fn open_path_ensure(
&self,
addr: SocketAddr,
initial_status: PathStatus,
) -> OpenPath ⓘ
Opens a new path if no path exists yet for the remote address.
Otherwise behaves exactly as open_path.
-Sourcepub fn open_path(
&self,
addr: SocketAddr,
initial_status: PathStatus,
@@ -45,34 +45,34 @@ path opens. The P
future, or at a later time. If the failure is immediate OpenPath::path_id will
return None and the future will be ready immediately. If the failure happens
later, a PathEvent will be emitted.
-
Sourcepub fn path_events(&self) -> PathEvents
A stream of PathEvents for all paths in this connection.
+Sourcepub fn path_events(&self) -> PathEvents
A stream of PathEvents for all paths in this connection.
The stream will yield a PathEvent whenever there is a change in the state of any path in this connection.
The events need to be processed immediately, since there isn’t an unbounded buffer for them.
If processing of events lags behind too much, you will get an error of type crate::Lagged indicating
how many events were lost. The stream continues after a lag, delivering the oldest retained message next.
-Sourcepub fn nat_traversal_updates(&self) -> NatTraversalUpdates
A stream of NAT traversal updates for this connection.
+Sourcepub fn nat_traversal_updates(&self) -> NatTraversalUpdates
A stream of NAT traversal updates for this connection.
The events need to be processed immediately, since there isn’t an unbounded buffer for them.
If processing of events lags behind too much, you will get an error of type crate::Lagged indicating
how many events were lost. The stream continues after a lag, delivering the oldest retained message next.
-Sourcepub async fn closed(&self) -> ConnectionError
Wait for the connection to be closed for any reason
+Sourcepub async fn closed(&self) -> ConnectionError
Wait for the connection to be closed for any reason
Despite the return type’s name, closed connections are often not an error condition at the
application layer. Cases that might be routine include ConnectionError::LocallyClosed
and ConnectionError::ApplicationClosed.
-Sourcepub fn on_closed(&self) -> OnClosed ⓘ
Wait for the connection to be closed without keeping a strong reference to the connection
+Sourcepub fn on_closed(&self) -> OnClosed ⓘ
Wait for the connection to be closed without keeping a strong reference to the connection
Returns a future that resolves, once the connection is closed, to a Closed struct
describing the close reason and final connection and per-path statistics.
Calling Self::closed keeps the connection alive until it is either closed locally via Connection::close
or closed by the remote peer. This function instead does not keep the connection itself alive,
so if all other clones of the connection are dropped, the connection will be closed implicitly even
if there are futures returned from this function still being awaited.
-Sourcepub fn close_reason(&self) -> Option<ConnectionError>
Whether the connection is closed, and why.
+Sourcepub fn close_reason(&self) -> Option<ConnectionError>
Whether the connection is closed, and why.
The close_reason is always set to Some(ConnectionError) when a socket is
closed; whether it was closed manually by calling Connection::close() or due to
an internal error (such as an idle timeout or the peer closing the
connection).
Note: when the connection is closed, connection.close_reason().is_some() will always be true.
-Sourcepub fn close(&self, error_code: VarInt, reason: &[u8])
Close the connection immediately.
Pending operations will fail immediately with ConnectionError::LocallyClosed. No
more data is sent to the peer and the peer may drop buffered data upon receiving
the CONNECTION_CLOSE frame.
@@ -93,7 +93,7 @@ endpoint. Once the local side sends a CONNECTION_CLOSE frame in response to call
close() the remote endpoint may drop any data it received but is as yet
undelivered to the application, including data that was acknowledged as received to
the local endpoint.
-Sourcepub async fn handshake_confirmed(&self) -> Result<(), ConnectionError>
Wait for the handshake to be confirmed.
+Sourcepub async fn handshake_confirmed(&self) -> Result<(), ConnectionError>
Wait for the handshake to be confirmed.
As a server, who must be authenticated by clients,
this happens when the handshake completes
upon receiving a TLS Finished message from the client.
@@ -101,56 +101,44 @@ In return, the server send a HANDSHAKE_DONE frame.
As a client, this happens when receiving a HANDSHAKE_DONE frame.
At this point, the server has either accepted our authentication,
or, if client authentication is not required, accepted our lack of authentication.
-Sourcepub fn send_datagram(&self, data: Bytes) -> Result<(), SendDatagramError>
Transmit data as an unreliable, unordered application datagram
+Sourcepub fn send_datagram(&self, data: Bytes) -> Result<(), SendDatagramError>
Transmit data as an unreliable, unordered application datagram
Application datagrams are a low-level primitive. They may be lost or delivered out of order,
and data must both fit inside a single QUIC packet and be smaller than the maximum
dictated by the peer.
Previously queued datagrams which are still unsent may be discarded to make space for this
datagram, in order of oldest to newest.
-Sourcepub fn send_datagram_wait(&self, data: Bytes) -> SendDatagram<'_> ⓘ
Transmit data as an unreliable, unordered application datagram
+Sourcepub fn send_datagram_wait(&self, data: Bytes) -> SendDatagram<'_> ⓘ
Transmit data as an unreliable, unordered application datagram
Unlike send_datagram(), this method will wait for buffer space during congestion
conditions, which effectively prioritizes old datagrams over new datagrams.
See send_datagram() for details.
-Sourcepub fn max_datagram_size(&self) -> Option<usize>
Compute the maximum size of datagrams that may be passed to send_datagram().
+Sourcepub fn max_datagram_size(&self) -> Option<usize>
Compute the maximum size of datagrams that may be passed to send_datagram().
Returns None if datagrams are unsupported by the peer or disabled locally.
This may change over the lifetime of a connection according to variation in the path MTU
estimate. The peer can also enforce an arbitrarily small fixed limit, but if the peer’s
limit is large this is guaranteed to be a little over a kilobyte at minimum.
Not necessarily the maximum size of received datagrams.
-Sourcepub fn datagram_send_buffer_space(&self) -> usize
Bytes available in the outgoing datagram buffer
+Sourcepub fn datagram_send_buffer_space(&self) -> usize
Bytes available in the outgoing datagram buffer
When greater than zero, calling send_datagram() with a datagram of
at most this size is guaranteed not to cause older datagrams to be dropped.
-Sourcepub fn remote_address(&self) -> SocketAddr
The peer’s UDP address
-If ServerConfig::migration is true, clients may change addresses at will,
-e.g. when switching to a cellular internet connection.
-If multipath is enabled this will return the address of any
-path, and may not be consistent. Prefer Path::remote_address instead.
-Sourcepub fn local_ip(&self) -> Option<IpAddr>
The local IP address which was used when the peer established
-the connection
-This can be different from the address the endpoint is bound to, in case
-the endpoint is bound to a wildcard address like 0.0.0.0 or ::.
-This will return None for clients, or when the platform does not expose this
-information. See noq_udp::RecvMeta::dst_ip for a list of
-supported platforms when using noq_udp for I/O, which is the default.
-Sourcepub fn rtt(&self, path_id: PathId) -> Option<Duration>
Current best estimate of this connection’s latency (round-trip-time)
-Sourcepub fn stats(&self) -> ConnectionStats
Returns connection statistics
-Sourcepub fn path_stats(&self, path_id: PathId) -> Option<PathStats>
Returns path statistics
-Sourcepub fn congestion_state(&self, path_id: PathId) -> Option<Box<dyn Controller>>
Current state of the congestion control algorithm, for debugging purposes
-Sourcepub fn handshake_data(&self) -> Option<Box<dyn Any>>
Parameters negotiated during the handshake
+Sourcepub fn rtt(&self, path_id: PathId) -> Option<Duration>
Current best estimate of this connection’s latency (round-trip-time)
+Sourcepub fn stats(&self) -> ConnectionStats
Returns connection statistics
+Sourcepub fn path_stats(&self, path_id: PathId) -> Option<PathStats>
Returns path statistics
+Sourcepub fn congestion_state(&self, path_id: PathId) -> Option<Box<dyn Controller>>
Current state of the congestion control algorithm, for debugging purposes
+Sourcepub fn handshake_data(&self) -> Option<Box<dyn Any>>
Parameters negotiated during the handshake
Guaranteed to return Some on fully established connections or after
Connecting::handshake_data() succeeds. See that method’s documentations for details on
the returned value.
-Sourcepub fn peer_identity(&self) -> Option<Box<dyn Any>>
Cryptographic identity of the peer
+Sourcepub fn peer_identity(&self) -> Option<Box<dyn Any>>
Sourcepub fn stable_id(&self) -> usize
A stable identifier for this connection
Peer addresses and connection IDs can change, but this value will remain
fixed for the lifetime of the connection.
-Sourcepub fn force_key_update(&self)
Update traffic keys spontaneously
+Sourcepub fn force_key_update(&self)
Update traffic keys spontaneously
This primarily exists for testing purposes.
-Sourcepub fn export_keying_material(
+
Sourcepub fn export_keying_material(
&self,
output: &mut [u8],
label: &[u8],
@@ -161,17 +149,17 @@ arguments and output buffers of equal length, they will get the
same sequence of bytes in output. These bytes are cryptographically
strong and pseudorandom, and are suitable for use as keying material.
See RFC5705 for more information.
-
Sourcepub fn set_max_concurrent_uni_streams(&self, count: VarInt)
Modify the number of remotely initiated unidirectional streams that may be concurrently open
+Sourcepub fn set_max_concurrent_uni_streams(&self, count: VarInt)
Modify the number of remotely initiated unidirectional streams that may be concurrently open
No streams may be opened by the peer unless fewer than count are already open. Large
counts increase both minimum and worst-case memory consumption.
-Sourcepub fn set_send_window(&self, send_window: u64)
Sourcepub fn set_receive_window(&self, receive_window: VarInt)
Sourcepub fn set_max_concurrent_bi_streams(&self, count: VarInt)
Modify the number of remotely initiated bidirectional streams that may be concurrently open
+Sourcepub fn set_send_window(&self, send_window: u64)
Sourcepub fn set_receive_window(&self, receive_window: VarInt)
Sourcepub fn set_max_concurrent_bi_streams(&self, count: VarInt)
Modify the number of remotely initiated bidirectional streams that may be concurrently open
No streams may be opened by the peer unless fewer than count are already open. Large
counts increase both minimum and worst-case memory consumption.
-Sourcepub fn observed_external_addr(&self) -> ObservedExternalAddr
Track changes on our external address as reported by the peer.
-Sourcepub fn is_multipath_enabled(&self) -> bool
Is multipath enabled?
-Sourcepub fn add_nat_traversal_address(
+
Sourcepub fn observed_external_addr(&self) -> ObservedExternalAddr
Track changes on our external address as reported by the peer.
+Sourcepub fn is_multipath_enabled(&self) -> bool
Is multipath enabled?
+Sourcepub fn add_nat_traversal_address(
&self,
address: SocketAddr,
) -> Result<(), Error>
Registers one address at which this endpoint might be reachable
@@ -179,7 +167,7 @@ strong and pseudorandom, and are suitable for use as keying material.
ADD_ADDRESS frames. This allows clients to obtain server address candidates to initiate
NAT traversal attempts. Clients provide their own reachable addresses in REACH_OUT frames
when Self::initiate_nat_traversal_round is called.
-Sourcepub fn remove_nat_traversal_address(
+
Sourcepub fn remove_nat_traversal_address(
&self,
address: SocketAddr,
) -> Result<(), Error>
Removes one or more addresses from the set of addresses at which this endpoint is reachable
@@ -188,18 +176,18 @@ clients in REMOVE_ADDRESS frames. This allows clients to stop using
server address candidates that are no longer valid for NAT traversal.
For clients, removed addresses will no longer be advertised in REACH_OUT frames.
Addresses not present in the set will be silently ignored.
-Sourcepub fn get_local_nat_traversal_addresses(
+
Sourcepub fn get_local_nat_traversal_addresses(
&self,
) -> Result<Vec<SocketAddr>, Error>
Get the current local nat traversal addresses
-Sourcepub fn get_remote_nat_traversal_addresses(
+
Sourcepub fn get_remote_nat_traversal_addresses(
&self,
) -> Result<Vec<SocketAddr>, Error>
Get the currently advertised nat traversal addresses by the server
-Sourcepub fn initiate_nat_traversal_round(&self) -> Result<Vec<SocketAddr>, Error>
Initiates a new nat traversal round
+Sourcepub fn initiate_nat_traversal_round(&self) -> Result<Vec<SocketAddr>, Error>
Initiates a new nat traversal round
A nat traversal round involves advertising the client’s local addresses in REACH_OUT
frames, and initiating probing of the known remote addresses. When a new round is
initiated, the previous one is cancelled, and paths that have not been opened are closed.
Returns the server addresses that are now being probed.
-Trait Implementations§
Source§impl Clone for Connection
Source§fn clone(&self) -> Connection
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 Connection
§impl RefUnwindSafe for Connection
§impl Send for Connection
§impl Sync for Connection
§impl Unpin for Connection
§impl UnwindSafe for Connection
Blanket Implementations§
Trait Implementations§
Source§impl Clone for Connection
Source§fn clone(&self) -> Connection
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 Connection
§impl RefUnwindSafe for Connection
§impl Send for Connection
§impl Sync for Connection
§impl Unpin for Connection
§impl UnwindSafe for Connection
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/617/docs/noq/struct.EndpointConfig.html b/pr/617/docs/noq/struct.EndpointConfig.html
index 5db8f93f3..e8d394ce3 100644
--- a/pr/617/docs/noq/struct.EndpointConfig.html
+++ b/pr/617/docs/noq/struct.EndpointConfig.html
@@ -1,7 +1,7 @@
-EndpointConfig in noq - Rust EndpointConfig
pub struct EndpointConfig { /* private fields */ }
Expand description
Global configuration for the endpoint, affecting all connections
+EndpointConfig in noq - Rust EndpointConfig
pub struct EndpointConfig { /* private fields */ }
Expand description
Global configuration for the endpoint, affecting all connections
Default values should be suitable for most internet applications.
-Implementations§
Source§impl EndpointConfig
Sourcepub fn new(reset_key: Arc<dyn HmacKey>) -> EndpointConfig
Create a default config with a particular reset_key
-Sourcepub fn cid_generator(
+
Implementations§
Source§impl EndpointConfig
Sourcepub fn new(reset_key: Arc<dyn HmacKey>) -> EndpointConfig
Create a default config with a particular reset_key
+Sourcepub fn cid_generator(
&mut self,
factory: Arc<dyn Fn() -> Box<dyn ConnectionIdGenerator> + Send + Sync>,
) -> &mut EndpointConfig
Supply a custom connection ID generator factory
@@ -10,9 +10,9 @@ generator which will be used to generate the CIDs used for incoming packets on a
connections involving that Endpoint. A custom CID generator allows applications to embed
information in local connection IDs, e.g. to support stateless packet-level load balancers.
Defaults to HashedConnectionIdGenerator.
-Sourcepub fn reset_key(&mut self, key: Arc<dyn HmacKey>) -> &mut EndpointConfig
Private key used to send authenticated connection resets to peers who were
+
Sourcepub fn reset_key(&mut self, key: Arc<dyn HmacKey>) -> &mut EndpointConfig
Private key used to send authenticated connection resets to peers who were
communicating with a previous instance of this endpoint.
-Sourcepub fn max_udp_payload_size(
+
Sourcepub fn max_udp_payload_size(
&mut self,
value: u16,
) -> Result<&mut EndpointConfig, ConfigError>
Maximum UDP payload size accepted from peers (excluding UDP and IP overhead).
@@ -21,27 +21,27 @@ communicating with a previous instance of this endpoint.
1500 byte Ethernet MTU. Deployments on links with larger MTUs (e.g. loopback or Ethernet
with jumbo frames) can raise this to improve performance at the cost of a linear increase in
datagram receive buffer size.
-Sourcepub fn get_max_udp_payload_size(&self) -> u64
Get the current value of max_udp_payload_size
-Sourcepub fn supported_versions(
+
Sourcepub fn get_max_udp_payload_size(&self) -> u64
Get the current value of max_udp_payload_size
+Sourcepub fn supported_versions(
&mut self,
supported_versions: Vec<u32>,
) -> &mut EndpointConfig
Override supported QUIC versions
-Sourcepub fn grease_quic_bit(&mut self, value: bool) -> &mut EndpointConfig
Whether to accept QUIC packets containing any value for the fixed bit
+Sourcepub fn grease_quic_bit(&mut self, value: bool) -> &mut EndpointConfig
Whether to accept QUIC packets containing any value for the fixed bit
Enabled by default. Helps protect against protocol ossification and makes traffic less
identifiable to observers. Disable if helping observers identify this traffic as QUIC is
desired.
-Sourcepub fn min_reset_interval(&mut self, value: Duration) -> &mut EndpointConfig
Minimum interval between outgoing stateless reset packets
+Sourcepub fn min_reset_interval(&mut self, value: Duration) -> &mut EndpointConfig
Minimum interval between outgoing stateless reset packets
Defaults to 20ms. Limits the impact of attacks which flood an endpoint with garbage packets,
e.g. ISAKMP/IKE amplification. Larger values provide a stronger defense, but may delay
detection of some error conditions by clients. Using a ConnectionIdGenerator with a low
rate of false positives in validate reduces the risk
incurred by a small minimum reset interval.
-Sourcepub fn rng_seed(&mut self, seed: Option<[u8; 32]>) -> &mut EndpointConfig
Optional seed to be used internally for random number generation
+Sourcepub fn rng_seed(&mut self, seed: Option<[u8; 32]>) -> &mut EndpointConfig
Optional seed to be used internally for random number generation
By default, noq will initialize an endpoint’s rng using a platform entropy source.
However, you can seed the rng yourself through this method (e.g. if you need to run noq
deterministically or if you are using noq in an environment that doesn’t have a source of
entropy available).
-Trait Implementations§
Source§impl Clone for EndpointConfig
Source§fn clone(&self) -> EndpointConfig
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 EndpointConfig
Source§impl Default for EndpointConfig
Source§fn default() -> EndpointConfig
Returns the “default value” for a type. Read moreAuto Trait Implementations§
§impl Freeze for EndpointConfig
§impl !RefUnwindSafe for EndpointConfig
§impl Send for EndpointConfig
§impl Sync for EndpointConfig
§impl Unpin for EndpointConfig
§impl !UnwindSafe for EndpointConfig
Blanket Implementations§
Trait Implementations§
Source§impl Clone for EndpointConfig
Source§fn clone(&self) -> EndpointConfig
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 EndpointConfig
Source§impl Default for EndpointConfig
Source§fn default() -> EndpointConfig
Returns the “default value” for a type. Read moreAuto Trait Implementations§
§impl Freeze for EndpointConfig
§impl !RefUnwindSafe for EndpointConfig
§impl Send for EndpointConfig
§impl Sync for EndpointConfig
§impl Unpin for EndpointConfig
§impl !UnwindSafe for EndpointConfig
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/617/docs/noq/struct.IdleTimeout.html b/pr/617/docs/noq/struct.IdleTimeout.html
index ace1e130b..7a08b236d 100644
--- a/pr/617/docs/noq/struct.IdleTimeout.html
+++ b/pr/617/docs/noq/struct.IdleTimeout.html
@@ -1,4 +1,4 @@
-IdleTimeout in noq - Rust IdleTimeout
pub struct IdleTimeout(/* private fields */);
Expand description
Maximum duration of inactivity to accept before timing out the connection
+IdleTimeout in noq - Rust IdleTimeout
pub struct IdleTimeout(/* private fields */);
Expand description
Maximum duration of inactivity to accept before timing out the connection
This wraps an underlying VarInt, representing the duration in milliseconds. Values can be
constructed by converting directly from VarInt, or using TryFrom<Duration>.
@@ -6,19 +6,19 @@ constructed by converting directly from VarInt, or using TryF
let timeout = IdleTimeout::from(VarInt::from_u32(10_000));
// Try to convert a `Duration` into a `VarInt`-encoded timeout
-let timeout = IdleTimeout::try_from(Duration::from_secs(10))?;Trait Implementations§
Source§impl Clone for IdleTimeout
Source§fn clone(&self) -> IdleTimeout
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 IdleTimeout
Source§impl Default for IdleTimeout
Source§fn default() -> IdleTimeout
Returns the “default value” for a type. Read moreSource§impl From<VarInt> for IdleTimeout
Source§fn from(inner: VarInt) -> IdleTimeout
Converts to this type from the input type.Source§impl Hash for IdleTimeout
Trait Implementations§
Source§impl Clone for IdleTimeout
Source§fn clone(&self) -> IdleTimeout
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 IdleTimeout
Source§impl Default for IdleTimeout
Source§fn default() -> IdleTimeout
Returns the “default value” for a type. Read moreSource§impl From<VarInt> for IdleTimeout
Source§fn from(inner: VarInt) -> IdleTimeout
Converts to this type from the input type.Source§impl Hash for IdleTimeout
Source§impl Ord for IdleTimeout
Source§impl Ord for IdleTimeout
Source§fn cmp(&self, other: &IdleTimeout) -> Ordering
1.21.0 · Source§fn max(self, other: Self) -> Selfwhere
Self: Sized,
Compares and returns the maximum of two values. Read moreSource§impl PartialEq for IdleTimeout
Source§impl PartialOrd for IdleTimeout
Source§impl PartialEq for IdleTimeout
Source§impl TryFrom<Duration> for IdleTimeout
Source§type Error = VarIntBoundsExceeded
The type returned in the event of a conversion error.Source§fn try_from(
timeout: Duration,
-) -> Result<IdleTimeout, <IdleTimeout as TryFrom<Duration>>::Error>
Performs the conversion.Source§impl Copy for IdleTimeout
Source§impl Eq for IdleTimeout
Source§impl StructuralPartialEq for IdleTimeout
Auto Trait Implementations§
§impl Freeze for IdleTimeout
§impl RefUnwindSafe for IdleTimeout
§impl Send for IdleTimeout
§impl Sync for IdleTimeout
§impl Unpin for IdleTimeout
§impl UnwindSafe for IdleTimeout
Blanket Implementations§
Source§impl Copy for IdleTimeout
Source§impl Eq for IdleTimeout
Source§impl StructuralPartialEq for IdleTimeout
Auto Trait Implementations§
§impl Freeze for IdleTimeout
§impl RefUnwindSafe for IdleTimeout
§impl Send for IdleTimeout
§impl Sync for IdleTimeout
§impl Unpin for IdleTimeout
§impl UnwindSafe for IdleTimeout
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/617/docs/noq/struct.MtuDiscoveryConfig.html b/pr/617/docs/noq/struct.MtuDiscoveryConfig.html
index 07fb6950d..648670fe2 100644
--- a/pr/617/docs/noq/struct.MtuDiscoveryConfig.html
+++ b/pr/617/docs/noq/struct.MtuDiscoveryConfig.html
@@ -1,4 +1,4 @@
-MtuDiscoveryConfig in noq - Rust MtuDiscoveryConfig
pub struct MtuDiscoveryConfig { /* private fields */ }
Expand description
Parameters governing MTU discovery.
+MtuDiscoveryConfig in noq - Rust