Struct sailfish::runtime::Buffer

pub struct Buffer { /* private fields */ }

Buffer for rendered contents

This struct is quite simular to String, but some methods are re-implemented for faster buffering.

Implementations

impl Buffer

pub const fn new() -> Buffer

Create an empty buffer

pub fn with_capacity(n: usize) -> Buffer

Create a empty buffer with a particular capacity

pub fn as_str(&self) -> &str

Extracts a string slice containing the entire buffer

pub fn as_mut_ptr(&self) -> *mut u8

Returns an unsafe mutable pointer to the inner data

pub fn len(&self) -> usize

Returns the length of this buffer in bytes

pub fn capacity(&self) -> usize

Returns this buffer’s capacity in bytes

pub unsafe fn advance(&mut self, additional: usize)

Increase the length of buffer by additional bytes

Safety

• additional must be less than or equal to capacity() - len()
• The elements at old_len..old_len + additional must be initialized

pub fn is_empty(&self) -> bool

Returns true if this buffer has a length of zero, and false otherwise

pub fn reserve(&mut self, size: usize)

Same as String::reserve

Panics

This method panics if size overflows isize::MAX.

pub fn into_string(self) -> String

Converts a Buffer into a String without copy/realloc operation.

pub fn push_str(&mut self, data: &str)

Appends a given string slice onto the end of this buffer

pub fn push(&mut self, data: char)

Appends the given char to the end of this buffer

Trait Implementations

impl Add<&str> for Buffer

type Output = Buffer

The resulting type after applying the + operator.

fn add(self, other: &str) -> Buffer

Performs the + operation.

impl AddAssign<&str> for Buffer

fn add_assign(&mut self, other: &str)

Performs the += operation.

impl Clone for Buffer

fn clone(&self) -> Self

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for Buffer

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

Formats the value using the given formatter.

impl Default for Buffer

fn default() -> Buffer

Returns the “default value” for a type.

impl Drop for Buffer

fn drop(&mut self)

Executes the destructor for this type.

impl From<&str> for Buffer

fn from(other: &str) -> Buffer

Converts to this type from the input type.

impl From<String> for Buffer

fn from(other: String) -> Buffer

Shrink the data and pass raw pointer directory to buffer

This operation is O(1)

impl Write for Buffer

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.

impl Send for Buffer

impl Sync for Buffer