Struct sval_buffer::TextBuf

pub struct TextBuf<'sval> { /* private fields */ }

Buffer text fragments into a single contiguous string.

In no-std environments, this buffer only supports a single borrowed text fragment. Other methods will fail.

Implementations

impl<'sval> TextBuf<'sval>

pub fn new() -> Self

Create a new empty text buffer.

pub fn collect(value: &'sval (impl Value + ?Sized)) -> Result<Self, Error>

Buffer a text value into a contiguous string.

pub fn collect_display(value: impl Display) -> Result<Self, Error>

Buffer a displayable value into a contiguous string.

pub fn clear(&mut self)

Clear the text buffer so it can be re-used.

pub fn push_fragment(&mut self, fragment: &'sval str) -> Result<(), Error>

Push a borrowed text fragment onto the buffer.

pub fn push_fragment_computed(&mut self, fragment: &str) -> Result<(), Error>

Push a computed text fragment onto the buffer.

If the std feature of this library is enabled, this method will buffer the fragment. In no-std environments this method will fail.

pub fn push_display(&mut self, value: impl Display) -> Result<(), Error>

Push a displayable value onto the buffer.

If the std feature of htis library is enabled, this method will buffer the fragment. In no-std environments this method will fail.

pub fn as_borrowed_str(&self) -> Option<&'sval str>

Try get the contents of the buffer as a string borrowed for the 'sval lifetime.

pub fn as_str(&self) -> &str

Get the contents of the buffer as a string.

Trait Implementations

impl<'sval> AsRef<str> for TextBuf<'sval>

fn as_ref(&self) -> &str

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

impl<'sval> Clone for TextBuf<'sval>

fn clone(&self) -> TextBuf<'sval>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<'sval> Debug for TextBuf<'sval>

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

Formats the value using the given formatter.

impl<'sval> Default for TextBuf<'sval>

fn default() -> Self

Returns the “default value” for a type.

impl<'sval> From<&'sval str> for TextBuf<'sval>

fn from(fragment: &'sval str) -> Self

Converts to this type from the input type.

impl<'sval> PartialEq<TextBuf<'sval>> for TextBuf<'sval>

fn eq(&self, other: &TextBuf<'sval>) -> 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> Value for TextBuf<'a>

fn stream<'sval, S: Stream<'sval> + ?Sized>( &'sval self, stream: &mut S ) -> Result

Stream this value through a Stream.

fn tag(&self) -> Option<Tag>

Get the tag of this value, if there is one.

fn to_bool(&self) -> Option<bool>

Try convert this value into a boolean.

fn to_f32(&self) -> Option<f32>

Try convert this value into a 32bit binary floating point number.

fn to_f64(&self) -> Option<f64>

Try convert this value into a 64bit binary floating point number.

fn to_i8(&self) -> Option<i8>

Try convert this value into a signed 8bit integer.

fn to_i16(&self) -> Option<i16>

Try convert this value into a signed 16bit integer.

fn to_i32(&self) -> Option<i32>

Try convert this value into a signed 32bit integer.

fn to_i64(&self) -> Option<i64>

Try convert this value into a signed 64bit integer.

fn to_i128(&self) -> Option<i128>

Try convert this value into a signed 128bit integer.

fn to_u8(&self) -> Option<u8>

Try convert this value into an unsigned 8bit integer.

fn to_u16(&self) -> Option<u16>

Try convert this value into an unsigned 16bit integer.

fn to_u32(&self) -> Option<u32>

Try convert this value into an unsigned 32bit integer.

fn to_u64(&self) -> Option<u64>

Try convert this value into an unsigned 64bit integer.

fn to_u128(&self) -> Option<u128>

Try convert this value into an unsigned 128bit integer.

fn to_text(&self) -> Option<&str>

Try convert this value into a text string.

fn to_binary(&self) -> Option<&[u8]>

Try convert this value into a bitstring.

impl<'sval> ValueRef<'sval> for TextBuf<'sval>

fn stream_ref<S: Stream<'sval> + ?Sized>(&self, stream: &mut S) -> Result

Stream this value through a Stream.

impl<'sval> Write for TextBuf<'sval>

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<'sval> Eq for TextBuf<'sval>

impl<'sval> StructuralEq for TextBuf<'sval>

impl<'sval> StructuralPartialEq for TextBuf<'sval>