qubit-io-binary 0.8.6

Synchronous and asynchronous binary stream I/O adapters for Rust
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
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
// =============================================================================
//    Copyright (c) 2026 Haixing Hu.
//
//    SPDX-License-Identifier: Apache-2.0
//
//    Licensed under the Apache License, Version 2.0.
// =============================================================================
//! Extension methods for writing length-prefixed UTF-8 strings.

use std::io::Result;

use qubit_codec::ByteOrder;
use qubit_io::ByteOutput;

use crate::BinaryWriteExt;
use crate::Leb128WriteExt;
use crate::util::checked_u64_len;
use crate::util::write_all;
use crate::util::write_utf8_payload as write_utf8_payload_impl;
use crate::util::write_utf8_string_with_u16_len;
use crate::util::write_utf8_string_with_u32_len;

/// Extension methods for writing length-prefixed UTF-8 strings.
///
/// A failed write can leave the prefix or payload bytes already written to the
/// output. Length-prefixed methods are not transactional: retrying the whole
/// method can append a second length prefix. Recover using the enclosing
/// protocol's framing or transaction boundary instead.
///
/// # Examples
///
/// ```
/// use qubit_io_binary::StringWriteExt;
///
/// let mut output = Vec::new();
/// output.write_string_with_u16_len_be("Ada")?;
/// assert_eq!(output, [0, 3, b'A', b'd', b'a']);
/// # Ok::<(), std::io::Error>(())
/// ```
pub trait StringWriteExt: ByteOutput {
    /// Writes a UTF-8 payload without a length prefix.
    ///
    /// # Parameters
    ///
    /// - `value`: String slice to write.
    ///
    /// # Returns
    ///
    /// Returns after the payload has been written.
    ///
    /// # Errors
    ///
    /// Returns an I/O error from the underlying writer.
    fn write_utf8_payload(&mut self, value: &str) -> Result<()>;

    /// Writes a UTF-8 string with an unsigned LEB128 byte-length prefix.
    ///
    /// The length prefix is encoded as `usize`, so this format is target-width
    /// dependent. Prefer `u16` or `u32` length-prefix methods for persistent
    /// files and cross-platform protocols.
    ///
    /// # Parameters
    ///
    /// - `value`: String slice to write.
    ///
    /// # Returns
    ///
    /// Returns after the prefix and payload have been written.
    ///
    /// # Errors
    ///
    /// Returns an I/O error from the underlying writer.
    fn write_utf8_string_uleb_usize(&mut self, value: &str) -> Result<()>;

    /// Writes a UTF-8 string with an unsigned LEB128 `u64` byte-length prefix.
    ///
    /// Prefer this method over [`Self::write_utf8_string_uleb_usize`] for
    /// persistent files and cross-platform protocols because the length
    /// field is independent of the current Rust target's pointer width.
    ///
    /// # Parameters
    ///
    /// - `value`: String slice to write.
    ///
    /// # Returns
    ///
    /// Returns after the prefix and payload have been written.
    ///
    /// # Errors
    ///
    /// Returns [`std::io::ErrorKind::InvalidInput`] when the UTF-8 byte length
    /// cannot be represented as `u64`, or an I/O error from the underlying
    /// writer.
    fn write_utf8_string_uleb_u64(&mut self, value: &str) -> Result<()>;

    /// Writes a UTF-8 string with a runtime-order `u16` byte-length prefix.
    ///
    /// # Parameters
    ///
    /// - `value`: String slice to write.
    /// - `byte_order`: Byte order used by the length prefix.
    ///
    /// # Returns
    ///
    /// Returns after the prefix and payload have been written.
    ///
    /// # Errors
    ///
    /// Returns [`std::io::ErrorKind::InvalidInput`] when the UTF-8 byte length
    /// does not fit into `u16`, or an I/O error from the underlying writer.
    fn write_string_with_u16_len(&mut self, value: &str, byte_order: ByteOrder) -> Result<()>;

    /// Writes a UTF-8 string with a big-endian `u16` byte-length prefix.
    ///
    /// # Parameters
    ///
    /// - `value`: String slice to write.
    ///
    /// # Returns
    ///
    /// Returns after the prefix and payload have been written.
    ///
    /// # Errors
    ///
    /// Returns [`std::io::ErrorKind::InvalidInput`] when the UTF-8 byte length
    /// does not fit into `u16`, or an I/O error from the underlying writer.
    fn write_string_with_u16_len_be(&mut self, value: &str) -> Result<()>;

    /// Writes a UTF-8 string with a little-endian `u16` byte-length prefix.
    ///
    /// # Parameters
    ///
    /// - `value`: String slice to write.
    ///
    /// # Returns
    ///
    /// Returns after the prefix and payload have been written.
    ///
    /// # Errors
    ///
    /// Returns [`std::io::ErrorKind::InvalidInput`] when the UTF-8 byte length
    /// does not fit into `u16`, or an I/O error from the underlying writer.
    fn write_string_with_u16_len_le(&mut self, value: &str) -> Result<()>;

