Struct std::sys::windows::pipe::AsyncPipe

struct AsyncPipe<'a> {
    pipe: Handle,
    event: Handle,
    overlapped: Box<OVERLAPPED>,
    dst: &'a mut Vec<u8>,
    state: State,
}

Fields

pipe: Handle

event: Handle

overlapped: Box<OVERLAPPED>

dst: &'a mut Vec<u8>

state: State

Implementations

impl<'a> AsyncPipe<'a>

fn new(pipe: Handle, dst: &'a mut Vec<u8>) -> Result<AsyncPipe<'a>>

fn schedule_read(&mut self) -> Result<bool>

Executes an overlapped read operation.

Must not currently be reading, and returns whether the pipe is currently at EOF or not. If the pipe is not at EOF then result() must be called to complete the read later on (may block), but if the pipe is at EOF then result() should not be called as it will just block forever.

fn result(&mut self) -> Result<bool>

Wait for the result of the overlapped operation previously executed.

Takes a parameter wait which indicates if this pipe is currently being read whether the function should block waiting for the read to complete.

Returns values:

• true - finished any pending read and the pipe is not at EOF (keep going)
• false - finished any pending read and pipe is at EOF (stop issuing reads)

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

Finishes out reading this pipe entirely.

Waits for any pending and schedule read, and then calls read_to_end if necessary to read all the remaining information.

Trait Implementations

impl<'a> Drop for AsyncPipe<'a>

fn drop(&mut self)

Executes the destructor for this type.