Enum KStringWriter

pub enum KStringWriter {
    Inline(StackString<{ KString::MAX_INLINE_LEN }>),
    Owned(String),
}

A writer that can append formatted text to either an inline StackString or a heap-allocated String.

The KStringWriter starts writing into a stack-allocated StackString for efficiency. If the capacity of the inline storage is exceeded, it switches to using a heap-allocated String. This allows for efficient formatting without unnecessary allocations in cases where the formatted text fits within the inline buffer.

Examples

use lstring::{KString, KStringWriter};
use core::fmt::Write;

let mut writer = KStringWriter::default();
write!(writer, "Hello, {}!", "world").unwrap();
let s: KString = writer.into();
assert_eq!(s, "Hello, world!");

Variants

Inline(StackString<{ KString::MAX_INLINE_LEN }>)

Owned(String)

Implementations

impl KStringWriter

pub fn new() -> Self

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

Reserves additional capacity for the KStringWriter.

If the writer is currently using an inline StackString and the requested capacity exceeds its maximum inline length, it will switch to a heap-allocated String. This method ensures that subsequent writes do not require reallocations if the specified capacity is available.

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

Appends a single character to the KStringWriter.

Examples

use lstring::KStringWriter;

let mut writer = KStringWriter::default();
writer.push('a');
assert_eq!(writer.as_ref(), "a");

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

Appends a string slice to the KStringWriter.

Examples

use lstring::KStringWriter;

let mut writer = KStringWriter::default();
writer.push_str("abc");
assert_eq!(writer.as_ref(), "abc");

Trait Implementations

impl AsRef<str> for KStringWriter

fn as_ref(&self) -> &str

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

impl Clone for KStringWriter

fn clone(&self) -> KStringWriter

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Default for KStringWriter

fn default() -> Self

Returns the “default value” for a type.

impl<'a, B: HeapStr> Extend<&'a KString<B>> for KStringWriter

fn extend<I: IntoIterator<Item = &'a KString<B>>>(&mut self, iter: I)

Extends a collection with the contents of an iterator.

fn extend_one(&mut self, item: A)

🔬This is a nightly-only experimental API. (extend_one)

Extends a collection with exactly one element.

fn extend_reserve(&mut self, additional: usize)

🔬This is a nightly-only experimental API. (extend_one)

Reserves capacity in a collection for the given number of additional elements.

impl<'a, 's, B: HeapStr> Extend<&'a KStringCow<'s, B>> for KStringWriter

fn extend<I: IntoIterator<Item = &'a KStringCow<'s, B>>>(&mut self, iter: I)

Extends a collection with the contents of an iterator.

fn extend_one(&mut self, item: A)

🔬This is a nightly-only experimental API. (extend_one)

Extends a collection with exactly one element.

fn extend_reserve(&mut self, additional: usize)

🔬This is a nightly-only experimental API. (extend_one)

Reserves capacity in a collection for the given number of additional elements.

impl<'a, 's> Extend<&'a KStringRef<'s>> for KStringWriter

fn extend<I: IntoIterator<Item = &'a KStringRef<'s>>>(&mut self, iter: I)

Extends a collection with the contents of an iterator.

fn extend_one(&mut self, item: A)

🔬This is a nightly-only experimental API. (extend_one)

Extends a collection with exactly one element.

fn extend_reserve(&mut self, additional: usize)

🔬This is a nightly-only experimental API. (extend_one)

Reserves capacity in a collection for the given number of additional elements.

impl<'a> Extend<&'a char> for KStringWriter

fn extend<I: IntoIterator<Item = &'a char>>(&mut self, iter: I)

Extends a collection with the contents of an iterator.

fn extend_one(&mut self, item: A)

🔬This is a nightly-only experimental API. (extend_one)

Extends a collection with exactly one element.

fn extend_reserve(&mut self, additional: usize)

🔬This is a nightly-only experimental API. (extend_one)

Reserves capacity in a collection for the given number of additional elements.

impl<'a> Extend<&'a str> for KStringWriter

fn extend<I: IntoIterator<Item = &'a str>>(&mut self, iter: I)

