Struct Str

pub struct Str;

Available on crate feature str only.

A string slice namespace.

See also the std::str module.

Implementations

impl Str

pub const fn from_utf8(v: &[u8]) -> Result<&str, InvalidUtf8>

Converts a slice of bytes to a string slice.

See from_utf8.

pub fn from_utf8_mut(v: &mut [u8]) -> Result<&mut str, InvalidUtf8>

Converts a mutable slice of bytes to a mutable string slice.

See from_utf8_mut.

pub const unsafe fn from_utf8_unchecked(v: &[u8]) -> &str

Available on crate feature unsafe_str only.

Converts a slice of bytes to a string slice without checking valid UTF-8.

See from_utf8_unchecked.

Safety

The bytes passed in must be valid UTF-8.

pub const unsafe fn from_utf8_unchecked_mut(v: &mut [u8]) -> &mut str

Available on crate feature unsafe_str only.

Converts a mutable slice of bytes to a mutable string slice without checking valid UTF-8.

See from_utf8_unchecked_mut.

Safety

The bytes passed in must be valid UTF-8.

pub unsafe fn from_boxed_utf8_unchecked(v: Box<[u8]>) -> Box<str>

Available on crate features alloc and unsafe_str only.

Converts a boxed slice of bytes to a boxed string slice without checking valid UTF-8.

See from_boxed_utf8_unchecked.

Safety

The bytes passed in must be valid UTF-8.

pub const fn repeat_into<'input, const CAP: usize>( string: &str, n: usize, buffer: &'input mut [u8; CAP], ) -> &'input str

Repeats a string a given number of times into the provided buffer. and returns a reference to the new &str.

Examples

let mut buf = [0_u8; 12];
let repeated = Str::repeat_into("ay", 3, &mut buf);
assert_eq![repeated, "ayayay"];

Features

Makes use of the unsafe_str feature if enabled.

See also ExtStr::new_counter, which should be faster, because it uses copy_from_slice.

pub const fn new_counter( buffer: &mut [u8], length: usize, separator: char, ) -> &str

Returns a &str backed by a buffer, where you always know each character’s position.

A counter string is a graduated string of arbitrary length, with a separator positioned after the immediately preceding number.

Examples

let mut buf = [0; 15];
assert_eq!("2*4*6*8*11*14*", Str::new_counter(&mut buf, 14, '*'));
assert_eq!("_3_5_7_9_12_15_", Str::new_counter(&mut buf, 15, '_'));

Panics

Panics if buffer.len() < length, or if !char.is_ascii().

Features

Makes use of the unsafe_str feature if enabled.

See also ExtStr::new_counter.