Skip to main content

AsyncStringWriteExt

Trait AsyncStringWriteExt 

Source
pub trait AsyncStringWriteExt: AsyncOutput<Item = u8> {
    // Provided methods
    fn write_utf8_payload_async<'a>(
        &'a mut self,
        value: &'a str,
    ) -> impl Future<Output = Result<()>> + 'a
       where Self: Unpin { ... }
    fn write_utf8_string_uleb_usize_async<'a>(
        &'a mut self,
        value: &'a str,
    ) -> impl Future<Output = Result<()>> + 'a
       where Self: Unpin { ... }
    fn write_utf8_string_uleb_u64_async<'a>(
        &'a mut self,
        value: &'a str,
    ) -> impl Future<Output = Result<()>> + 'a
       where Self: Unpin { ... }
    fn write_string_with_u16_len_async<'a>(
        &'a mut self,
        value: &'a str,
        byte_order: ByteOrder,
    ) -> impl Future<Output = Result<()>> + 'a
       where Self: Unpin { ... }
    fn write_string_with_u16_len_be_async<'a>(
        &'a mut self,
        value: &'a str,
    ) -> impl Future<Output = Result<()>> + 'a
       where Self: Unpin { ... }
    fn write_string_with_u16_len_le_async<'a>(
        &'a mut self,
        value: &'a str,
    ) -> impl Future<Output = Result<()>> + 'a
       where Self: Unpin { ... }
    fn write_string_with_u32_len_async<'a>(
        &'a mut self,
        value: &'a str,
        byte_order: ByteOrder,
    ) -> impl Future<Output = Result<()>> + 'a
       where Self: Unpin { ... }
    fn write_string_with_u32_len_be_async<'a>(
        &'a mut self,
        value: &'a str,
    ) -> impl Future<Output = Result<()>> + 'a
       where Self: Unpin { ... }
    fn write_string_with_u32_len_le_async<'a>(
        &'a mut self,
        value: &'a str,
    ) -> impl Future<Output = Result<()>> + 'a
       where Self: Unpin { ... }
}
Expand description

Future-based length-prefixed UTF-8 writes.

§Cancellation safety

These writes are not cancellation safe. Dropping a pending future leaves any already-written prefix or payload bytes in the output.

§Examples

The caller supplies an output that implements AsyncOutput, such as a file, socket, or in-memory sink:

use qubit_io::AsyncOutput;
use qubit_io_binary::AsyncStringWriteExt;

async fn write_name<O>(output: &mut O) -> std::io::Result<()>
where
    O: AsyncOutput<Item = u8> + Unpin,
{
    output.write_string_with_u16_len_be_async("Ada").await?;
    Ok(())
}

Provided Methods§

Source

fn write_utf8_payload_async<'a>( &'a mut self, value: &'a str, ) -> impl Future<Output = Result<()>> + 'a
where Self: Unpin,

Asynchronously writes a UTF-8 payload without a length prefix.

§Parameters
  • value: String payload to write.
§Returns

Returns a future that completes after the payload has been written.

§Errors

Returns an output error, including a write-zero error when the output stops making progress.

§Cancellation safety

This operation is not cancellation safe; dropping the future leaves any already-written payload prefix in the output.

Source

fn write_utf8_string_uleb_usize_async<'a>( &'a mut self, value: &'a str, ) -> impl Future<Output = Result<()>> + 'a
where Self: Unpin,

Asynchronously writes a target-width LEB128-length UTF-8 string.

§Parameters
  • value: String to length-prefix and write.
§Returns

Returns a future that completes after the prefix and payload are written.

§Errors

Returns an output error, including a write-zero error when the output stops making progress.

§Cancellation safety

This operation is not cancellation safe; dropping the future leaves any already-written prefix or payload bytes in the output.

Source

fn write_utf8_string_uleb_u64_async<'a>( &'a mut self, value: &'a str, ) -> impl Future<Output = Result<()>> + 'a
where Self: Unpin,

Asynchronously writes a u64 LEB128-length UTF-8 string.

§Parameters
  • value: String to length-prefix and write.
§Returns

