Struct calloop::io::Async

source · [−]

pub struct Async<'l, F: AsRawFd> { /* private fields */ }

Expand description

Adapter for async IO manipulations

This type wraps an IO object, providing methods to create futures waiting for its readiness.

If the futures-io cargo feature is enabled, it also implements AsyncRead and/or AsyncWrite if the underlying type implements Read and/or Write.

Note that this adapter and the futures procuded from it and not threadsafe.

Implementations

source

impl<'l, F: AsRawFd> Async<'l, F>

source

pub fn get_mut(&mut self) -> &mut F

Mutably access the underlying IO object

source

pub fn readable<'s>(&'s mut self) -> Readable<'s, 'l, F>ⓘNotable traits for Readable<'s, 'l, F>`impl<'s, 'l, F: AsRawFd> Future for Readable<'s, 'l, F> type Output = ();`

A future that resolves once the object becomes ready for reading

source

pub fn writable<'s>(&'s mut self) -> Writable<'s, 'l, F>ⓘNotable traits for Writable<'s, 'l, F>`impl<'s, 'l, F: AsRawFd> Future for Writable<'s, 'l, F> type Output = ();`

A future that resolves once the object becomes ready for writing

source

pub fn into_inner(self) -> F

Remove the async adapter and retrieve the underlying object

Trait Implementations

source

impl<'l, F: AsRawFd + Read> AsyncRead for Async<'l, F>

Available on crate feature futures-io only.

source

fn poll_read(
 self: Pin<&mut Self>,
 cx: &mut Context<'_>,
 buf: &mut [u8]
) -> TaskPoll<Result<usize>>

Attempt to read from the AsyncRead into buf. Read more

source

fn poll_read_vectored(
 self: Pin<&mut Self>,
 cx: &mut Context<'_>,
 bufs: &mut [IoSliceMut<'_>]
) -> TaskPoll<Result<usize>>

Attempt to read from the AsyncRead into bufs using vectored IO operations. Read more

source

impl<'l, F: AsRawFd + Write> AsyncWrite for Async<'l, F>

Available on crate feature futures-io only.

source

fn poll_write(
 self: Pin<&mut Self>,
 cx: &mut Context<'_>,
 buf: &[u8]
) -> TaskPoll<Result<usize>>

Attempt to write bytes from buf into the object. Read more

source

fn poll_write_vectored(
 self: Pin<&mut Self>,
 cx: &mut Context<'_>,
 bufs: &[IoSlice<'_>]
) -> TaskPoll<Result<usize>>

Attempt to write bytes from bufs into the object using vectored IO operations. Read more

source

fn poll_flush(
self: Pin<&mut Self>,
cx: &mut Context<'_>
) -> TaskPoll<Result<()>>

Attempt to flush the object, ensuring that any buffered data reach their destination. Read more

source

fn poll_close(
self: Pin<&mut Self>,
cx: &mut Context<'_>
) -> TaskPoll<Result<()>>

Attempt to close the object. Read more

source

impl<'l, F: AsRawFd + Debug> Debug for Async<'l, F>

source

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

Formats the value using the given formatter. Read more

source

impl<'l, F: AsRawFd> Drop for Async<'l, F>

source

fn drop(&mut self)

Executes the destructor for this type. Read more

source

impl<'l, F: AsRawFd> Unpin for Async<'l, F>

Auto Trait Implementations

impl<'l, F> !RefUnwindSafe for Async<'l, F>

impl<'l, F> !Send for Async<'l, F>

impl<'l, F> !Sync for Async<'l, F>

impl<'l, F> !UnwindSafe for Async<'l, F>

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<R> AsyncReadExt for R where
R: AsyncRead + ?Sized,

source

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

Creates an adaptor which will chain this stream with another. Read more

source

fn read(&'a mut self, buf: &'a mut [u8]) -> Read<'a, Self> where
Self: Unpin,

Tries to read some bytes directly into the given buf in asynchronous manner, returning a future type. Read more

source

fn read_vectored(
 &'a mut self,
 bufs: &'a mut [IoSliceMut<'a>]
) -> ReadVectored<'a, Self> where
 Self: Unpin,

Creates a future which will read from the AsyncRead into bufs using vectored IO operations. Read more

source

fn read_exact(&'a mut self, buf: &'a mut [u8]) -> ReadExact<'a, Self> where
Self: Unpin,

Creates a future which will read exactly enough bytes to fill buf, returning an error if end of file (EOF) is hit sooner. Read more

source

fn read_to_end(
 &'a mut self,
 buf: &'a mut Vec<u8, Global>
) -> ReadToEnd<'a, Self> where
 Self: Unpin,

Creates a future which will read all the bytes from this AsyncRead. Read more

source

fn read_to_string(&'a mut self, buf: &'a mut String) -> ReadToString<'a, Self> where
Self: Unpin,

Creates a future which will read all the bytes from this AsyncRead. Read more

source

fn split(self) -> (ReadHalf<Self>, WriteHalf<Self>) where
Self: AsyncWrite,

Helper method for splitting this read/write object into two halves. Read more

source

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

Creates an AsyncRead adapter which will read at most limit bytes from the underlying reader. Read more

source

impl<W> AsyncWriteExt for W where
W: AsyncWrite + ?Sized,

source

fn flush(&mut self) -> Flush<'_, Self> where
Self: Unpin,

Creates a future which will entirely flush this AsyncWrite. Read more

source

fn close(&mut self) -> Close<'_, Self> where
Self: Unpin,

Creates a future which will entirely close this AsyncWrite.

source

fn write(&'a mut self, buf: &'a [u8]) -> Write<'a, Self> where
Self: Unpin,

Creates a future which will write bytes from buf into the object. Read more

source

fn write_vectored(
 &'a mut self,
 bufs: &'a [IoSlice<'a>]
) -> WriteVectored<'a, Self> where
 Self: Unpin,

