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/523/docs/noq/enum.SendDatagramError.html b/pr/523/docs/noq/enum.SendDatagramError.html
index df673eb04..4b8a4e090 100644
--- a/pr/523/docs/noq/enum.SendDatagramError.html
+++ b/pr/523/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/523/docs/noq/enum.StoppedError.html b/pr/523/docs/noq/enum.StoppedError.html
index 3b546f354..db56529df 100644
--- a/pr/523/docs/noq/enum.StoppedError.html
+++ b/pr/523/docs/noq/enum.StoppedError.html
@@ -1,4 +1,4 @@
-StoppedError in noq - Rust StoppedError
pub enum StoppedError {
+StoppedError in noq - Rust StoppedError
pub enum StoppedError {
ConnectionLost(ConnectionError),
ZeroRttRejected,
}
Expand description
Errors that arise while monitoring for a send stream stop from the peer
@@ -6,8 +6,8 @@
§ZeroRttRejected
This was a 0-RTT stream and the server rejected it
Can only occur on clients for 0-RTT streams, which can be opened using
Connecting::into_0rtt().
-Trait Implementations§
Source§impl Clone for StoppedError
Source§fn clone(&self) -> StoppedError
Returns a duplicate of the value. Read more1.0.0 · Source§fn clone_from(&mut self, source: &Self)
Performs copy-assignment from source. Read moreSource§impl Debug for StoppedError
Source§impl Display for StoppedError
Source§impl Error for StoppedError
Source§fn source(&self) -> Option<&(dyn Error + 'static)>
Returns the lower-level source of this error, if any. Read more1.0.0 · Source§fn description(&self) -> &str
👎Deprecated since 1.42.0: use the Display impl or to_string()Source§impl From<ConnectionError> for StoppedError
Source§fn from(source: ConnectionError) -> Self
Converts to this type from the input type.Source§impl From<StoppedError> for Error
Source§fn from(x: StoppedError) -> Self
Converts to this type from the input type.Source§impl From<StoppedError> for WriteError
Source§fn from(x: StoppedError) -> Self
Converts to this type from the input type.Source§impl PartialEq for StoppedError
Source§impl Eq for StoppedError
Source§impl StructuralPartialEq for StoppedError
Auto Trait Implementations§
§impl !Freeze for StoppedError
§impl !RefUnwindSafe for StoppedError
§impl Send for StoppedError
§impl Sync for StoppedError
§impl Unpin for StoppedError
§impl !UnwindSafe for StoppedError
Blanket Implementations§
Trait Implementations§
Source§impl Clone for StoppedError
Source§fn clone(&self) -> StoppedError
Returns a duplicate of the value. Read more1.0.0 · Source§fn clone_from(&mut self, source: &Self)
Performs copy-assignment from source. Read moreSource§impl Debug for StoppedError
Source§impl Display for StoppedError
Source§impl Error for StoppedError
Source§fn source(&self) -> Option<&(dyn Error + 'static)>
Returns the lower-level source of this error, if any. Read more1.0.0 · Source§fn description(&self) -> &str
👎Deprecated since 1.42.0: use the Display impl or to_string()Source§impl From<ConnectionError> for StoppedError
Source§fn from(source: ConnectionError) -> Self
Converts to this type from the input type.Source§impl From<StoppedError> for Error
Source§fn from(x: StoppedError) -> Self
Converts to this type from the input type.Source§impl From<StoppedError> for WriteError
Source§fn from(x: StoppedError) -> Self
Converts to this type from the input type.Source§impl PartialEq for StoppedError
Source§impl Eq for StoppedError
Source§impl StructuralPartialEq for StoppedError
Auto Trait Implementations§
§impl !Freeze for StoppedError
§impl !RefUnwindSafe for StoppedError
§impl Send for StoppedError
§impl Sync for StoppedError
§impl Unpin for StoppedError
§impl !UnwindSafe for StoppedError
Blanket Implementations§
Source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
Source§fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read moreSource§impl<T> CloneToUninit for Twhere
diff --git a/pr/523/docs/noq/enum.WriteError.html b/pr/523/docs/noq/enum.WriteError.html
index d5a81ac6c..606752321 100644
--- a/pr/523/docs/noq/enum.WriteError.html
+++ b/pr/523/docs/noq/enum.WriteError.html
@@ -1,4 +1,4 @@
-WriteError in noq - Rust WriteError
pub enum WriteError {
+WriteError in noq - Rust WriteError
pub enum WriteError {
Stopped(VarInt),
ConnectionLost(ConnectionError),
ClosedStream,
@@ -11,8 +11,8 @@
§ZeroRttRejected
This was a 0-RTT stream and the server rejected it
Can only occur on clients for 0-RTT streams, which can be opened using
Connecting::into_0rtt().
-
Trait Implementations§
Source§impl Clone for WriteError
Source§fn clone(&self) -> WriteError
Returns a duplicate of the value. Read more1.0.0 · Source§fn clone_from(&mut self, source: &Self)
Performs copy-assignment from source. Read moreSource§impl Debug for WriteError
Source§impl Display for WriteError
Source§impl Error for WriteError
Source§fn source(&self) -> Option<&(dyn Error + 'static)>
Returns the lower-level source of this error, if any. Read more1.0.0 · Source§fn description(&self) -> &str
👎Deprecated since 1.42.0: use the Display impl or to_string()Source§impl From<ClosedStream> for WriteError
Source§fn from(_: ClosedStream) -> Self
Converts to this type from the input type.Source§impl From<ConnectionError> for WriteError
Source§fn from(source: ConnectionError) -> Self
Converts to this type from the input type.Source§impl From<StoppedError> for WriteError
Source§fn from(x: StoppedError) -> Self
Converts to this type from the input type.Source§impl From<WriteError> for Error
Source§fn from(x: WriteError) -> Self
Converts to this type from the input type.Source§impl PartialEq for WriteError
Source§impl Eq for WriteError
Source§impl StructuralPartialEq for WriteError
Auto Trait Implementations§
§impl !Freeze for WriteError
§impl !RefUnwindSafe for WriteError
§impl Send for WriteError
§impl Sync for WriteError
§impl Unpin for WriteError
§impl !UnwindSafe for WriteError
Blanket Implementations§
Trait Implementations§
Source§impl Clone for WriteError
Source§fn clone(&self) -> WriteError
Returns a duplicate of the value. Read more1.0.0 · Source§fn clone_from(&mut self, source: &Self)
Performs copy-assignment from source. Read moreSource§impl Debug for WriteError
Source§impl Display for WriteError
Source§impl Error for WriteError
Source§fn source(&self) -> Option<&(dyn Error + 'static)>
Returns the lower-level source of this error, if any. Read more1.0.0 · Source§fn description(&self) -> &str
👎Deprecated since 1.42.0: use the Display impl or to_string()Source§impl From<ClosedStream> for WriteError
Source§fn from(_: ClosedStream) -> Self
Converts to this type from the input type.Source§impl From<ConnectionError> for WriteError
Source§fn from(source: ConnectionError) -> Self
Converts to this type from the input type.Source§impl From<StoppedError> for WriteError
Source§fn from(x: StoppedError) -> Self
Converts to this type from the input type.Source§impl From<WriteError> for Error
Source§fn from(x: WriteError) -> Self
Converts to this type from the input type.Source§impl PartialEq for WriteError
Source§impl Eq for WriteError
Source§impl StructuralPartialEq for WriteError
Auto Trait Implementations§
§impl !Freeze for WriteError
§impl !RefUnwindSafe for WriteError
§impl Send for WriteError
§impl Sync for WriteError
§impl Unpin for WriteError
§impl !UnwindSafe for WriteError
Blanket Implementations§
Source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
Source§fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read moreSource§impl<T> CloneToUninit for Twhere
diff --git a/pr/523/docs/noq/struct.AcceptBi.html b/pr/523/docs/noq/struct.AcceptBi.html
index 2570d72c9..180bbe0f8 100644
--- a/pr/523/docs/noq/struct.AcceptBi.html
+++ b/pr/523/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/523/docs/noq/struct.AcceptUni.html b/pr/523/docs/noq/struct.AcceptUni.html
index 632021163..0e6b55eaa 100644
--- a/pr/523/docs/noq/struct.AcceptUni.html
+++ b/pr/523/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/523/docs/noq/struct.AddressDiscovery.html b/pr/523/docs/noq/struct.AddressDiscovery.html
index dbfb17648..f4b48f499 100644
--- a/pr/523/docs/noq/struct.AddressDiscovery.html
+++ b/pr/523/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/523/docs/noq/struct.ClosedStream.html b/pr/523/docs/noq/struct.ClosedStream.html
index 8eb864ca2..0453153c1 100644
--- a/pr/523/docs/noq/struct.ClosedStream.html
+++ b/pr/523/docs/noq/struct.ClosedStream.html
@@ -1,5 +1,5 @@
ClosedStream in noq - Rust ClosedStream
pub struct ClosedStream { /* private fields */ }
Expand description
Error indicating that a stream has not been opened or has already been finished or reset
-Trait Implementations§
Source§impl Clone for ClosedStream
Source§fn clone(&self) -> ClosedStream
Returns a duplicate of the value. Read more1.0.0 · Source§fn clone_from(&mut self, source: &Self)
Performs copy-assignment from source. Read moreSource§impl Debug for ClosedStream
Source§impl Default for ClosedStream
Source§fn default() -> ClosedStream
Returns the “default value” for a type. Read moreSource§impl Display for ClosedStream
Source§impl Error for ClosedStream
1.30.0 · Source§fn source(&self) -> Option<&(dyn Error + 'static)>
Returns the lower-level source of this error, if any. Read more1.0.0 · Source§fn description(&self) -> &str
👎Deprecated since 1.42.0: use the Display impl or to_string()Source§impl From<ClosedStream> for WriteError
Source§fn from(_: ClosedStream) -> Self
Converts to this type from the input type.Source§impl PartialEq for ClosedStream
Source§fn eq(&self, other: &ClosedStream) -> bool
Tests for self and other values to be equal, and is used by ==.1.0.0 · Source§fn ne(&self, other: &Rhs) -> bool
Tests for !=. The default implementation is almost always sufficient,
+Trait Implementations§
Source§impl Clone for ClosedStream
Source§fn clone(&self) -> ClosedStream
Returns a duplicate of the value. Read more1.0.0 · Source§fn clone_from(&mut self, source: &Self)
Performs copy-assignment from source. Read moreSource§impl Debug for ClosedStream
Source§impl Default for ClosedStream
Source§fn default() -> ClosedStream
Returns the “default value” for a type. Read moreSource§impl Display for ClosedStream
Source§impl Error for ClosedStream
1.30.0 · Source§fn source(&self) -> Option<&(dyn Error + 'static)>
Returns the lower-level source of this error, if any. Read more1.0.0 · Source§fn description(&self) -> &str
👎Deprecated since 1.42.0: use the Display impl or to_string()Source§impl From<ClosedStream> for WriteError
Source§fn from(_: ClosedStream) -> Self
Converts to this type from the input type.Source§impl PartialEq for ClosedStream
Source§impl Eq for ClosedStream
Source§impl StructuralPartialEq for ClosedStream
Auto Trait Implementations§
§impl Freeze for ClosedStream
§impl RefUnwindSafe for ClosedStream
§impl Send for ClosedStream
§impl Sync for ClosedStream
§impl Unpin for ClosedStream
§impl UnwindSafe for ClosedStream
Blanket Implementations§
Source§impl<T> BorrowMut<T> for Twhere
diff --git a/pr/523/docs/noq/struct.Connecting.html b/pr/523/docs/noq/struct.Connecting.html
index 313d9b851..347289200 100644
--- a/pr/523/docs/noq/struct.Connecting.html
+++ b/pr/523/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/523/docs/noq/struct.Connection.html b/pr/523/docs/noq/struct.Connection.html
index 29ab9265c..7a59936d7 100644
--- a/pr/523/docs/noq/struct.Connection.html
+++ b/pr/523/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,17 +45,17 @@ 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.
@@ -89,7 +89,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.
@@ -97,23 +97,23 @@ 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 side(&self) -> Side
The side of the connection (client or server)
@@ -132,21 +132,21 @@ supported platforms when using 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 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],
@@ -157,17 +157,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
@@ -175,7 +175,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
@@ -184,18 +184,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/523/docs/noq/struct.OnClosed.html b/pr/523/docs/noq/struct.OnClosed.html
index 614456536..530c1e14e 100644
--- a/pr/523/docs/noq/struct.OnClosed.html
+++ b/pr/523/docs/noq/struct.OnClosed.html
@@ -1,6 +1,6 @@
-OnClosed in noq - Rust OnClosed
pub struct OnClosed { /* private fields */ }
Expand description
Future returned by Connection::on_closed
+OnClosed in noq - Rust OnClosed
pub struct OnClosed { /* private fields */ }
Expand description
Future returned by Connection::on_closed
Resolves to a tuple of (ConnectionError, ConnectionStats).
-Trait Implementations§
Source§impl Future for OnClosed
Source§type Output = (ConnectionError, ConnectionStats)
The type of value produced on completion.Source§fn poll(self: Pin<&mut Self>, cx: &mut Context<'_>) -> Poll<Self::Output>
Attempts to resolve the future to a final value, registering
+Trait Implementations§
Source§impl Future for OnClosed
Source§type Output = (ConnectionError, ConnectionStats)
The type of value produced on completion.Auto Trait Implementations§
§impl Freeze for OnClosed
§impl !RefUnwindSafe for OnClosed
§impl Send for OnClosed
§impl Sync for OnClosed
§impl Unpin for OnClosed
§impl !UnwindSafe for OnClosed
Blanket Implementations§
Source§impl<T> BorrowMut<T> for Twhere
diff --git a/pr/523/docs/noq/struct.OpenBi.html b/pr/523/docs/noq/struct.OpenBi.html
index 4ea882cc9..c878e5abb 100644
--- a/pr/523/docs/noq/struct.OpenBi.html
+++ b/pr/523/docs/noq/struct.OpenBi.html
@@ -1,6 +1,6 @@
-OpenBi in noq - Rust OpenBi
pub struct OpenBi<'a> { /* private fields */ }
Expand description
Future produced by Connection::open_bi
-Trait Implementations§
Source§impl Future for OpenBi<'_>
Source§type Output = Result<(SendStream, RecvStream), ConnectionError>
The type of value produced on completion.Source§impl<'__pin, 'a> Unpin for OpenBi<'a>where
+OpenBi in noq - Rust OpenBi
pub struct OpenBi<'a> { /* private fields */ }
Expand description
Future produced by Connection::open_bi
+Trait Implementations§
Source§impl Future for OpenBi<'_>
Source§type Output = Result<(SendStream, RecvStream), ConnectionError>
The type of value produced on completion.Source§impl<'__pin, 'a> Unpin for OpenBi<'a>where
PinnedFieldsOf<__Origin<'__pin, 'a>>: Unpin,
Auto Trait Implementations§
§impl<'a> !Freeze for OpenBi<'a>
§impl<'a> !RefUnwindSafe for OpenBi<'a>
§impl<'a> Send for OpenBi<'a>
§impl<'a> Sync for OpenBi<'a>
§impl<'a> !UnwindSafe for OpenBi<'a>
Blanket Implementations§
Source§impl<T> BorrowMut<T> for Twhere
diff --git a/pr/523/docs/noq/struct.OpenUni.html b/pr/523/docs/noq/struct.OpenUni.html
index 847004010..dbe517c1f 100644
--- a/pr/523/docs/noq/struct.OpenUni.html
+++ b/pr/523/docs/noq/struct.OpenUni.html
@@ -1,6 +1,6 @@
-OpenUni in noq - Rust OpenUni
pub struct OpenUni<'a> { /* private fields */ }
Expand description
Future produced by Connection::open_uni
-Trait Implementations§
Source§impl Future for OpenUni<'_>
Source§type Output = Result<SendStream, ConnectionError>
The type of value produced on completion.Source§impl<'__pin, 'a> Unpin for OpenUni<'a>where
+OpenUni in noq - Rust OpenUni
pub struct OpenUni<'a> { /* private fields */ }
Expand description
Future produced by Connection::open_uni
+Trait Implementations§
Source§impl Future for OpenUni<'_>
Source§type Output = Result<SendStream, ConnectionError>
The type of value produced on completion.Source§impl<'__pin, 'a> Unpin for OpenUni<'a>where
PinnedFieldsOf<__Origin<'__pin, 'a>>: Unpin,
Auto Trait Implementations§
§impl<'a> !Freeze for OpenUni<'a>
§impl<'a> !RefUnwindSafe for OpenUni<'a>
§impl<'a> Send for OpenUni<'a>
§impl<'a> Sync for OpenUni<'a>
§impl<'a> !UnwindSafe for OpenUni<'a>
Blanket Implementations§
Source§impl<T> BorrowMut<T> for Twhere
diff --git a/pr/523/docs/noq/struct.Path.html b/pr/523/docs/noq/struct.Path.html
index 91812028a..d96867826 100644
--- a/pr/523/docs/noq/struct.Path.html
+++ b/pr/523/docs/noq/struct.Path.html
@@ -1,35 +1,35 @@
Path in noq - Rust Path
pub struct Path { /* private fields */ }
Expand description
An open network transmission within a multipath-enabled connection.
As long as a Path or WeakPathHandle is alive, it is ensured that the
PathStats for this path are not dropped even after the path is abandoned.
-Implementations§
Source§impl Path
Sourcepub fn weak_handle(&self) -> WeakPathHandle
Returns a WeakPathHandle for this path.
+Implementations§
Source§impl Path
Sourcepub fn weak_handle(&self) -> WeakPathHandle
Returns a WeakPathHandle for this path.
Holding a WeakPathHandle does not keep a connection alive, but ensures that the
path’s stats are not dropped until the underlying connection is dropped, even if the
path is abandoned.
-Sourcepub fn status(&self) -> Result<PathStatus, ClosedPath>
The current local PathStatus of this path.
-Sourcepub fn set_status(&self, status: PathStatus) -> Result<(), SetPathStatusError>
Sets the PathStatus of this path.
-Sourcepub fn close(&self) -> Result<(), ClosePathError>
Closes this path.
+Sourcepub fn status(&self) -> Result<PathStatus, ClosedPath>
The current local PathStatus of this path.
+Sourcepub fn set_status(&self, status: PathStatus) -> Result<(), SetPathStatusError>
Sets the PathStatus of this path.
+Sourcepub fn close(&self) -> Result<(), ClosePathError>
Closes this path.
The path is immediately considered closed by the local endpoint. Once the state is removed,
after a short period of time for any in-flight packets, a PathEvent::Abandoned is
returned.
-Sourcepub fn set_max_idle_timeout(
+
Sourcepub fn set_max_idle_timeout(
&self,
timeout: Option<Duration>,
) -> Result<Option<Duration>, ClosedPath>
Sets the keep_alive_interval for a specific path
See TransportConfig::default_path_keep_alive_interval for details.
Returns the previous value of the setting.
-Sourcepub fn set_keep_alive_interval(
+
Sourcepub fn set_keep_alive_interval(
&self,
interval: Option<Duration>,
) -> Result<Option<Duration>, ClosedPath>
Sets the keep_alive_interval for a specific path
See TransportConfig::default_path_keep_alive_interval for details.
Returns the previous value of the setting.
-Sourcepub fn observed_external_addr(&self) -> Result<AddressDiscovery, ClosedPath>
Track changes on our external address as reported by the peer.
+Sourcepub fn observed_external_addr(&self) -> Result<AddressDiscovery, ClosedPath>
Track changes on our external address as reported by the peer.
If the address-discovery extension is not negotiated, the stream will never return.
-Sourcepub fn remote_address(&self) -> Result<SocketAddr, ClosedPath>
The peer’s UDP address for this path.
-Sourcepub fn ping(&self) -> Result<(), ClosedPath>
Ping the remote endpoint over this path.
-Trait Implementations§
Source§impl PartialEq for Path
Source§fn eq(&self, other: &Self) -> bool
Tests for self and other values to be equal, and is used by ==.1.0.0 · Source§fn ne(&self, other: &Rhs) -> bool
Tests for !=. The default implementation is almost always sufficient,
+Sourcepub fn remote_address(&self) -> Result<SocketAddr, ClosedPath>
The peer’s UDP address for this path.
+Sourcepub fn ping(&self) -> Result<(), ClosedPath>
Ping the remote endpoint over this path.
+Trait Implementations§
Auto Trait Implementations§
§impl Freeze for Path
§impl RefUnwindSafe for Path
§impl Send for Path
§impl Sync for Path
§impl Unpin for Path
§impl UnwindSafe for Path
Blanket Implementations§
Source§impl<T> BorrowMut<T> for Twhere
diff --git a/pr/523/docs/noq/struct.ReadDatagram.html b/pr/523/docs/noq/struct.ReadDatagram.html
index 751453f7e..cac5d37c3 100644
--- a/pr/523/docs/noq/struct.ReadDatagram.html
+++ b/pr/523/docs/noq/struct.ReadDatagram.html
@@ -1,6 +1,6 @@
-ReadDatagram in noq - Rust ReadDatagram
pub struct ReadDatagram<'a> { /* private fields */ }
Expand description
Future produced by Connection::read_datagram
-Trait Implementations§
Source§impl Future for ReadDatagram<'_>
Source§type Output = Result<Bytes, ConnectionError>
The type of value produced on completion.Source§impl<'__pin, 'a> Unpin for ReadDatagram<'a>where
+ReadDatagram in noq - Rust ReadDatagram
pub struct ReadDatagram<'a> { /* private fields */ }
Expand description
Future produced by Connection::read_datagram
+Trait Implementations§
Source§impl Future for ReadDatagram<'_>
Source§type Output = Result<Bytes, ConnectionError>
The type of value produced on completion.Source§impl<'__pin, 'a> Unpin for ReadDatagram<'a>where
PinnedFieldsOf<__Origin<'__pin, 'a>>: Unpin,
Auto Trait Implementations§
§impl<'a> !Freeze for ReadDatagram<'a>
§impl<'a> !RefUnwindSafe for ReadDatagram<'a>
§impl<'a> Send for ReadDatagram<'a>
§impl<'a> Sync for ReadDatagram<'a>
§impl<'a> !UnwindSafe for ReadDatagram<'a>
Blanket Implementations§
Source§impl<T> BorrowMut<T> for Twhere
diff --git a/pr/523/docs/noq/struct.SendDatagram.html b/pr/523/docs/noq/struct.SendDatagram.html
index ba07ce89e..04c0cba2f 100644
--- a/pr/523/docs/noq/struct.SendDatagram.html
+++ b/pr/523/docs/noq/struct.SendDatagram.html
@@ -1,6 +1,6 @@
-SendDatagram in noq - Rust SendDatagram
pub struct SendDatagram<'a> { /* private fields */ }
Expand description
Future produced by Connection::send_datagram_wait
-Trait Implementations§
Source§impl Future for SendDatagram<'_>
Source§impl<'__pin, 'a> Unpin for SendDatagram<'a>where
+SendDatagram in noq - Rust SendDatagram
pub struct SendDatagram<'a> { /* private fields */ }
Expand description
Future produced by Connection::send_datagram_wait
+Trait Implementations§
Source§impl Future for SendDatagram<'_>
Source§impl<'__pin, 'a> Unpin for SendDatagram<'a>where
PinnedFieldsOf<__Origin<'__pin, 'a>>: Unpin,
Auto Trait Implementations§
§impl<'a> !Freeze for SendDatagram<'a>
§impl<'a> !RefUnwindSafe for SendDatagram<'a>
§impl<'a> Send for SendDatagram<'a>
§impl<'a> Sync for SendDatagram<'a>
§impl<'a> !UnwindSafe for SendDatagram<'a>
Blanket Implementations§
Source§impl<T> BorrowMut<T> for Twhere
diff --git a/pr/523/docs/noq/struct.SendStream.html b/pr/523/docs/noq/struct.SendStream.html
index 540865dff..b6a413534 100644
--- a/pr/523/docs/noq/struct.SendStream.html
+++ b/pr/523/docs/noq/struct.SendStream.html
@@ -8,7 +8,7 @@ ready will always result in no data being written to the stream. This is true of
succeed immediately when any progress is made, and is not true of methods which might need to
perform multiple writes internally before succeeding. Each write method documents whether it is
cancel-safe.
-
Implementations§
Source§impl SendStream
Sourcepub async fn write(&mut self, buf: &[u8]) -> Result<usize, WriteError>
Write a buffer into this stream, returning how many bytes were written
+Implementations§
Source§impl SendStream
Sourcepub async fn write(&mut self, buf: &[u8]) -> Result<usize, WriteError>
Write a buffer into this stream, returning how many bytes were written
Unless this method errors, it waits until some amount of buf can be written into this
stream, and then writes as much as it can without waiting again. Due to congestion and flow
control, this may be shorter than buf.len(). On success this yields the length of the
@@ -58,7 +58,7 @@ or an error occurs. This method mutates bufs by mutating all chunks
§Cancel safety
This method is not cancellation safe. Even if this does not resolve, some bytes may have
been written when previously polled.
-Sourcepub fn finish(&mut self) -> Result<(), ClosedStream>
Notify the peer that no more data will ever be written to this stream
+Sourcepub fn finish(&mut self) -> Result<(), ClosedStream>
Notify the peer that no more data will ever be written to this stream
It is an error to write to a SendStream after finish()ing it. reset()
may still be called after finish to abandon transmission of any stream data that might
still be buffered.
@@ -66,21 +66,21 @@ still be buffered.
May fail if finish() or reset() was previously
called. This error is harmless and serves only to indicate that the caller may have
incorrect assumptions about the stream’s state.
-Sourcepub fn reset(&mut self, error_code: VarInt) -> Result<(), ClosedStream>
Close the send stream immediately.
+Sourcepub fn reset(&mut self, error_code: VarInt) -> Result<(), ClosedStream>
Close the send stream immediately.
No new data can be written after calling this method. Locally buffered data is dropped, and
previously transmitted data will no longer be retransmitted if lost. If an attempt has
already been made to finish the stream, the peer may still receive all written data.
May fail if finish() or reset() was previously
called. This error is harmless and serves only to indicate that the caller may have
incorrect assumptions about the stream’s state.
-Sourcepub fn set_priority(&self, priority: i32) -> Result<(), ClosedStream>
Set the priority of the send stream
+Sourcepub fn set_priority(&self, priority: i32) -> Result<(), ClosedStream>
Set the priority of the send stream
Every send stream has an initial priority of 0. Locally buffered data from streams with
higher priority will be transmitted before data from streams with lower priority. Changing
the priority of a stream with pending data may only take effect after that data has been
transmitted. Using many different priority levels per connection may have a negative
impact on performance.
-Sourcepub fn priority(&self) -> Result<i32, ClosedStream>
Get the priority of the send stream
-Sourcepub fn stopped(&self) -> Stopped ⓘ
Completes when the peer stops the stream or reads the stream to completion
+Sourcepub fn priority(&self) -> Result<i32, ClosedStream>
Get the priority of the send stream
+Sourcepub fn stopped(&self) -> Stopped ⓘ
Completes when the peer stops the stream or reads the stream to completion
Yields Some with the stop error code if the peer stops the stream. Yields None if the
local side finish()es the stream and then the peer acknowledges receipt
of all stream data (although not necessarily the processing of it), after which the peer
@@ -88,8 +88,8 @@ closing the stream is no longer meaningful.
For a variety of reasons, the peer may not send acknowledgements immediately upon receiving
data. As such, relying on stopped to know when the peer has read a stream to completion
may introduce more latency than using an application-level response of some sort.
-Sourcepub fn poll_write(
+
Sourcepub fn poll_write(
self: Pin<&mut Self>,
cx: &mut Context<'_>,
buf: &[u8],
@@ -98,22 +98,22 @@ may introduce more latency than using an application-level response of some sort
If the stream is not ready for writing, the method returns Poll::Pending and arranges
for the current task (via cx.waker().wake_by_ref()) to receive a notification when the
stream becomes writable or is closed.
-
Trait Implementations§
Source§impl AsyncWrite for SendStream
Available on crate feature futures-io only.
Source§fn poll_write(
+
Trait Implementations§
Source§impl AsyncWrite for SendStream
Available on crate feature futures-io only.
Source§fn poll_write(
self: Pin<&mut Self>,
cx: &mut Context<'_>,
buf: &[u8],
-) -> Poll<Result<usize>>
Attempt to write bytes from buf into the object. Read moreSource§fn poll_flush(self: Pin<&mut Self>, _cx: &mut Context<'_>) -> Poll<Result<()>>
Attempt to flush the object, ensuring that any buffered data reach
-their destination. Read moreSource§fn poll_close(self: Pin<&mut Self>, _cx: &mut Context<'_>) -> Poll<Result<()>>
Attempt to close the object. Read more§fn poll_write_vectored(
+) -> Poll<Result<usize>>
Attempt to write bytes from buf into the object. Read moreSource§fn poll_flush(self: Pin<&mut Self>, _cx: &mut Context<'_>) -> Poll<Result<()>>
Attempt to flush the object, ensuring that any buffered data reach
+their destination. Read moreSource§impl AsyncWrite for SendStream
Source§fn poll_write(
+IO operations. Read more
Source§impl AsyncWrite for SendStream
Source§fn poll_write(
self: Pin<&mut Self>,
cx: &mut Context<'_>,
buf: &[u8],
-) -> Poll<Result<usize>>
Attempt to write bytes from buf into the object. Read moreSource§fn poll_flush(self: Pin<&mut Self>, _cx: &mut Context<'_>) -> Poll<Result<()>>
Attempts to flush the object, ensuring that any buffered data reach
-their destination. Read moreSource§fn poll_shutdown(
+) -> Poll<Result<usize>>
Attempt to write bytes from buf into the object. Read moreSource§fn poll_flush(self: Pin<&mut Self>, _cx: &mut Context<'_>) -> Poll<Result<()>>
Attempts to flush the object, ensuring that any buffered data reach
+their destination. Read moreSource§fn poll_shutdown(
self: Pin<&mut Self>,
_cx: &mut Context<'_>,
) -> Poll<Result<()>>
Initiates or attempts to shut down this writer, returning success when
@@ -122,7 +122,7 @@ the I/O connection has completely shut down. Read moreContext<'_>,
bufs: &[IoSlice<'_>],
) -> Poll<Result<usize, Error>>Like poll_write, except that it writes from a slice of buffers. Read more§fn is_write_vectored(&self) -> bool
Determines if this writer has an efficient poll_write_vectored
-implementation. Read more Source§impl Debug for SendStream
Auto Trait Implementations§
§impl Freeze for SendStream
§impl RefUnwindSafe for SendStream
§impl Send for SendStream
§impl Sync for SendStream
§impl Unpin for SendStream
§impl UnwindSafe for SendStream
Blanket Implementations§
Source§impl Debug for SendStream
Auto Trait Implementations§
§impl Freeze for SendStream
§impl RefUnwindSafe for SendStream
§impl Send for SendStream
§impl Sync for SendStream
§impl Unpin for SendStream
§impl UnwindSafe for SendStream
Blanket Implementations§
§impl<W> AsyncWriteExt for Wwhere
W: AsyncWrite + ?Sized,
§fn write<'a>(&'a mut self, src: &'a [u8]) -> Write<'a, Self>where
Self: Unpin,
Writes a buffer into this writer, returning how many bytes were
diff --git a/pr/523/docs/noq/struct.Stopped.html b/pr/523/docs/noq/struct.Stopped.html
index a90b38c9f..4bb4f74f6 100644
--- a/pr/523/docs/noq/struct.Stopped.html
+++ b/pr/523/docs/noq/struct.Stopped.html
@@ -1,6 +1,6 @@
-Stopped in noq - Rust Stopped
pub struct Stopped { /* private fields */ }
Expand description
Future returned from SendStream::stopped.
-Trait Implementations§
Source§impl<'__pin> Unpin for Stoppedwhere
+Stopped in noq - Rust Stopped
pub struct Stopped { /* private fields */ }
Expand description
Future returned from SendStream::stopped.
+Trait Implementations§
Source§impl<'__pin> Unpin for Stoppedwhere
PinnedFieldsOf<__Origin<'__pin>>: Unpin,
Auto Trait Implementations§
§impl !Freeze for Stopped
§impl !RefUnwindSafe for Stopped
§impl Send for Stopped
§impl Sync for Stopped
§impl !UnwindSafe for Stopped
Blanket Implementations§
Source§impl<T> BorrowMut<T> for Twhere
diff --git a/pr/523/docs/noq/struct.WeakConnectionHandle.html b/pr/523/docs/noq/struct.WeakConnectionHandle.html
index 2b8536424..68daf3016 100644
--- a/pr/523/docs/noq/struct.WeakConnectionHandle.html
+++ b/pr/523/docs/noq/struct.WeakConnectionHandle.html
@@ -1,10 +1,10 @@
-WeakConnectionHandle in noq - Rust WeakConnectionHandle
pub struct WeakConnectionHandle(/* private fields */);
Expand description
A handle to some connection internals, use with care.
+WeakConnectionHandle in noq - Rust WeakConnectionHandle
pub struct WeakConnectionHandle(/* private fields */);
Expand description
A handle to some connection internals, use with care.
This contains a weak reference to the connection so will not itself keep the connection
alive.
-Implementations§
Source§impl WeakConnectionHandle
Sourcepub fn is_alive(&self) -> bool
Returns true if the Connection associated with this handle is still alive.
-Sourcepub fn upgrade(&self) -> Option<Connection>
Upgrade the handle to a full Connection
-Sourcepub fn is_same_connection(&self, other: &Self) -> bool
Returns true if the two WeakConnectionHandle point at the same connection.
-Trait Implementations§
Source§impl Clone for WeakConnectionHandle
Source§fn clone(&self) -> WeakConnectionHandle
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 WeakConnectionHandle
§impl RefUnwindSafe for WeakConnectionHandle
§impl Send for WeakConnectionHandle
§impl Sync for WeakConnectionHandle
§impl Unpin for WeakConnectionHandle
§impl UnwindSafe for WeakConnectionHandle
Blanket Implementations§
Implementations§
Source§impl WeakConnectionHandle
Sourcepub fn is_alive(&self) -> bool
Returns true if the Connection associated with this handle is still alive.
+Sourcepub fn upgrade(&self) -> Option<Connection>
Upgrade the handle to a full Connection
+Sourcepub fn is_same_connection(&self, other: &Self) -> bool
Returns true if the two WeakConnectionHandle point at the same connection.
+Trait Implementations§
Source§impl Clone for WeakConnectionHandle
Source§fn clone(&self) -> WeakConnectionHandle
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 WeakConnectionHandle
§impl RefUnwindSafe for WeakConnectionHandle
§impl Send for WeakConnectionHandle
§impl Sync for WeakConnectionHandle
§impl Unpin for WeakConnectionHandle
§impl UnwindSafe for WeakConnectionHandle
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/523/docs/noq/struct.WeakPathHandle.html b/pr/523/docs/noq/struct.WeakPathHandle.html
index 6132c023c..d7a9ad9a1 100644
--- a/pr/523/docs/noq/struct.WeakPathHandle.html
+++ b/pr/523/docs/noq/struct.WeakPathHandle.html
@@ -1,12 +1,12 @@
-WeakPathHandle in noq - Rust WeakPathHandle
pub struct WeakPathHandle { /* private fields */ }
Expand description
Weak handle for a Path that does not keep the connection alive.
+WeakPathHandle in noq - Rust WeakPathHandle
pub struct WeakPathHandle { /* private fields */ }
Expand description
Weak handle for a Path that does not keep the connection alive.
As long as a WeakPathHandle for a path exists, that path’s final stats will not be dropped even if
the path was abandoned.
The WeakPathHandle can be upgraded to a Path as long as its Connection has not been dropped.
-Implementations§
Source§impl WeakPathHandle
Implementations§
Trait Implementations§
Source§impl Clone for WeakPathHandle
Source§impl Debug for WeakPathHandle
Source§impl Drop for WeakPathHandle
Source§impl PartialEq for WeakPathHandle
Source§impl Eq for WeakPathHandle
Auto Trait Implementations§
§impl Freeze for WeakPathHandle
§impl RefUnwindSafe for WeakPathHandle
§impl Send for WeakPathHandle
§impl Sync for WeakPathHandle
§impl Unpin for WeakPathHandle
§impl UnwindSafe for WeakPathHandle
Blanket Implementations§
Trait Implementations§
Source§impl Clone for WeakPathHandle
Source§impl Debug for WeakPathHandle
Source§impl Drop for WeakPathHandle
Source§impl PartialEq for WeakPathHandle
Source§impl Eq for WeakPathHandle
Auto Trait Implementations§
§impl Freeze for WeakPathHandle
§impl RefUnwindSafe for WeakPathHandle
§impl Send for WeakPathHandle
§impl Sync for WeakPathHandle
§impl Unpin for WeakPathHandle
§impl UnwindSafe for WeakPathHandle
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/523/docs/noq/struct.ZeroRttAccepted.html b/pr/523/docs/noq/struct.ZeroRttAccepted.html
index f22efa639..1849df0f8 100644
--- a/pr/523/docs/noq/struct.ZeroRttAccepted.html
+++ b/pr/523/docs/noq/struct.ZeroRttAccepted.html
@@ -1,7 +1,7 @@
-ZeroRttAccepted in noq - Rust ZeroRttAccepted
pub struct ZeroRttAccepted(/* private fields */);
Expand description
Future that completes when a connection is fully established
+ZeroRttAccepted in noq - Rust ZeroRttAccepted
pub struct ZeroRttAccepted(/* private fields */);
Expand description
Future that completes when a connection is fully established
For clients, the resulting value indicates if 0-RTT was accepted. For servers, the resulting
value is meaningless.
-Trait Implementations§
Source§impl Future for ZeroRttAccepted