    /// Writes a UTF-8 string with a runtime-order `u32` byte-length prefix.
    ///
    /// # Parameters
    ///
    /// - `value`: String slice to write.
    /// - `byte_order`: Byte order used by the length prefix.
    ///
    /// # Returns
    ///
    /// Returns after the prefix and payload have been written.
    ///
    /// # Errors
    ///
    /// Returns [`std::io::ErrorKind::InvalidInput`] when the UTF-8 byte length
    /// does not fit into `u32`, or an I/O error from the underlying writer.
    fn write_string_with_u32_len(&mut self, value: &str, byte_order: ByteOrder) -> Result<()>;

    /// Writes a UTF-8 string with a big-endian `u32` byte-length prefix.
    ///
    /// # Parameters
    ///
    /// - `value`: String slice to write.
    ///
    /// # Returns
    ///
    /// Returns after the prefix and payload have been written.
    ///
    /// # Errors
    ///
    /// Returns [`std::io::ErrorKind::InvalidInput`] when the UTF-8 byte length
    /// does not fit into `u32`, or an I/O error from the underlying writer.
    fn write_string_with_u32_len_be(&mut self, value: &str) -> Result<()>;

    /// Writes a UTF-8 string with a little-endian `u32` byte-length prefix.
    ///
    /// # Parameters
    ///
    /// - `value`: String slice to write.
    ///
    /// # Returns
    ///
    /// Returns after the prefix and payload have been written.
    ///
    /// # Errors
    ///
    /// Returns [`std::io::ErrorKind::InvalidInput`] when the UTF-8 byte length
    /// does not fit into `u32`, or an I/O error from the underlying writer.
    fn write_string_with_u32_len_le(&mut self, value: &str) -> Result<()>;
}