Creates a future which will write bytes from bufs into the object using vectored IO operations. Read more

source

fn write_all(&'a mut self, buf: &'a [u8]) -> WriteAll<'a, Self> where
Self: Unpin,

Write data into this object. Read more

source

fn into_sink<Item>(self) -> IntoSink<Self, Item> where
Item: AsRef<[u8]>,

Allow using an AsyncWrite as a Sink<Item: AsRef<[u8]>>. Read more

source

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

const: unstable · source

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

source

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

const: unstable · source

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

Mutably borrows from an owned value. Read more

source

impl<T> From<T> for T

const: unstable · source

fn from(t: T) -> T

Returns the argument unchanged.

source

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

const: unstable · 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 for T where
U: Into<T>,

type Error = Infallible

The type returned in the event of a conversion error.

const: unstable · source

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

Performs the conversion.

source

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

type Error = >::Error

The type returned in the event of a conversion error.

const: unstable · source

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

Performs the conversion.

Struct calloop::io::Async

Implementations

impl<'l, F: AsRawFd> Async<'l, F>

pub fn get_mut(&mut self) -> &mut F

pub fn readable<'s>(&'s mut self) -> Readable<'s, 'l, F>ⓘNotable traits for Readable<'s, 'l, F>impl<'s, 'l, F: AsRawFd> Future for Readable<'s, 'l, F> type Output = ();

pub fn writable<'s>(&'s mut self) -> Writable<'s, 'l, F>ⓘNotable traits for Writable<'s, 'l, F>impl<'s, 'l, F: AsRawFd> Future for Writable<'s, 'l, F> type Output = ();

pub fn into_inner(self) -> F

Trait Implementations

impl<'l, F: AsRawFd + Read> AsyncRead for Async<'l, F>

fn poll_read( self: Pin<&mut Self>, cx: &mut Context<'_>, buf: &mut [u8]) -> TaskPoll<Result<usize>>

fn poll_read_vectored( self: Pin<&mut Self>, cx: &mut Context<'_>, bufs: &mut [IoSliceMut<'_>]) -> TaskPoll<Result<usize>>

impl<'l, F: AsRawFd + Write> AsyncWrite for Async<'l, F>

fn poll_write( self: Pin<&mut Self>, cx: &mut Context<'_>, buf: &[u8]) -> TaskPoll<Result<usize>>

fn poll_write_vectored( self: Pin<&mut Self>, cx: &mut Context<'_>, bufs: &[IoSlice<'_>]) -> TaskPoll<Result<usize>>

