Connection

Struct Connection 

Source
pub struct Connection<I, O> { /* private fields */ }
Expand description

A type-safe TCP socket connection.

write accepts input of type I. read will produce an output of type O.

Implementations§

Source§

impl<I, O> Connection<I, O>

Source

pub fn seize(stream: TcpStream) -> Self

Creates a Connection that will take over the given net::TcpStream.

Unless you know what you are doing, use a Plug instead!

Source

pub async fn write(&mut self, input: I) -> Result<()>
where I: Serialize,

Writes the given input to the Connection.

Source

pub async fn write_bytes(&mut self, input: &[u8]) -> Result<()>
where I: Serialize,

Writes raw bytes to the Connection.

Source

pub async fn read(&mut self) -> Result<O>

Reads some output from the Connection.

Source

pub async fn read_bytes(&mut self) -> Result<&[u8]>

Reads raw bytes from the Connection.

Source

pub async fn copy<T>(&mut self, to: &mut Connection<T, O>) -> Result<u64>

Copies all the output of the Connection to the provided one, effectively creating a proxy.

Source

pub async fn connect<T>( &mut self, with: &mut Connection<T, O>, ) -> Result<(u64, u64)>

Connects this Connection with another, copying in both directions.

Trait Implementations§

Source§

impl<I, O> Debug for Connection<I, O>

Source§

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

Formats the value using the given formatter. Read more

Auto Trait Implementations§

§

impl<I, O> !Freeze for Connection<I, O>

§

impl<I, O> RefUnwindSafe for Connection<I, O>

§

impl<I, O> Send for Connection<I, O>
where I: Send, O: Send,

§

impl<I, O> Sync for Connection<I, O>
where I: Sync, O: Sync,

§

impl<I, O> Unpin for Connection<I, O>
where I: Unpin, O: Unpin,

§

impl<I, O> UnwindSafe for Connection<I, O>
where I: UnwindSafe, O: UnwindSafe,

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.