Struct ipipe::Pipe

pub struct Pipe { /* fields omitted */ }

Abstraction over a named pipe

Implementations

impl Pipe

pub fn open(path: &Path, on_cleanup: OnCleanup) -> Result<Self>

Open an existing pipe. If on_cleanup is set to ‘DeleteOnDrop’ the named pipe will be deleted when the returned struct is deallocated. Note that this function is not platform-agnostic as unix pipe paths and Windows pipe paths are formatted differnetly.

pub fn with_name(name: &str, on_cleanup: OnCleanup) -> Result<Self>

Open or create a pipe with the given name. Note that this is just a string name, not a path.

pub fn create(on_cleanup: OnCleanup) -> Result<Self>

Create a pipe with a randomly generated name in a tempory directory. If on_cleanup is set to ‘DeleteOnDrop’ the named pipe will be deleted when the returned struct is deallocated.

pub fn close(&mut self) -> Result<()>

Close the pipe. If the pipe is not closed before deallocation, this will be called automatically on drop.

pub fn write_byte(&mut self, buf: u8) -> Result<usize>

Write a single byte to the pipe

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

Write an array of bytes to the pipe

pub fn write_string(&mut self, s: &str) -> Result<usize>

Writes a string to the pipe

pub fn read_byte(&mut self) -> Result<u8>

Read a single byte

pub fn read_bytes(&mut self, size: usize) -> Result<Vec<u8>>

Reads the given number of bytes and returns the result in a vector.

pub fn read_string(&mut self, size: usize) -> Result<String>

Reads the given number of bytes and returns the result as a string.

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

Flush input and output.

impl Pipe

pub fn path(&self) -> &Path

Return the path to this named pipe

pub fn iter(&mut self) -> FifoIterator<'_>

Creates an iterator that reads bytes until the pipe is closed.

pub fn read_bytes_while(
    &mut self,
    predicate: impl Fn(u8) -> bool
) -> Result<Vec<u8>>

Reads until the given predicate is false, and returns the result as a vector of bytes.

pub fn read_string_while(
    &mut self,
    predicate: impl Fn(u8) -> bool
) -> Result<String>

Reads until the given predicate is false, and returns the result as a string.

Trait Implementations

impl Clone for Pipe

fn clone(&self) -> Self

Cloning a pipe creates a slave which points to the same path but does not close the pipe when dropped.

pub fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Drop for Pipe

fn drop(&mut self)

Executes the destructor for this type.

impl Read for Pipe

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

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

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

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

pub 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.

pub 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.

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

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

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

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

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

Read the exact number of bytes required to fill buf.

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

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

pub fn bytes(self) -> Bytes<Self>

Transforms this Read instance to an Iterator over its bytes.

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

Creates an adaptor which will chain this stream with another.

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

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

impl Write for Pipe

fn write(&mut self, bytes: &[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.

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

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

pub 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.

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

Attempts to write an entire buffer into this writer.

pub 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.

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

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

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

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