Struct trillium_http::transport::BoxedTransport

pub struct BoxedTransport(/* private fields */);

A type for dyn Transport trait objects

BoxedTransport represents a Box<dyn Transport + Any> that supports downcasting to the original Transport. This is used in trillium to erase the generic on Conn, in order to avoid writing Conn<TcpStream> throughout an application.

Stability Note: This may go away at some point and be replaced by a type alias exported from a trillium_server_common::Server crate.

Implementations

impl BoxedTransport

pub fn new<T: Transport + Any>(t: T) -> Self

Create a new BoxedTransport from some Transport.

use trillium_http::transport::BoxedTransport;
use trillium_testing::TestTransport;
// this examples uses trillium_testing::TestTransport as an
// easily-constructed AsyncRead+AsyncWrite.
let (test_transport, _) = TestTransport::new();

let boxed = BoxedTransport::new(test_transport);

let downcast: Option<Box<TestTransport>> = boxed.downcast();
assert!(downcast.is_some());

let boxed_again = BoxedTransport::new(*downcast.unwrap());
assert!(boxed_again.downcast::<async_net::TcpStream>().is_none());

pub fn downcast<T: 'static>(self) -> Option<Box<T>>

Attempt to convert the trait object into a specific transport T. This will only succeed if T is the type that was originally passed to BoxedTransport::new, and will return None otherwise

see BoxedTransport::new for example usage

pub fn downcast_ref<T: Transport>(&self) -> Option<&T>

Attempt to get a reference to the trait object as a specific transport type T. This will only succeed if T is the type that was originally passed to BoxedTransport::new, and will return None otherwise

pub fn downcast_mut<T: Transport>(&mut self) -> Option<&mut T>

Attempt to get a mutable reference to the trait object as a specific transport type T. This will only succeed if T is the type that was originally passed to BoxedTransport::new, and will return None otherwise

Trait Implementations

impl AsyncRead for BoxedTransport

where Self: Unpin,

fn poll_read( self: Pin<&mut Self>, cx: &mut Context<'_>, buf: &mut [u8], ) -> Poll<Result<usize>>

Attempt to read from the AsyncRead into buf.

fn poll_read_vectored( self: Pin<&mut Self>, cx: &mut Context<'_>, bufs: &mut [IoSliceMut<'_>], ) -> Poll<Result<usize>>

Attempt to read from the AsyncRead into bufs using vectored IO operations.

impl AsyncWrite for BoxedTransport

where Self: Unpin,

fn poll_write( self: Pin<&mut Self>, cx: &mut Context<'_>, buf: &[u8], ) -> Poll<Result<usize>>

Attempt to write bytes from buf into the object.

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.

fn poll_close(self: Pin<&mut Self>, cx: &mut Context<'_>) -> Poll<Result<()>>

Attempt to close the object.

fn poll_write_vectored( self: Pin<&mut Self>, cx: &mut Context<'_>, bufs: &[IoSlice<'_>], ) -> Poll<Result<usize>>

Attempt to write bytes from bufs into the object using vectored IO operations.

impl Debug for BoxedTransport

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

Formats the value using the given formatter.

impl Deref for BoxedTransport

type Target = dyn Transport

The resulting type after dereferencing.

fn deref(&self) -> &Self::Target

Dereferences the value.

impl Transport for BoxedTransport

fn set_linger(&mut self, linger: Option<Duration>) -> Result<()>

Sets the linger duration of this transport by setting the SO_LINGER option

fn set_nodelay(&mut self, nodelay: bool) -> Result<()>

Sets the value of the TCP_NODELAY option on this transport.

fn set_ip_ttl(&mut self, ttl: u32) -> Result<()>

Sets the value for the IP_TTL option on this transport.

fn peer_addr(&self) -> Result<Option<SocketAddr>>

Returns the socket address of the remote peer of this transport.