[−][src]Struct miow::pipe::NamedPipe
A named pipe that can accept connections.
Implementations
impl NamedPipe
[src]
pub fn new<A: AsRef<OsStr>>(addr: A) -> Result<NamedPipe>
[src]
Creates a new initial named pipe.
This function is equivalent to:
use miow::pipe::NamedPipeBuilder; NamedPipeBuilder::new(addr) .first(true) .inbound(true) .outbound(true) .out_buffer_size(65536) .in_buffer_size(65536) .create();
pub fn wait<A: AsRef<OsStr>>(addr: A, timeout: Option<Duration>) -> Result<()>
[src]
Waits until either a time-out interval elapses or an instance of the specified named pipe is available for connection.
If this function succeeds the process can create a File
to connect to
the named pipe.
pub fn connect(&self) -> Result<()>
[src]
Connects this named pipe to a client, blocking until one becomes available.
This function will call the ConnectNamedPipe
function to await for a
client to connect. This can be called immediately after the pipe is
created, or after it has been disconnected from a previous client.
pub unsafe fn connect_overlapped(
&self,
overlapped: *mut OVERLAPPED
) -> Result<bool>
[src]
&self,
overlapped: *mut OVERLAPPED
) -> Result<bool>
Issue a connection request with the specified overlapped operation.
This function will issue a request to connect a client to this server, returning immediately after starting the overlapped operation.
If this function immediately succeeds then Ok(true)
is returned. If
the overlapped operation is enqueued and pending, then Ok(false)
is
returned. Otherwise an error is returned indicating what went wrong.
Unsafety
This function is unsafe because the kernel requires that the
overlapped
pointer is valid until the end of the I/O operation. The
kernel also requires that overlapped
is unique for this I/O operation
and is not in use for any other I/O.
To safely use this function callers must ensure that this pointer is valid until the I/O operation is completed, typically via completion ports and waiting to receive the completion notification on the port.
pub fn disconnect(&self) -> Result<()>
[src]
Disconnects this named pipe from any connected client.
pub unsafe fn read_overlapped(
&self,
buf: &mut [u8],
overlapped: *mut OVERLAPPED
) -> Result<Option<usize>>
[src]
&self,
buf: &mut [u8],
overlapped: *mut OVERLAPPED
) -> Result<Option<usize>>
Issues an overlapped read operation to occur on this pipe.
This function will issue an asynchronous read to occur in an overlapped
fashion, returning immediately. The buf
provided will be filled in
with data and the request is tracked by the overlapped
function
provided.
If the operation succeeds immediately, Ok(Some(n))
is returned where
n
is the number of bytes read. If an asynchronous operation is
enqueued, then Ok(None)
is returned. Otherwise if an error occurred
it is returned.
When this operation completes (or if it completes immediately), another mechanism must be used to learn how many bytes were transferred (such as looking at the filed in the IOCP status message).
Unsafety
This function is unsafe because the kernel requires that the buf
and
overlapped
pointers to be valid until the end of the I/O operation.
The kernel also requires that overlapped
is unique for this I/O
operation and is not in use for any other I/O.
To safely use this function callers must ensure that the pointers are valid until the I/O operation is completed, typically via completion ports and waiting to receive the completion notification on the port.
pub unsafe fn write_overlapped(
&self,
buf: &[u8],
overlapped: *mut OVERLAPPED
) -> Result<Option<usize>>
[src]
&self,
buf: &[u8],
overlapped: *mut OVERLAPPED
) -> Result<Option<usize>>
Issues an overlapped write operation to occur on this pipe.
This function will issue an asynchronous write to occur in an overlapped
fashion, returning immediately. The buf
provided will be filled in
with data and the request is tracked by the overlapped
function
provided.
If the operation succeeds immediately, Ok(Some(n))
is returned where
n
is the number of bytes written. If an asynchronous operation is
enqueued, then Ok(None)
is returned. Otherwise if an error occurred
it is returned.
When this operation completes (or if it completes immediately), another mechanism must be used to learn how many bytes were transferred (such as looking at the filed in the IOCP status message).
Unsafety
This function is unsafe because the kernel requires that the buf
and
overlapped
pointers to be valid until the end of the I/O operation.
The kernel also requires that overlapped
is unique for this I/O
operation and is not in use for any other I/O.
To safely use this function callers must ensure that the pointers are valid until the I/O operation is completed, typically via completion ports and waiting to receive the completion notification on the port.
pub unsafe fn result(&self, overlapped: *mut OVERLAPPED) -> Result<usize>
[src]
Calls the GetOverlappedResult
function to get the result of an
overlapped operation for this handle.
This function takes the OVERLAPPED
argument which must have been used
to initiate an overlapped I/O operation, and returns either the
successful number of bytes transferred during the operation or an error
if one occurred.
Unsafety
This function is unsafe as overlapped
must have previously been used
to execute an operation for this handle, and it must also be a valid
pointer to an Overlapped
instance.
Panics
This function will panic
Trait Implementations
impl AsRawHandle for NamedPipe
[src]
fn as_raw_handle(&self) -> HANDLE
[src]
impl Debug for NamedPipe
[src]
impl FromRawHandle for NamedPipe
[src]
unsafe fn from_raw_handle(handle: HANDLE) -> NamedPipe
[src]
impl IntoRawHandle for NamedPipe
[src]
fn into_raw_handle(self) -> HANDLE
[src]
impl Read for NamedPipe
[src]
fn read(&mut self, buf: &mut [u8]) -> Result<usize>
[src]
fn read_vectored(&mut self, bufs: &mut [IoSliceMut]) -> Result<usize, Error>
1.36.0[src]
fn is_read_vectored(&self) -> bool
[src]
unsafe fn initializer(&self) -> Initializer
[src]
fn read_to_end(&mut self, buf: &mut Vec<u8>) -> Result<usize, Error>
1.0.0[src]
fn read_to_string(&mut self, buf: &mut String) -> Result<usize, Error>
1.0.0[src]
fn read_exact(&mut self, buf: &mut [u8]) -> Result<(), Error>
1.6.0[src]
fn by_ref(&mut self) -> &mut Self
1.0.0[src]
fn bytes(self) -> Bytes<Self>
1.0.0[src]
fn chain<R>(self, next: R) -> Chain<Self, R> where
R: Read,
1.0.0[src]
R: Read,
fn take(self, limit: u64) -> Take<Self>
1.0.0[src]
impl<'a> Read for &'a NamedPipe
[src]
fn read(&mut self, buf: &mut [u8]) -> Result<usize>
[src]
fn read_vectored(&mut self, bufs: &mut [IoSliceMut]) -> Result<usize, Error>
1.36.0[src]
fn is_read_vectored(&self) -> bool
[src]
unsafe fn initializer(&self) -> Initializer
[src]
fn read_to_end(&mut self, buf: &mut Vec<u8>) -> Result<usize, Error>
1.0.0[src]
fn read_to_string(&mut self, buf: &mut String) -> Result<usize, Error>
1.0.0[src]
fn read_exact(&mut self, buf: &mut [u8]) -> Result<(), Error>
1.6.0[src]
fn by_ref(&mut self) -> &mut Self
1.0.0[src]
fn bytes(self) -> Bytes<Self>
1.0.0[src]
fn chain<R>(self, next: R) -> Chain<Self, R> where
R: Read,
1.0.0[src]
R: Read,
fn take(self, limit: u64) -> Take<Self>
1.0.0[src]
impl Write for NamedPipe
[src]
fn write(&mut self, buf: &[u8]) -> Result<usize>
[src]
fn flush(&mut self) -> Result<()>
[src]
fn write_vectored(&mut self, bufs: &[IoSlice]) -> Result<usize, Error>
1.36.0[src]
fn is_write_vectored(&self) -> bool
[src]
fn write_all(&mut self, buf: &[u8]) -> Result<(), Error>
1.0.0[src]
fn write_all_vectored(&mut self, bufs: &mut [IoSlice]) -> Result<(), Error>
[src]
fn write_fmt(&mut self, fmt: Arguments) -> Result<(), Error>
1.0.0[src]
fn by_ref(&mut self) -> &mut Self
1.0.0[src]
impl<'a> Write for &'a NamedPipe
[src]
fn write(&mut self, buf: &[u8]) -> Result<usize>
[src]
fn flush(&mut self) -> Result<()>
[src]
fn write_vectored(&mut self, bufs: &[IoSlice]) -> Result<usize, Error>
1.36.0[src]
fn is_write_vectored(&self) -> bool
[src]
fn write_all(&mut self, buf: &[u8]) -> Result<(), Error>
1.0.0[src]
fn write_all_vectored(&mut self, bufs: &mut [IoSlice]) -> Result<(), Error>
[src]
fn write_fmt(&mut self, fmt: Arguments) -> Result<(), Error>
1.0.0[src]
fn by_ref(&mut self) -> &mut Self
1.0.0[src]
Auto Trait Implementations
impl RefUnwindSafe for NamedPipe
impl Send for NamedPipe
impl Sync for NamedPipe
impl Unpin for NamedPipe
impl UnwindSafe for NamedPipe
Blanket Implementations
impl<T> Any for T where
T: 'static + ?Sized,
[src]
T: 'static + ?Sized,
impl<T> Borrow<T> for T where
T: ?Sized,
[src]
T: ?Sized,
impl<T> BorrowMut<T> for T where
T: ?Sized,
[src]
T: ?Sized,
fn borrow_mut(&mut self) -> &mut T
[src]
impl<T> From<T> for T
[src]
impl<T, U> Into<U> for T where
U: From<T>,
[src]
U: From<T>,
impl<T, U> TryFrom<U> for T where
U: Into<T>,
[src]
U: Into<T>,
type Error = Infallible
The type returned in the event of a conversion error.
fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>
[src]
impl<T, U> TryInto<U> for T where
U: TryFrom<T>,
[src]
U: TryFrom<T>,