Struct ReusableString

pub struct ReusableString { /* private fields */ }

A wrapper around String that allows for reusing its allocation.

This is particularly useful in loops where strings are built and discarded, as it helps to avoid frequent memory allocations. When the guard returned by recycle is dropped, the String is cleared, but its capacity is retained.

Examples

use triple_r::ReusableString;

let mut reusable_string = ReusableString::default();
let mut last_capacity = 0;

for i in 0..3 {
    let mut string_guard = reusable_string.recycle();
    assert!(string_guard.is_empty());
    assert_eq!(string_guard.capacity(), last_capacity);

    string_guard.push_str("hello world");
    last_capacity = string_guard.capacity();
}

let final_guard = reusable_string.recycle();
assert!(final_guard.is_empty());
assert_eq!(final_guard.capacity(), last_capacity);

Implementations

impl ReusableString

pub fn recycle<'parent>(&'parent mut self) -> ReusableStringGuard<'parent>

Reuses the String’s allocation, returning a guard for temporary access.

The &mut self requirement ensures that only one guard can be active at a time.

Trait Implementations

impl Debug for ReusableString

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

Formats the value using the given formatter.

impl Default for ReusableString

fn default() -> Self

Creates a new, empty ReusableString.

impl Send for ReusableString

impl Sync for ReusableString