Struct bonsaidb::server::fabruic::Connection

pub struct Connection<T>
where
    T: DeserializeOwned + Serialize + Send + 'static,
{ /* private fields */ }

Represents an open connection. Receives Incoming through [Stream].

Implementations

impl<T> Connection<T>

where T: DeserializeOwned + Serialize + Send + 'static,

pub async fn open_stream<S, R>( &self, type: &T ) -> Result<(Sender<S>, Receiver<R>), Stream>

where S: DeserializeOwned + Serialize + Send + 'static, R: DeserializeOwned + Serialize + Send + 'static,

Open a stream on this Connection, allowing to send data back and forth.

Use S and R to define which type this stream is sending and receiving and type to send this information to the receiver.

Errors

• error::Stream::Open if opening a stream failed
• error::Stream::Sender if sending the type information to the peer failed, see error::Sender for more details

pub fn protocol(&self) -> Option<Vec<u8>>

The negotiated application protocol. See Builder::set_protocols.

pub fn peer_identity(&self) -> Option<CertificateChain>

Get the peer’s CertificateChain, if available.

pub fn remote_address(&self) -> SocketAddr

The peer’s address. Clients may change addresses at will, e.g. when switching to a cellular internet connection.

pub async fn close_incoming(&self) -> Result<(), AlreadyClosed>

Prevents any new incoming streams. Already incoming streams will finish first.

Errors

error::AlreadyClosed if it was already closed.

pub async fn close(&self) -> Result<(), AlreadyClosed>

Close the Connection immediately.

To close a Connection gracefully use Sender::finish, the Receiver can’t be gracefully closed from the receiving end.

Errors

error::AlreadyClosed if it was already closed.

Trait Implementations

impl<T> Clone for Connection<T>

where T: Clone + DeserializeOwned + Serialize + Send + 'static,

fn clone(&self) -> Connection<T>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<T> Debug for Connection<T>

where T: DeserializeOwned + Serialize + Send + 'static,

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

Formats the value using the given formatter.

impl<T> FusedStream for Connection<T>

where T: DeserializeOwned + Serialize + Send + 'static,

fn is_terminated(&self) -> bool

Returns true if the stream should no longer be polled.

impl<T> Stream for Connection<T>

where T: DeserializeOwned + Serialize + Send + 'static,

type Item = Result<Incoming<T>, Connection>

Values yielded by the stream.

fn poll_next( self: Pin<&mut Connection<T>>, cx: &mut Context<'_> ) -> Poll<Option<<Connection<T> as Stream>::Item>>

Attempt to pull out the next value of this stream, registering the current task for wakeup if the value is not yet available, and returning None if the stream is exhausted.

fn size_hint(&self) -> (usize, Option<usize>)

Returns the bounds on the remaining length of the stream.

impl<'pin, T> Unpin for Connection<T>

where T: DeserializeOwned + Serialize + Send + 'static, __Connection<'pin, T>: Unpin,