Struct NamedPipeReader

Source
pub struct NamedPipeReader { /* private fields */ }
Expand description

A convenience wrapper for reading from Unix named pipes.

Implementations§

Source§

impl NamedPipeReader

Source

pub fn from_path(source: &NamedPipePath) -> Self

Creates a new reader, cloning the given NamedPipePath.

Source

pub fn ensure_pipe_exists(&self) -> Result<&Self>

Checks if the named pipe actually exists and tries to create it if it doesn’t.

Examples found in repository?
examples/read_print_repeat.rs (line 18)
13fn main() -> io::Result<()> {
14    task::block_on(async {
15        let pipe = NamedPipePath::new("./my_pipe");
16        let reader = pipe.open_read();
17        loop {
18            reader.ensure_pipe_exists().unwrap();
19            println!("Waiting for message...");
20            let next_msg = reader.read_string().await?;
21            println!("Received message: {}", next_msg);
22        }
23    })
24}
Source

pub async fn read(&self) -> Result<Vec<u8>>

Reads all bytes from the pipe. The returned Future will resolve when something is written to the pipe.

Source

pub async fn read_string(&self) -> Result<String>

Reads a String from the pipe. The returned Future will resolve when something is written to the pipe.

Examples found in repository?
examples/read_print_repeat.rs (line 20)
13fn main() -> io::Result<()> {
14    task::block_on(async {
15        let pipe = NamedPipePath::new("./my_pipe");
16        let reader = pipe.open_read();
17        loop {
18            reader.ensure_pipe_exists().unwrap();
19            println!("Waiting for message...");
20            let next_msg = reader.read_string().await?;
21            println!("Received message: {}", next_msg);
22        }
23    })
24}
More examples
Hide additional examples
examples/read_write_repeat.rs (line 20)
12fn main() -> io::Result<()> {
13    task::block_on(async move {
14        let pipe = NamedPipePath::new("./reverse_me");
15        let writer = pipe.open_write();
16        let reader = pipe.open_read();
17        loop {
18            pipe.ensure_exists().unwrap();
19            println!("Waiting for message...");
20            let msg = reader.read_string().await?;
21
22            let answer = msg.chars().rev().collect::<String>() + "\n";
23            pipe.ensure_exists().unwrap();
24            println!("Received message, waiting for receiver...");
25            writer.write_str(&answer).await?;
26        }
27    })
28}

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.