Struct interprocess::os::windows::named_pipe::tokio::DuplexMsgPipeStream

pub struct DuplexMsgPipeStream { /* private fields */ }

Available on Windows and crate feature tokio_support only.

Message stream reader and writer for a Tokio-based named pipe.

Created either by using PipeListener or by connecting to a named pipe server.

Implementations

impl DuplexMsgPipeStream

pub fn connect(name: impl AsRef<OsStr>) -> Result<Self>

Tries to connect to the specified named pipe (the \\.\pipe\ prefix is added automatically).

If there is no available server, returns immediately with the WouldBlock error.

pub fn connect_to_remote(
    pipe_name: impl AsRef<OsStr>,
    hostname: impl AsRef<OsStr>
) -> Result<Self>

Tries to connect to the specified named pipe at a remote computer (the \\<hostname>\pipe\ prefix is added automatically).

If there is no available server, returns immediately with the WouldBlock error.

pub fn is_server(&self) -> bool

Returns true if the stream was created by a listener (server-side), false if it was created by connecting to a server (client-side).

pub fn is_client(&self) -> bool

Returns true if the stream was created by connecting to a server (client-side), false if it was created by a listener (server-side).

pub unsafe fn from_raw_handle(handle: *mut c_void) -> Result<Self>

Creates a Tokio-based async object from a given raw handle. This will also attach the object to the Tokio runtime this function is called in, so calling it outside a runtime will result in an error (which is why the FromRawHandle trait can’t be implemented instead).

Safety

The given handle must be valid (i.e. refer to an existing kernel object) and must not be owned by any other handle container. If this is not upheld, an arbitrary handle will be closed when the returned object is dropped.

pub fn split(self) -> (MsgReaderPipeStream, MsgWriterPipeStream)

Splits the duplex stream into its reading and writing half.

pub fn client_process_id(&self) -> Result<u32>

Retrieves the process identifier of the client side of the named pipe connection.

pub fn client_session_id(&self) -> Result<u32>

Retrieves the session identifier of the client side of the named pipe connection.

pub fn server_process_id(&self) -> Result<u32>

Retrieves the process identifier of the server side of the named pipe connection.

pub fn server_session_id(&self) -> Result<u32>

Retrieves the session identifier of the server side of the named pipe connection.

pub fn disconnect_without_flushing(self) -> Result<()>

Disconnects the named pipe stream without flushing buffers, causing all data in those buffers to be lost. This is much faster (and, in some case, the only finite-time way of ending things) than simply dropping the stream, since, for non-async named pipes, the Drop implementation flushes first.

Only makes sense for server-side pipes and will return an error if called on a client stream. For async pipe streams, this is the same as dropping the pipe.

Trait Implementations

impl AsyncRead for &DuplexMsgPipeStream

fn poll_read(
    self: Pin<&mut Self>,
    ctx: &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, Error>>

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

impl AsyncRead for DuplexMsgPipeStream

fn poll_read(
    self: Pin<&mut Self>,
    ctx: &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, Error>>

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

impl AsyncWrite for &DuplexMsgPipeStream

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

Attempt to write bytes from buf into the object.

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

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

fn poll_close(self: Pin<&mut Self>, ctx: &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, Error>>

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

impl AsyncWrite for DuplexMsgPipeStream

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

Attempt to write bytes from buf into the object.

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

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

fn poll_close(self: Pin<&mut Self>, ctx: &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, Error>>

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

impl Debug for DuplexMsgPipeStream

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

Formats the value using the given formatter.

impl Drop for DuplexMsgPipeStream

fn drop(&mut self)

Executes the destructor for this type.

impl TokioPipeStream for DuplexMsgPipeStream

const ROLE: PipeStreamRole = PipeStreamRole::ReaderAndWriter

The data stream flow direction for the pipe. See the PipeStreamRole enumeration for more on what this means.

const WRITE_MODE: Option<PipeMode> = MsgWriterPipeStream::WRITE_MODE

The data stream mode for the pipe. If set to PipeMode::Bytes, message boundaries will broken and having READ_MODE at PipeMode::Messages would be a pipe creation error.

const READ_MODE: Option<PipeMode> = MsgReaderPipeStream::READ_MODE

The data stream mode used when reading from the pipe: if WRITE_MODE is PipeMode::Messages and READ_MODE is PipeMode::Bytes, the message boundaries will be destroyed when reading even though they are retained when written. See the PipeMode enumeration for more on what those modes mean.