noxtls-io 0.1.3

Internal implementation crate for noxtls: transport traits and blocking/async TLS record I/O adapters.
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70

// Copyright (c) 2019-2026, Argenox Technologies LLC
// All rights reserved.
//
// SPDX-License-Identifier: GPL-2.0-only OR LicenseRef-Argenox-Commercial-License
//
// This file is part of the NoxTLS Library.
//
// This program is free software: you can redistribute it and/or modify
// it under the terms of the GNU General Public License as published by the
// Free Software Foundation; version 2 of the License.
//
// Alternatively, this file may be used under the terms of a commercial
// license from Argenox Technologies LLC.
//
// See `noxtls/LICENSE` and `noxtls/LICENSE.md` in this repository for full details.
// CONTACT: info@argenox.com

//! Async byte stream trait used by TLS record drivers without tying callers to a specific runtime.
//!
//! Available when `adapter-embedded-io-async` or `adapter-tokio` is enabled alongside this module.

use async_trait::async_trait;

use super::TransportError;

/// Async byte stream for TLS record framing without assuming a specific runtime.
///
/// Uses `?Send` so `embedded-io-async` transports that are not `Send` remain usable.
#[async_trait(?Send)]
pub trait AsyncByteStream {
    /// Reads up to `buf.len()` bytes asynchronously into `buf`.
    ///
    /// # Arguments
    ///
    /// * `self` — Async transport endpoint.
    /// * `buf` — Destination buffer; only the first returned count of bytes are defined.
    ///
    /// # Returns
    ///
    /// On success, the number of bytes read into `buf`.
    ///
    /// # Errors
    ///
    /// Returns [`TransportError`] variants when the underlying async read fails.
    ///
    /// # Panics
    ///
    /// Implementations should not panic; callers treat panics as a defect in the adapter.
    async fn read_async(&mut self, buf: &mut [u8]) -> Result<usize, TransportError>;

    /// Writes every byte in `data` asynchronously before returning `Ok`.
    ///
    /// # Arguments
    ///
    /// * `self` — Async transport endpoint.
    /// * `data` — Slice whose entire contents must be transmitted.
    ///
    /// # Returns
    ///
    /// `Ok(())` when all bytes are accepted and any required flushing completes successfully.
    ///
    /// # Errors
    ///
    /// Returns [`TransportError`] variants when the underlying async write or flush fails.
    ///
    /// # Panics
    ///
    /// Implementations should not panic; callers treat panics as a defect in the adapter.
    async fn write_all_async(&mut self, data: &[u8]) -> Result<(), TransportError>;
}