qubit-io-binary 0.8.6

Synchronous and asynchronous binary stream I/O adapters for Rust
Documentation
// =============================================================================
//    Copyright (c) 2026 Haixing Hu.
//
//    SPDX-License-Identifier: Apache-2.0
//
//    Licensed under the Apache License, Version 2.0.
// =============================================================================
//! Asynchronous ZigZag writes.

use core::future::Future;
use std::io::Result;

use qubit_codec_binary::NonStrict;
use qubit_codec_binary::ZigZagCodec;
use qubit_io::AsyncOutput;

use crate::util::encode_infallible_unchecked;
use crate::util::write_all_async;

macro_rules! zig_zag_write_method {
    ($doc:literal, $name:ident, $ty:ty) => {
        #[doc = $doc]
        #[doc = ""]
        #[doc = "# Parameters"]
        #[doc = ""]
        #[doc = "- `value`: Signed integer to encode and write."]
        #[doc = ""]
        #[doc = "# Returns"]
        #[doc = ""]
        #[doc = "Returns a future that completes after the encoded payload \
                 has been written."]
        #[doc = ""]
        #[doc = "# Errors"]
        #[doc = ""]
        #[doc = "Returns an output error, including a write-zero error when \
                 the output stops making progress."]
        #[doc = ""]
        #[doc = "# Cancellation safety"]
        #[doc = ""]
        #[doc = "This operation is not cancellation safe. Dropping the future \
                 retains any bytes already written to the output."]
        #[inline(always)]
        fn $name(&mut self, value: $ty) -> impl Future<Output = Result<()>> + '_
        where
            Self: Unpin,
        {
            async move {
                let mut bytes = [0_u8; ZigZagCodec::<$ty, NonStrict>::MAX_ENCODE_UNITS_PER_VALUE];
                type Codec = ZigZagCodec<$ty, NonStrict>;
                // SAFETY: The local buffer has the codec's maximum payload
                // size.
                let len = unsafe { encode_infallible_unchecked::<Codec>(value, &mut bytes, 0) };
                write_all_async(self, &bytes[..len]).await
            }
        }
    };
}

/// Future-based ZigZag plus unsigned-LEB128 writes.
///
/// # Cancellation safety
///
/// These writes are not cancellation safe. Dropping a pending future leaves
/// an already-written prefix in the output.
///
/// # Examples
///
/// ```
/// use qubit_io::AsyncOutput;
/// use qubit_io_binary::AsyncZigZagWriteExt;
///
/// async fn write_value<O>(output: &mut O) -> std::io::Result<()>
/// where
///     O: AsyncOutput<Item = u8> + Unpin,
/// {
///     output.write_zig_zag_i32_async(-150).await
/// }
/// ```
pub trait AsyncZigZagWriteExt: AsyncOutput<Item = u8> {
    zig_zag_write_method!("Asynchronously writes ZigZag `i8`.", write_zig_zag_i8_async, i8);
    zig_zag_write_method!("Asynchronously writes ZigZag `i16`.", write_zig_zag_i16_async, i16);
    zig_zag_write_method!("Asynchronously writes ZigZag `i32`.", write_zig_zag_i32_async, i32);
    zig_zag_write_method!("Asynchronously writes ZigZag `i64`.", write_zig_zag_i64_async, i64);
    zig_zag_write_method!("Asynchronously writes ZigZag `i128`.", write_zig_zag_i128_async, i128);
    zig_zag_write_method!(
        "Asynchronously writes ZigZag `isize`.",
        write_zig_zag_isize_async,
        isize
    );
}

impl<W> AsyncZigZagWriteExt for W where W: AsyncOutput<Item = u8> + ?Sized {}