[−][src]Struct minicbor_io::AsyncWriter
Wraps an AsyncWrite
and writes length-delimited CBOR values.
Requires cargo feature "async-io"
.
Implementations
impl<W> AsyncWriter<W>
[src]
pub fn new(writer: W) -> Self
[src]
Create a new writer with a max. buffer size of 512KiB.
pub fn with_buffer(writer: W, buffer: Vec<u8>) -> Self
[src]
Create a new writer with a max. buffer size of 512KiB.
pub fn set_max_len(&mut self, val: u32)
[src]
Set the max. buffer size in bytes.
If length values greater than this are encoded, an
Error::InvalidLen
will be returned.
pub fn writer(&self) -> &W
[src]
Get a reference to the inner writer.
pub fn writer_mut(&mut self) -> &mut W
[src]
Get a mutable reference to the inner writer.
pub fn into_parts(self) -> (W, Vec<u8>)
[src]
Deconstruct this writer into the inner writer and the buffer.
impl<W: AsyncWrite + Unpin> AsyncWriter<W>
[src]
pub async fn write<T: Encode>(&mut self, val: T) -> Result<usize, Error>
[src]
Encode and write a CBOR value and return its size in bytes.
The value will be preceded by a u32
(4 bytes in network byte order),
denoting the length of bytes constituting the serialised value.
Cancellation
If the future returned by AsyncWriter::write
is dropped while still
pending, subsequent calls to AsyncWriter::write
will discard any
buffered data and instead encode, buffer and commit the new value.
Cancelling a future thus cancels the transfer. However, it is also
possible to resume the transfer by calling AsyncWriter::sync
after cancellation, which is normally called implicitly by this method.
pub async fn sync(&mut self) -> Result<(), Error>
[src]
Commit any buffered data to the inner AsyncWrite
.
This method is implicitly called by AsyncWriter::write
. The only
reason to call it explicitly is to resume the write operation started
by a previously unfinished, i.e. cancelled, AsyncWriter::write
call.
pub async fn flush(&mut self) -> Result<(), Error>
[src]
Flush the inner AsyncWrite
.
Trait Implementations
Auto Trait Implementations
impl<W> RefUnwindSafe for AsyncWriter<W> where
W: RefUnwindSafe,
[src]
W: RefUnwindSafe,
impl<W> Send for AsyncWriter<W> where
W: Send,
[src]
W: Send,
impl<W> Sync for AsyncWriter<W> where
W: Sync,
[src]
W: Sync,
impl<W> Unpin for AsyncWriter<W> where
W: Unpin,
[src]
W: Unpin,
impl<W> UnwindSafe for AsyncWriter<W> where
W: UnwindSafe,
[src]
W: UnwindSafe,
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,
pub 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.
pub 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>,