Returns a future that completes after the prefix and payload are written.

§Errors

Returns an invalid-input error when the length cannot fit in u64, or an output error while writing.

§Cancellation safety

This operation is not cancellation safe; dropping the future leaves any already-written prefix or payload bytes in the output.

Source

fn write_string_with_u16_len_async<'a>( &'a mut self, value: &'a str, byte_order: ByteOrder, ) -> impl Future<Output = Result<()>> + 'a
where Self: Unpin,

Asynchronously writes a runtime-order u16-length UTF-8 string.

§Parameters
  • value: String to length-prefix and write.
  • byte_order: Byte order used to encode the length.
§Returns

Returns a future that completes after the prefix and payload are written.

§Errors

Returns an invalid-input error when the length exceeds u16::MAX, or an output error while writing.

§Cancellation safety

This operation is not cancellation safe; dropping the future leaves any already-written prefix or payload bytes in the output.

Source

fn write_string_with_u16_len_be_async<'a>( &'a mut self, value: &'a str, ) -> impl Future<Output = Result<()>> + 'a
where Self: Unpin,

Asynchronously writes a big-endian u16-length UTF-8 string.

§Parameters
  • value: String to length-prefix and write.
§Returns

Returns a future that completes after the prefix and payload are written.

§Errors

Returns an invalid-input error when the length exceeds u16::MAX, or an output error while writing.

§Cancellation safety

This operation is not cancellation safe; dropping the future leaves any already-written prefix or payload bytes in the output.

Source

fn write_string_with_u16_len_le_async<'a>( &'a mut self, value: &'a str, ) -> impl Future<Output = Result<()>> + 'a
where Self: Unpin,

Asynchronously writes a little-endian u16-length UTF-8 string.

§Parameters
  • value: String to length-prefix and write.
§Returns

Returns a future that completes after the prefix and payload are written.

§Errors

Returns an invalid-input error when the length exceeds u16::MAX, or an output error while writing.

§Cancellation safety

This operation is not cancellation safe; dropping the future leaves any already-written prefix or payload bytes in the output.

Source

fn write_string_with_u32_len_async<'a>( &'a mut self, value: &'a str, byte_order: ByteOrder, ) -> impl Future<Output = Result<()>> + 'a
where Self: Unpin,

Asynchronously writes a runtime-order u32-length UTF-8 string.

§Parameters
  • value: String to length-prefix and write.
  • byte_order: Byte order used to encode the length.
§Returns

Returns a future that completes after the prefix and payload are written.

§Errors

Returns an invalid-input error when the length exceeds u32::MAX, or an output error while writing.

§Cancellation safety

This operation is not cancellation safe; dropping the future leaves any already-written prefix or payload bytes in the output.

Source

fn write_string_with_u32_len_be_async<'a>( &'a mut self, value: &'a str, ) -> impl Future<Output = Result<()>> + 'a
where Self: Unpin,

Asynchronously writes a big-endian u32-length UTF-8 string.

§Parameters
  • value: String to length-prefix and write.
§Returns

Returns a future that completes after the prefix and payload are written.

§Errors

Returns an invalid-input error when the length exceeds u32::MAX, or an output error while writing.

§Cancellation safety

This operation is not cancellation safe; dropping the future leaves any already-written prefix or payload bytes in the output.

Source

fn write_string_with_u32_len_le_async<'a>( &'a mut self, value: &'a str, ) -> impl Future<Output = Result<()>> + 'a
where Self: Unpin,

Asynchronously writes a little-endian u32-length UTF-8 string.

§Parameters
  • value: String to length-prefix and write.
§Returns

Returns a future that completes after the prefix and payload are written.

§Errors

Returns an invalid-input error when the length exceeds u32::MAX, or an output error while writing.

§Cancellation safety

This operation is not cancellation safe; dropping the future leaves any already-written prefix or payload bytes in the output.

Dyn Compatibility§

This trait is not dyn compatible.

In older versions of Rust, dyn compatibility was called "object safety".

Implementors§

Source§

impl<W> AsyncStringWriteExt for W
where W: AsyncOutput<Item = u8> + ?Sized,