Extends a collection with the contents of an iterator.

fn extend_one(&mut self, item: A)

🔬This is a nightly-only experimental API. (extend_one)

Extends a collection with exactly one element.

fn extend_reserve(&mut self, additional: usize)

🔬This is a nightly-only experimental API. (extend_one)

Reserves capacity in a collection for the given number of additional elements.

impl Extend<Box<str>> for KStringWriter

fn extend<I: IntoIterator<Item = Box<str>>>(&mut self, iter: I)

Extends a collection with the contents of an iterator.

fn extend_one(&mut self, item: A)

🔬This is a nightly-only experimental API. (extend_one)

Extends a collection with exactly one element.

fn extend_reserve(&mut self, additional: usize)

🔬This is a nightly-only experimental API. (extend_one)

Reserves capacity in a collection for the given number of additional elements.

impl<'a> Extend<Cow<'a, str>> for KStringWriter

fn extend<I: IntoIterator<Item = Cow<'a, str>>>(&mut self, iter: I)

Extends a collection with the contents of an iterator.

fn extend_one(&mut self, item: A)

🔬This is a nightly-only experimental API. (extend_one)

Extends a collection with exactly one element.

fn extend_reserve(&mut self, additional: usize)

🔬This is a nightly-only experimental API. (extend_one)

Reserves capacity in a collection for the given number of additional elements.

impl<B: HeapStr> Extend<KString<B>> for KStringWriter

fn extend<I: IntoIterator<Item = KString<B>>>(&mut self, iter: I)

Extends a collection with the contents of an iterator.

fn extend_one(&mut self, item: A)

🔬This is a nightly-only experimental API. (extend_one)

Extends a collection with exactly one element.

fn extend_reserve(&mut self, additional: usize)

🔬This is a nightly-only experimental API. (extend_one)

Reserves capacity in a collection for the given number of additional elements.

impl<'s, B: HeapStr> Extend<KStringCow<'s, B>> for KStringWriter

fn extend<I: IntoIterator<Item = KStringCow<'s, B>>>(&mut self, iter: I)

Extends a collection with the contents of an iterator.

fn extend_one(&mut self, item: A)

🔬This is a nightly-only experimental API. (extend_one)

Extends a collection with exactly one element.

fn extend_reserve(&mut self, additional: usize)

🔬This is a nightly-only experimental API. (extend_one)

Reserves capacity in a collection for the given number of additional elements.

impl<'s> Extend<KStringRef<'s>> for KStringWriter

fn extend<I: IntoIterator<Item = KStringRef<'s>>>(&mut self, iter: I)

Extends a collection with the contents of an iterator.

fn extend_one(&mut self, item: A)

🔬This is a nightly-only experimental API. (extend_one)

Extends a collection with exactly one element.

fn extend_reserve(&mut self, additional: usize)

🔬This is a nightly-only experimental API. (extend_one)

Reserves capacity in a collection for the given number of additional elements.

impl Extend<String> for KStringWriter

fn extend<I: IntoIterator<Item = String>>(&mut self, iter: I)

Extends a collection with the contents of an iterator.

fn extend_one(&mut self, item: A)

🔬This is a nightly-only experimental API. (extend_one)

Extends a collection with exactly one element.

fn extend_reserve(&mut self, additional: usize)

🔬This is a nightly-only experimental API. (extend_one)

Reserves capacity in a collection for the given number of additional elements.

impl Extend<char> for KStringWriter

fn extend<I: IntoIterator<Item = char>>(&mut self, iter: I)

Extends a collection with the contents of an iterator.

fn extend_one(&mut self, item: A)

🔬This is a nightly-only experimental API. (extend_one)

Extends a collection with exactly one element.

fn extend_reserve(&mut self, additional: usize)

🔬This is a nightly-only experimental API. (extend_one)

Reserves capacity in a collection for the given number of additional elements.

impl<B: HeapStr> From<KStringWriter> for KString<B>

fn from(writer: KStringWriter) -> Self

Converts to this type from the input type.

impl Write for KStringWriter

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.