Struct MemBufStr

pub struct MemBufStr<'a> { /* private fields */ }

Available on crate feature format only.

A structure which acts similar to a FixedBufStr but borrows from a buffer instead of owning a stack allocation.

Implementations

impl<'a> MemBufStr<'a>

pub unsafe fn wrap_uninit( len: &'a mut usize, buffer: &'a mut [MaybeUninit<u8>], ) -> MemBufStr<'a>

Wraps a memory buffer with its length in a new string buffer.

Safety

It is UB to construct a MemBufStr if len is not a valid position in the buffer buffer. It is also UB to construct a MemBufStr from a buffer which does not contain only UTF-8 bytes. If len points to uninitialized memory in buffer constructing MemBufStr is UB.

pub unsafe fn wrap(len: &'a mut usize, buffer: &'a mut [u8]) -> MemBufStr<'a>

Wraps a memory buffer with its length in a new string buffer.

Safety

It is UB to construct a MemBufStr if len is not a valid position in the buffer buffer. It is also UB to construct a MemBufStr from a buffer which does not contain only UTF-8 bytes.

pub fn str(&self) -> &str

Extracts the string from this buffer.

pub unsafe fn write(&mut self, buf: &[u8]) -> usize

Appends a raw byte buffer at the end of this string buffer.

Returns the number of bytes written.

Arguments

• buf: the raw byte buffer to append.

returns: usize

Safety

• MemBufStr contains only valid UTF-8 strings so buf must contain only valid UTF-8 bytes.
• If buf contains invalid UTF-8 bytes, further operations on the log message buffer may result in UB.

Trait Implementations

impl Write for MemBufStr<'_>

fn write_str(&mut self, value: &str) -> Result

Writes a string slice into this writer, returning whether the write succeeded.

fn write_char(&mut self, c: char) -> Result<(), Error>

Writes a char into this writer, returning whether the write succeeded.

fn write_fmt(&mut self, args: Arguments<'_>) -> Result<(), Error>

Glue for usage of the write! macro with implementors of this trait.