Struct NamedPipeServer 

pub struct NamedPipeServer { /* private fields */ }

A connected or connectable named pipe server instance.

Implementations

impl NamedPipeServer

pub fn endpoint(&self) -> &PipeServerEndpoint

Return the underlying endpoint.

pub fn default_timeout(&self) -> Duration

Return the configured default timeout.

pub fn allow_executable(&mut self, path: impl Into<PathBuf>)

Add an executable path to the allow-list.

The comparison is case-insensitive. If no paths are in the allow-list (the default), all processes are allowed to connect.

pub fn remove_executable(&mut self, path: impl Into<PathBuf>)

Remove an executable path from the allow-list.

The comparison is case-insensitive. Does nothing if the path is not present.

pub fn connect(&self) -> Result<()>

Block until a client connects to this instance.

If an executable allow-list was configured via NamedPipeServerBuilder::allow_executable, the connecting process’s image path is checked against the list. If it does not match, the connection is immediately disconnected and an Error::AccessDenied error is returned. An empty allow-list (the default) permits all processes to connect.

pub fn connect_with_timeout(&self, timeout: Duration) -> Result<()>

Block until a client connects to this instance or the timeout elapses.

This method returns [Error::Pipe(PipeError::Timeout)] if no client connection is completed within the provided timeout.

pub fn connect_with_wait(&self, wait: &Wait) -> Result<()>

Block until a client connects or an external wait handle is signaled

If wait is signaled first, this method cancels the pending connect operation and returns [Error::Pipe(PipeError::Connect)] with interruption context.

pub fn connect_with_wait_timeout( &self, wait: &Wait, timeout: Duration, ) -> Result<()>

Block until a client connects, an external wait handle is signaled, or timeout elapses.

If wait is signaled first, this method cancels the pending connect operation and returns [Error::Pipe(PipeError::Connect)] with interruption context.

pub fn disconnect(&self) -> Result<()>

Disconnect the currently connected client.

Trait Implementations

impl Debug for NamedPipeServer

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

Formats the value using the given formatter.

impl Read for NamedPipeServer

fn read(&mut self, buf: &mut [u8]) -> Result<usize>

Pull some bytes from this source into the specified buffer, returning how many bytes were read.

fn read_vectored(&mut self, bufs: &mut [IoSliceMut<'_>]) -> Result<usize, Error>

Like read, except that it reads into a slice of buffers.

fn is_read_vectored(&self) -> bool

🔬This is a nightly-only experimental API. (can_vector)

Determines if this Reader has an efficient read_vectored implementation.

fn read_to_end(&mut self, buf: &mut Vec<u8>) -> Result<usize, Error>

Reads all bytes until EOF in this source, placing them into buf.

fn read_to_string(&mut self, buf: &mut String) -> Result<usize, Error>

Reads all bytes until EOF in this source, appending them to buf.

fn read_exact(&mut self, buf: &mut [u8]) -> Result<(), Error>

Reads the exact number of bytes required to fill buf.

fn read_buf(&mut self, buf: BorrowedCursor<'_>) -> Result<(), Error>

🔬This is a nightly-only experimental API. (read_buf)

Pull some bytes from this source into the specified buffer.

fn read_buf_exact(&mut self, cursor: BorrowedCursor<'_>) -> Result<(), Error>

🔬This is a nightly-only experimental API. (read_buf)

Reads the exact number of bytes required to fill cursor.

fn by_ref(&mut self) -> &mut Self

where Self: Sized,

Creates a “by reference” adapter for this instance of Read.

fn bytes(self) -> Bytes<Self>

where Self: Sized,

Transforms this Read instance to an Iterator over its bytes.

fn chain<R>(self, next: R) -> Chain<Self, R>

where R: Read, Self: Sized,

Creates an adapter which will chain this stream with another.

fn take(self, limit: u64) -> Take<Self>

where Self: Sized,

Creates an adapter which will read at most limit bytes from it.

fn read_array<const N: usize>(&mut self) -> Result<[u8; N], Error>

where Self: Sized,

🔬This is a nightly-only experimental API. (read_array)

Read and return a fixed array of bytes from this source.

impl Write for NamedPipeServer

fn write(&mut self, buf: &[u8]) -> Result<usize>

Writes a buffer into this writer, returning how many bytes were written.

fn flush(&mut self) -> Result<()>

Flushes this output stream, ensuring that all intermediately buffered contents reach their destination.

fn write_vectored(&mut self, bufs: &[IoSlice<'_>]) -> Result<usize, Error>

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

fn is_write_vectored(&self) -> bool

🔬This is a nightly-only experimental API. (can_vector)

Determines if this Writer has an efficient write_vectored implementation.

fn write_all(&mut self, buf: &[u8]) -> Result<(), Error>

Attempts to write an entire buffer into this writer.

fn write_all_vectored(&mut self, bufs: &mut [IoSlice<'_>]) -> Result<(), Error>

🔬This is a nightly-only experimental API. (write_all_vectored)

Attempts to write multiple buffers into this writer.

fn write_fmt(&mut self, args: Arguments<'_>) -> Result<(), Error>

Writes a formatted string into this writer, returning any error encountered.

fn by_ref(&mut self) -> &mut Self

where Self: Sized,

Creates a “by reference” adapter for this instance of Write.