Struct UiBuffer

pub struct UiBuffer {
    pub buffer: Vec<u8>,
    pub max_len: usize,
}

this is the unsafe cell upon which we build our abstraction.

Fields

buffer: Vec<u8>

max_len: usize

Implementations

impl UiBuffer

pub const fn new(max_len: usize) -> UiBuffer

Creates a new max buffer with the given length.

pub fn scratch_txt(&mut self, txt: impl AsRef<str>) -> *const i8

Internal method to push a single text to our scratch buffer.

pub fn scratch_txt_opt(&mut self, txt: Option<impl AsRef<str>>) -> *const i8

Internal method to push an option text to our scratch buffer.

pub fn scratch_txt_two( &mut self, txt_0: impl AsRef<str>, txt_1: impl AsRef<str>, ) -> (*const i8, *const i8)

Helper method, same as Self::scratch_txt but for two strings

pub fn scratch_txt_with_opt( &mut self, txt_0: impl AsRef<str>, txt_1: Option<impl AsRef<str>>, ) -> (*const i8, *const i8)

Helper method, same as Self::scratch_txt but with one optional value

pub fn refresh_buffer(&mut self)

Attempts to clear the buffer if it’s over the maximum length allowed. This is to prevent us from making a giant vec over time.

pub unsafe fn offset(&self, pos: usize) -> *const i8

Given a position, gives an offset from the start of the scatch buffer.

Safety

This can return a pointer to undefined data if given a pos >= self.buffer.len(). This is marked as unsafe to reflect that.

pub fn push(&mut self, txt: impl AsRef<str>) -> usize

Pushes a new scratch sheet text and return the byte index where the sub-string starts.

Trait Implementations

impl Debug for UiBuffer

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

Formats the value using the given formatter.