Struct StringFile 

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

FILE* wrapper over a string.

The last byte of the buffer is always reserved for a null character, which is only written by StringFile::take.

Implementations

impl<'a> StringFile<'a>

pub fn new(buffer: &'a mut [u8]) -> Self

Creates a StringFile that writes into buffer.

pub fn take(self) -> &'a mut [u8]

Adds a null character at the end of the current buffer and returns a view into the written section.

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

Returns bytes.len() and writes as much of bytes as it would fit in the buffer [offset, size - 1) while reserving the last byte for null character.

pub fn used_region(&self) -> &[u8]

Returns a region representing the currently used portion of the buffer.

pub fn available_region(&mut self) -> &mut [u8]

Returns a region representing the remaining unused space in the buffer, not including the space reserved for the final null character.

pub fn skip(&mut self, amount: usize)

Skip up to amount bytes in the buffer, advancing the write pointer as if we had written data, but without actually changing the buffer.

pub fn as_bytes(&self) -> &[u8]

Returns the currently used portion of the buffer, like C++ as_string_view().

pub fn with_file<R>( &mut self, f: impl for<'f> FnOnce(&mut ScopedFile<'f>) -> R, ) -> R

Calls f with a C++-compatible FILE whose output is written into this StringFile.

This lets C++ routines that render into a FILE* write into a Rust StringFile.

Trait Implementations

impl AsRef<[u8]> for StringFile<'_>

fn as_ref(&self) -> &[u8]

Converts this type into a shared reference of the (usually inferred) input type.

impl<'a> Debug for StringFile<'a>

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Write for StringFile<'_>

fn write_str(&mut self, s: &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.