Struct TcpStream

pub struct TcpStream { /* private fields */ }

Simple implementation of a TCP Stream

Applying only the most simple methods on this struct it is able to act as a simple TCP stream. If extended functionality is required you can access the inner Tokio TCP Stream, or raise a Issue on GitHub.

Implementations

impl TcpStream

pub fn new(io: TokioTcpStream) -> Self

Creates a new TCP Stream from a Tokio TCP Stream

pub async fn connect<A: ToSocketAddrs>(addr: A) -> Result<TcpStream>

Creates a new TCP Stream given a remote address

pub async fn send<A: DoipTcpPayload + DoipPayload + 'static>( &mut self, payload: A, ) -> Result<(), SocketSendError>

Send a DoIP frame to the sink

pub async fn read(&mut self) -> Option<Result<DoipMessage, DecodeError>>

Read a DoIP frame off the stream

pub fn from_std(stream: TcpStream) -> Result<TcpStream>

Converts a standard library TCP Stream to a DoIP Framed TCP Stream

pub fn into_split(self) -> (TcpStreamReadHalf, TcpStreamWriteHalf)

Splits the TCP Stream into a Read Half and Write Half

pub fn get_stream_ref(&self) -> &TokioTcpStream

Get a reference to the inner Tokio TCP Stream

pub fn into_socket(self) -> TokioTcpStream

Access the inner Tokio TCP Stream, consumes the DoIP TCP Stream

Trait Implementations

impl Debug for TcpStream

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

Formats the value using the given formatter.