Struct xous::stringbuffer::StringBuffer

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

A buffered String suitable for sending across as a message

Implementations

impl<'a> StringBuffer<'a>

pub fn new() -> Self

Create a new StringBuffer with no backing. This will get resized as soon as data is written to it.

pub fn with_capacity(capacity: usize) -> Self

Create a new StringBuffer with enough space to hold usize characters

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

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

pub fn as_str(&self) -> Result<&str, Utf8Error>

pub fn len(&self) -> usize

pub fn is_empty(&self) -> bool

pub fn clear(&mut self)

Clear the contents of this String and set the length to 0

pub fn to_str(&self) -> &str

pub unsafe fn from_memory_message(mem: &'a MemoryMessage) -> Self

Safety

This can turn any MemoryMessage into a StringBuffer, so ensure that this function is only called when the contents are a StringBuffer

pub unsafe fn from_memory_message_mut(mem: &'a mut MemoryMessage) -> Self

Safety

This can turn any MemoryMessage into a StringBuffer, so ensure that this function is only called when the contents are a StringBuffer

pub fn lend_mut(&mut self, connection: CID, id: u32) -> Result<Result, Error>

Perform a mutable lend of this String to the server.

pub fn lend(&self, connection: CID, id: u32) -> Result<Result, Error>

pub fn send(self, connection: CID, id: u32) -> Result<Result, Error>

Trait Implementations

impl<'a> AsRef<str> for StringBuffer<'a>

fn as_ref(&self) -> &str

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

impl<'a> Debug for StringBuffer<'a>

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

Formats the value using the given formatter.

impl<'a> Default for StringBuffer<'a>

fn default() -> Self

Returns the “default value” for a type.

impl<'a> Display for StringBuffer<'a>

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

Formats the value using the given formatter.

impl<'a> Drop for StringBuffer<'a>

fn drop(&mut self)

Executes the destructor for this type.

impl<'a> FromStr for StringBuffer<'a>

type Err = &'static str

The associated error which can be returned from parsing.

fn from_str(src: &str) -> Result<StringBuffer<'a>, &'static str>

Parses a string s to return a value of this type.

impl<'a> PartialEq<StringBuffer<'a>> for StringBuffer<'a>

fn eq(&self, other: &Self) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl<'a> Write for StringBuffer<'a>

fn write_str(&mut self, s: &str) -> Result<(), Error>

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<'a> Eq for StringBuffer<'a>