Struct named_pipe::PipeClient

pub struct PipeClient { /* fields omitted */ }

Pipe client connected to a server.

Methods

impl PipeClient

pub fn connect<T: AsRef<OsStr>>(name: T) -> Result<PipeClient>

Will wait for server infinitely.

pub fn connect_ms<T: AsRef<OsStr>>(name: T, timeout: u32) -> Result<PipeClient>

Will wait for server. Note that timeout 0xFFFFFFFF stands for infinite waiting.

pub fn read_async_owned(self, buf: Vec<u8>) -> Result<ReadHandle<'static, Self>>

Initializes asyncronous read operation and takes ownership of buffer and client.

pub fn write_async_owned(
    self,
    buf: Vec<u8>
) -> Result<WriteHandle<'static, Self>>

Initializes asyncronous write operation and takes ownership of buffer and client.

pub fn set_read_timeout(&mut self, read_timeout: Option<Duration>)

Allows you to set read timeout in milliseconds.

Note that zero value will return immediately and 0xFFFFFFFF will wait forever. Also note that nanos will be ignored and also if number of milliseconds is greater than 0xFFFFFFFF then it will write 0xFFFFFFFF as a timeout value.

Defaults to None (infinite).

pub fn set_write_timeout(&mut self, write_timeout: Option<Duration>)

Allows you to set write timeout in milliseconds.

Note that zero value will return immediately and 0xFFFFFFFF will wait forever.Also note that nanos will be ignored and also if number of milliseconds is greater than 0xFFFFFFFF then it will write 0xFFFFFFFF as a timeout value.

Defaults to None (infinite).

pub fn get_read_timeout(&self) -> Option<Duration>

pub fn get_write_timeout(&self) -> Option<Duration>

Trait Implementations

impl PipeIo for PipeClient

fn io_obj<'a>(&'a mut self) -> PipeIoObj<'a>

fn io_handles<'a>(&'a self) -> PipeIoHandles<'a>

fn get_read_timeout(&self) -> Option<u32>

fn get_write_timeout(&self) -> Option<u32>

impl Send for PipeClient

impl Debug for PipeClient

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

Formats the value using the given formatter.

impl Write for PipeClient

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

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

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

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

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

Attempts to write an entire buffer into this writer.

fn write_fmt(&mut self, fmt: Arguments) -> Result<(), Error>

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

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

Creates a "by reference" adaptor for this instance of Write.

impl Read for PipeClient

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.

unsafe fn initializer(&self) -> Initializer

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

Determines if this Reader can work with buffers of uninitialized memory.

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

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

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

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

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

Read the exact number of bytes required to fill buf.

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

Creates a "by reference" adaptor for this instance of Read.

fn bytes(self) -> Bytes<Self>

Transforms this Read instance to an [Iterator] over its bytes.

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

Creates an adaptor which will chain this stream with another.

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

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