pub trait StringWriteExt: ByteOutput {
// Required methods
fn write_utf8_payload(&mut self, value: &str) -> Result<()>;
fn write_utf8_string_uleb_usize(&mut self, value: &str) -> Result<()>;
fn write_utf8_string_uleb_u64(&mut self, value: &str) -> Result<()>;
fn write_string_with_u16_len(
&mut self,
value: &str,
byte_order: ByteOrder,
) -> Result<()>;
fn write_string_with_u16_len_be(&mut self, value: &str) -> Result<()>;
fn write_string_with_u16_len_le(&mut self, value: &str) -> Result<()>;
fn write_string_with_u32_len(
&mut self,
value: &str,
byte_order: ByteOrder,
) -> Result<()>;
fn write_string_with_u32_len_be(&mut self, value: &str) -> Result<()>;
fn write_string_with_u32_len_le(&mut self, value: &str) -> Result<()>;
}Expand description
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']);Required Methods§
Sourcefn write_utf8_payload(&mut self, value: &str) -> Result<()>
fn write_utf8_payload(&mut self, value: &str) -> Result<()>
Sourcefn write_utf8_string_uleb_usize(&mut self, value: &str) -> Result<()>
fn write_utf8_string_uleb_usize(&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.
Sourcefn write_utf8_string_uleb_u64(&mut self, value: &str) -> Result<()>
fn write_utf8_string_uleb_u64(&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.
Sourcefn write_string_with_u16_len(
&mut self,
value: &str,
byte_order: ByteOrder,
) -> Result<()>
fn write_string_with_u16_len( &mut self, value: &str, byte_order: ByteOrder, ) -> 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.
Sourcefn write_string_with_u16_len_be(&mut self, value: &str) -> Result<()>
fn write_string_with_u16_len_be(&mut self, value: &str) -> 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.
Sourcefn write_string_with_u16_len_le(&mut self, value: &str) -> Result<()>
fn write_string_with_u16_len_le(&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.
Sourcefn write_string_with_u32_len(
&mut self,
value: &str,
byte_order: ByteOrder,
) -> Result<()>
fn write_string_with_u32_len( &mut self, value: &str, byte_order: ByteOrder, ) -> 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.
Sourcefn write_string_with_u32_len_be(&mut self, value: &str) -> Result<()>
fn write_string_with_u32_len_be(&mut self, value: &str) -> 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.
Sourcefn write_string_with_u32_len_le(&mut self, value: &str) -> Result<()>
fn write_string_with_u32_len_le(&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.
Dyn Compatibility§
This trait is dyn compatible.
In older versions of Rust, dyn compatibility was called "object safety".