impl<T> StringWriteExt for T
where
    T: ByteOutput + ?Sized,
{
    /// Writes the string's UTF-8 bytes without adding a length prefix.
    ///
    /// A write failure may occur after some payload bytes have reached the
    /// underlying output.
    ///
    /// # Parameters
    ///
    /// - `value`: UTF-8 string whose bytes are written to the output.
    ///
    /// # Returns
    ///
    /// Returns after all UTF-8 payload bytes have been written.
    ///
    /// # Errors
    ///
    /// Returns an I/O error from the underlying output.
    #[inline]
    fn write_utf8_payload(&mut self, value: &str) -> Result<()> {
        write_utf8_payload_impl(self, value)
    }

    /// Writes the UTF-8 byte length as target-width-dependent unsigned LEB128,
    /// followed by the string bytes.
    ///
    /// A failure can leave a partial prefix or payload in the output.
    ///
    /// # Parameters
    ///
    /// - `value`: UTF-8 string to write after its target-width-dependent byte
    ///   length.
    ///
    /// # Returns
    ///
    /// Returns after the length prefix and payload have been written.
    ///
    /// # Errors
    ///
    /// Returns an I/O error from writing the prefix or payload.
    #[inline]
    fn write_utf8_string_uleb_usize(&mut self, value: &str) -> Result<()> {
        let bytes = value.as_bytes();
        self.write_uleb_usize(bytes.len())?;
        write_all(self, bytes)
    }

    /// Writes the UTF-8 byte length as unsigned LEB128 `u64`, then the string
    /// bytes.
    ///
    /// Returns `InvalidInput` if the byte length does not fit in `u64`; a
    /// write failure can leave a partial prefix or payload in the output.
    ///
    /// # Parameters
    ///
    /// - `value`: UTF-8 string to write after its `u64` byte length.
    ///
    /// # Returns
    ///
    /// Returns after the length prefix and payload have been written.
    ///
    /// # Errors
    ///
    /// Returns `InvalidInput` if the byte length does not fit in `u64`, or an
    /// I/O error while writing.
    #[inline]
    fn write_utf8_string_uleb_u64(&mut self, value: &str) -> Result<()> {
        let bytes = value.as_bytes();
        self.write_uleb_u64(checked_u64_len(bytes.len())?)?;
        write_all(self, bytes)
    }

    /// Writes a `u16` UTF-8 byte-length prefix in the requested byte order,
    /// followed by the string bytes.
    ///
    /// Returns `InvalidInput` if the byte length exceeds `u16::MAX`; a write
    /// failure can leave a partial prefix or payload in the output.
    ///
    /// # Parameters
    ///
    /// - `value`: UTF-8 string to write after its `u16` byte length.
    /// - `byte_order`: Byte order used to encode the length prefix.
    ///
    /// # Returns
    ///
    /// Returns after the length prefix and payload have been written.
    ///
    /// # Errors
    ///
    /// Returns `InvalidInput` if the byte length exceeds `u16::MAX`, or an
    /// I/O error while writing.
    #[inline]
    fn write_string_with_u16_len(&mut self, value: &str, byte_order: ByteOrder) -> Result<()> {
        write_utf8_string_with_u16_len(self, value, |writer, len| writer.write_u16(len, byte_order))
    }

    /// Writes a big-endian `u16` UTF-8 byte-length prefix, then the string
    /// bytes.
    ///
    /// Returns `InvalidInput` if the byte length exceeds `u16::MAX`; a write
    /// failure can leave a partial prefix or payload in the output.
    ///
    /// # Parameters
    ///
    /// - `value`: UTF-8 string to write after its big-endian `u16` byte length.
    ///
    /// # Returns
    ///
    /// Returns after the length prefix and payload have been written.
    ///
    /// # Errors
    ///
    /// Returns `InvalidInput` if the byte length exceeds `u16::MAX`, or an
    /// I/O error while writing.
    #[inline]
    fn write_string_with_u16_len_be(&mut self, value: &str) -> Result<()> {
        write_utf8_string_with_u16_len(self, value, |writer, len| writer.write_u16_be(len))
    }

    /// Writes a little-endian `u16` UTF-8 byte-length prefix, then the string
    /// bytes.
    ///
    /// Returns `InvalidInput` if the byte length exceeds `u16::MAX`; a write
    /// failure can leave a partial prefix or payload in the output.
    ///
    /// # Parameters
    ///
    /// - `value`: UTF-8 string to write after its little-endian `u16` byte
    ///   length.
    ///
    /// # Returns
    ///
    /// Returns after the length prefix and payload have been written.
    ///
    /// # Errors
    ///
    /// Returns `InvalidInput` if the byte length exceeds `u16::MAX`, or an
    /// I/O error while writing.
    #[inline]
    fn write_string_with_u16_len_le(&mut self, value: &str) -> Result<()> {
        write_utf8_string_with_u16_len(self, value, |writer, len| writer.write_u16_le(len))
    }

    /// Writes a `u32` UTF-8 byte-length prefix in the requested byte order,
    /// followed by the string bytes.
    ///
    /// Returns `InvalidInput` if the byte length exceeds `u32::MAX`; a write
    /// failure can leave a partial prefix or payload in the output.
    ///
    /// # Parameters
    ///
    /// - `value`: UTF-8 string to write after its `u32` byte length.
    /// - `byte_order`: Byte order used to encode the length prefix.
    ///
    /// # Returns
    ///
    /// Returns after the length prefix and payload have been written.
    ///
    /// # Errors
    ///
    /// Returns `InvalidInput` if the byte length exceeds `u32::MAX`, or an
    /// I/O error while writing.
    #[inline]
    fn write_string_with_u32_len(&mut self, value: &str, byte_order: ByteOrder) -> Result<()> {
        write_utf8_string_with_u32_len(self, value, |writer, len| writer.write_u32(len, byte_order))
    }

    /// Writes a big-endian `u32` UTF-8 byte-length prefix, then the string
    /// bytes.
    ///
    /// Returns `InvalidInput` if the byte length exceeds `u32::MAX`; a write
    /// failure can leave a partial prefix or payload in the output.
    ///
    /// # Parameters
    ///
    /// - `value`: UTF-8 string to write after its big-endian `u32` byte length.
    ///
    /// # Returns
    ///
    /// Returns after the length prefix and payload have been written.
    ///
    /// # Errors
    ///
    /// Returns `InvalidInput` if the byte length exceeds `u32::MAX`, or an
    /// I/O error while writing.
    #[inline]
    fn write_string_with_u32_len_be(&mut self, value: &str) -> Result<()> {
        write_utf8_string_with_u32_len(self, value, |writer, len| writer.write_u32_be(len))
    }

    /// Writes a little-endian `u32` UTF-8 byte-length prefix, then the string
    /// bytes.
    ///
    /// Returns `InvalidInput` if the byte length exceeds `u32::MAX`; a write
    /// failure can leave a partial prefix or payload in the output.
    ///
    /// # Parameters
    ///
    /// - `value`: UTF-8 string to write after its little-endian `u32` byte
    ///   length.
    ///
    /// # Returns
    ///
    /// Returns after the length prefix and payload have been written.
    ///
    /// # Errors
    ///
    /// Returns `InvalidInput` if the byte length exceeds `u32::MAX`, or an
    /// I/O error while writing.
    #[inline]
    fn write_string_with_u32_len_le(&mut self, value: &str) -> Result<()> {
        write_utf8_string_with_u32_len(self, value, |writer, len| writer.write_u32_le(len))
    }
}