Enum Stream 

pub enum Stream {
    UdSocket(Stream),
}

Tokio-based local socket byte stream, obtained either from Listener or by connecting to an existing local socket.

See the module-level documentation of local sockets for more details.

Examples

Basic client

Variants

UdSocket(Stream)

Makes use of Unix domain sockets.

Click the struct name in the parentheses to learn more.

Trait Implementations

impl AsyncRead for &Stream

fn poll_read( self: Pin<&mut &Stream>, cx: &mut Context<'_>, buf: &mut ReadBuf<'_>, ) -> Poll<Result<(), Error>>

Attempts to read from the AsyncRead into buf.

impl AsyncRead for Stream

fn poll_read( self: Pin<&mut Stream>, cx: &mut Context<'_>, buf: &mut ReadBuf<'_>, ) -> Poll<Result<(), Error>>

Attempts to read from the AsyncRead into buf.

impl AsyncWrite for &Stream

Flushing and shutdown are always successful no-ops.

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

Attempt to write bytes from buf into the object.

fn poll_flush( self: Pin<&mut &Stream>, _: &mut Context<'_>, ) -> Poll<Result<(), Error>>

Attempts to flush the object, ensuring that any buffered data reach their destination.

fn poll_shutdown( self: Pin<&mut &Stream>, _: &mut Context<'_>, ) -> Poll<Result<(), Error>>

Initiates or attempts to shut down this writer, returning success when the I/O connection has completely shut down.

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

Like poll_write, except that it writes from a slice of buffers.

fn is_write_vectored(&self) -> bool

Determines if this writer has an efficient poll_write_vectored implementation.

impl AsyncWrite for Stream

Flushing and shutdown are always successful no-ops.

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

Attempt to write bytes from buf into the object.

fn poll_flush( self: Pin<&mut Stream>, _: &mut Context<'_>, ) -> Poll<Result<(), Error>>

Attempts to flush the object, ensuring that any buffered data reach their destination.

fn poll_shutdown( self: Pin<&mut Stream>, _: &mut Context<'_>, ) -> Poll<Result<(), Error>>

Initiates or attempts to shut down this writer, returning success when the I/O connection has completely shut down.

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

Like poll_write, except that it writes from a slice of buffers.

fn is_write_vectored(&self) -> bool

Determines if this writer has an efficient poll_write_vectored implementation.

impl Debug for Stream

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

Formats the value using the given formatter.

impl From<Stream> for Stream

Available on Unix only.

fn from(x: Stream) -> Stream

Converts to this type from the input type.

impl Stream for Stream

type RecvHalf = RecvHalf

Receive half type returned by .split().

type SendHalf = SendHalf

Send half type returned by .split().

async fn from_options(options: &ConnectOptions<'_>) -> Result<Stream, Error>

Connects to a local socket server using the specified options.

fn split(self) -> (RecvHalf, SendHalf)

Splits a stream into a receive half and a send half.

fn reunite( rh: RecvHalf, sh: SendHalf, ) -> Result<Stream, ReuniteError<<Stream as Stream>::RecvHalf, <Stream as Stream>::SendHalf>>

Attempts to reunite a receive half with a send half to yield the original stream back, returning both halves as an error if they belong to different streams.

fn connect( name: Name<'_>, ) -> impl Future<Output = Result<Self, Error>> + Send + Sync

Asynchronously connects to a local socket server.

impl StreamCommon for Stream

fn take_error(&self) -> Result<Option<Error>, Error>

Reads the stored error code from the socket, returning None if no error has happened since the last call to a method that propagates stored errors. Subsequent calls will return None until another error occurs.

fn peer_creds(&self) -> Result<PeerCreds, Error>

Returns a structure containing a subset of the credentials of the other side of the connection. The nature of the credentials is OS-specific and using some of them for making security decisions may be subject to race conditions.