fn poll_flush( self: Pin<&mut Self>, cx: &mut Context<'_>) -> TaskPoll<Result<()>>

fn poll_close( self: Pin<&mut Self>, cx: &mut Context<'_>) -> TaskPoll<Result<()>>

impl<'l, F: AsRawFd + Debug> Debug for Async<'l, F>

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

impl<'l, F: AsRawFd> Drop for Async<'l, F>

fn drop(&mut self)

impl<'l, F: AsRawFd> Unpin for Async<'l, F>

Auto Trait Implementations

impl<'l, F> !RefUnwindSafe for Async<'l, F>

impl<'l, F> !Send for Async<'l, F>

impl<'l, F> !Sync for Async<'l, F>

impl<'l, F> !UnwindSafe for Async<'l, F>

Blanket Implementations

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

fn type_id(&self) -> TypeId

impl<R> AsyncReadExt for R where R: AsyncRead + ?Sized,

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

fn read(&'a mut self, buf: &'a mut [u8]) -> Read<'a, Self> where Self: Unpin,

fn read_vectored( &'a mut self, bufs: &'a mut [IoSliceMut<'a>]) -> ReadVectored<'a, Self> where Self: Unpin,

fn read_exact(&'a mut self, buf: &'a mut [u8]) -> ReadExact<'a, Self> where Self: Unpin,

fn read_to_end( &'a mut self, buf: &'a mut Vec<u8, Global>) -> ReadToEnd<'a, Self> where Self: Unpin,

fn read_to_string(&'a mut self, buf: &'a mut String) -> ReadToString<'a, Self> where Self: Unpin,

fn split(self) -> (ReadHalf<Self>, WriteHalf<Self>) where Self: AsyncWrite,

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

impl<W> AsyncWriteExt for W where W: AsyncWrite + ?Sized,

fn flush(&mut self) -> Flush<'_, Self> where Self: Unpin,

fn close(&mut self) -> Close<'_, Self> where Self: Unpin,

fn write(&'a mut self, buf: &'a [u8]) -> Write<'a, Self> where Self: Unpin,

fn write_vectored( &'a mut self, bufs: &'a [IoSlice<'a>]) -> WriteVectored<'a, Self> where Self: Unpin,

fn write_all(&'a mut self, buf: &'a [u8]) -> WriteAll<'a, Self> where Self: Unpin,

fn into_sink<Item>(self) -> IntoSink<Self, Item> where Item: AsRef<[u8]>,

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

fn borrow(&self) -> &T

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

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

impl<T> From<T> for T

fn from(t: T) -> T

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

fn into(self) -> U

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

type Error = Infallible

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

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

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

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

pub fn readable<'s>(&'s mut self) -> Readable<'s, 'l, F>ⓘNotable traits for Readable<'s, 'l, F>`impl<'s, 'l, F: AsRawFd> Future for Readable<'s, 'l, F> type Output = ();`

pub fn writable<'s>(&'s mut self) -> Writable<'s, 'l, F>ⓘNotable traits for Writable<'s, 'l, F>`impl<'s, 'l, F: AsRawFd> Future for Writable<'s, 'l, F> type Output = ();`

fn poll_read(
self: Pin<&mut Self>,
cx: &mut Context<'_>,
buf: &mut [u8]
) -> TaskPoll<Result<usize>>

fn poll_read_vectored(
self: Pin<&mut Self>,
cx: &mut Context<'_>,
bufs: &mut [IoSliceMut<'_>]
) -> TaskPoll<Result<usize>>

fn poll_write(
self: Pin<&mut Self>,
cx: &mut Context<'_>,
buf: &[u8]
) -> TaskPoll<Result<usize>>

fn poll_write_vectored(
self: Pin<&mut Self>,
cx: &mut Context<'_>,
bufs: &[IoSlice<'_>]
) -> TaskPoll<Result<usize>>

fn poll_flush(
self: Pin<&mut Self>,
cx: &mut Context<'_>
) -> TaskPoll<Result<()>>

fn poll_close(
self: Pin<&mut Self>,
cx: &mut Context<'_>
) -> TaskPoll<Result<()>>

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

impl<R> AsyncReadExt for R where
R: AsyncRead + ?Sized,

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

fn read(&'a mut self, buf: &'a mut [u8]) -> Read<'a, Self> where
Self: Unpin,

fn read_vectored(
&'a mut self,
bufs: &'a mut [IoSliceMut<'a>]
) -> ReadVectored<'a, Self> where
Self: Unpin,

fn read_exact(&'a mut self, buf: &'a mut [u8]) -> ReadExact<'a, Self> where
Self: Unpin,

fn read_to_end(
&'a mut self,
buf: &'a mut Vec<u8, Global>
) -> ReadToEnd<'a, Self> where
Self: Unpin,

fn read_to_string(&'a mut self, buf: &'a mut String) -> ReadToString<'a, Self> where
Self: Unpin,

fn split(self) -> (ReadHalf<Self>, WriteHalf<Self>) where
Self: AsyncWrite,

impl<W> AsyncWriteExt for W where
W: AsyncWrite + ?Sized,

fn flush(&mut self) -> Flush<'_, Self> where
Self: Unpin,

fn close(&mut self) -> Close<'_, Self> where
Self: Unpin,

fn write(&'a mut self, buf: &'a [u8]) -> Write<'a, Self> where
Self: Unpin,

fn write_vectored(
&'a mut self,
bufs: &'a [IoSlice<'a>]
) -> WriteVectored<'a, Self> where
Self: Unpin,

fn write_all(&'a mut self, buf: &'a [u8]) -> WriteAll<'a, Self> where
Self: Unpin,

fn into_sink<Item>(self) -> IntoSink<Self, Item> where
Item: AsRef<[u8]>,

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

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

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

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

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