Struct Char8String 

pub struct Char8String(/* private fields */);

An owned, heap-backed, NUL-terminated CHAR8 (ASCII / ISO-Latin-1) string.

This is the CHAR8 analogue of alloc::string::String. It dereferences to Char8Str, so all borrowed operations are available on an owned value.

Examples

use patina::string::Char8String;

let s = Char8String::try_from_str("Firmware").unwrap();
assert_eq!(s.len(), 8);
assert!(s == "Firmware");

Implementations

impl Char8String

pub fn new() -> Self

Creates an empty string containing only the NUL terminator.

pub fn try_from_str(s: &str) -> Result<Self, StringError>

Creates a Char8String by encoding a Rust str as Latin-1.

Errors

Returns StringError::InteriorNul if the input contains a NUL character, or StringError::NotLatin1 if it contains a code point above U+00FF.

pub fn from_bytes_with_nul(bytes: Vec<u8>) -> Result<Self, StringError>

Creates a Char8String from a Vec<u8> that ends with a NUL terminator.

This validates bytes the same way Char8Str::from_bytes_with_nul does, then takes ownership of the buffer directly instead of cloning it.

Errors

Returns StringError::MissingNulTerminator if bytes does not end with a NUL, or StringError::InteriorNul if a NUL appears before the end.

pub unsafe fn from_bytes_with_nul_unchecked(bytes: Vec<u8>) -> Self

Creates a Char8String from a NUL-terminated Vec<u8> without validating its contents.

Safety

The caller must ensure that bytes ends with a single NUL terminator and contains no interior NUL.

pub fn as_char8_str(&self) -> &Char8Str

Borrows this owned string as a Char8Str.

pub fn into_bytes_with_nul(self) -> Vec<u8>

Consumes the string and returns the backing bytes, including the trailing NUL.

Methods from Deref<Target = Char8Str>

pub const EMPTY: &'static Char8Str

pub fn as_ptr(&self) -> *const u8

Returns a pointer to the first byte, suitable for passing to extern "efiapi" interfaces.

The pointed-to sequence is always NUL-terminated.

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

Returns the bytes including the trailing NUL terminator.

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

Returns the bytes excluding the trailing NUL terminator.

pub fn len(&self) -> usize

Returns the number of characters, excluding the trailing NUL terminator.

pub fn is_empty(&self) -> bool

Returns true if the string contains no characters (only the NUL terminator).

pub fn iter(&self) -> Iter<'_, u8>

Returns an iterator over the bytes, excluding the terminator.

This borrows each byte rather than copying it. Call Iterator::copied on the result if owned u8 values are needed.

pub fn chars(&self) -> impl Iterator<Item = char> + '_

Returns an iterator over the characters as char values.

Each byte maps directly onto its ISO-Latin-1 Unicode scalar value, so this conversion is always lossless.

Trait Implementations

impl Borrow<Char8Str> for Char8String

Available on crate features alloc only.

fn borrow(&self) -> &Char8Str

Immutably borrows from an owned value.

impl Clone for Char8String

fn clone(&self) -> Char8String

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Char8String

Available on crate features alloc only.

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

Formats the value using the given formatter.

impl Default for Char8String

Available on crate features alloc only.

fn default() -> Self

Returns the “default value” for a type.

impl Deref for Char8String

Available on crate features alloc only.

type Target = Char8Str

The resulting type after dereferencing.

fn deref(&self) -> &Char8Str

Dereferences the value.

impl Display for Char8String

Available on crate features alloc only.

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

Formats the value using the given formatter.

impl Eq for Char8String

impl From<&Char8Str> for Char8String

Available on crate features alloc only.

fn from(s: &Char8Str) -> Self

Converts to this type from the input type.

impl From<&Char8String> for Char16String

Available on crate features alloc only.

fn from(value: &Char8String) -> Self

Converts to this type from the input type.

impl<const N: usize> From<Char8Array<N>> for Char8String

Available on crate features alloc only.

fn from(value: Char8Array<N>) -> Self

Converts a fixed-capacity array to a heap-owned string, dropping the const capacity N.

impl From<Char8String> for Char16String

Available on crate features alloc only.

fn from(value: Char8String) -> Self

Converts to this type from the input type.

impl Hash for Char8String

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl Ord for Char8String

fn cmp(&self, other: &Char8String) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized,

Restrict a value to a certain interval.

fn clamp_to<R>(self, range: R) -> Self

where Self: Sized, R: ClampBounds<Self>,

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

Restrict a value to a certain range.

impl PartialEq for Char8String

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

Equality operator ==.

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

Inequality operator !=.

impl PartialEq<&Char8Str> for Char8String

Available on crate features alloc only.

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

Equality operator ==.

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

Inequality operator !=.

impl PartialEq<&str> for Char8String

Available on crate features alloc only.

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

Equality operator ==.

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

Inequality operator !=.

impl PartialEq<Char8Str> for Char8String

Available on crate features alloc only.

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

Equality operator ==.

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

Inequality operator !=.

impl PartialEq<Char8String> for str

Available on crate features alloc only.

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

Equality operator ==.

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

Inequality operator !=.

impl PartialEq<Char8String> for Char8Str

Available on crate features alloc only.

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

Equality operator ==.

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

Inequality operator !=.

impl PartialEq<str> for Char8String

Available on crate features alloc only.

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

Equality operator ==.

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

Inequality operator !=.

impl PartialOrd for Char8String

fn partial_cmp(&self, other: &Char8String) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

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

Tests less than (for self and other) and is used by the < operator.

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

Tests less than or equal to (for self and other) and is used by the <= operator.

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

Tests greater than (for self and other) and is used by the > operator.

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

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl StructuralPartialEq for Char8String

impl<'a> TryFrom<&'a str> for Char8String

Available on crate features alloc only.

type Error = StringError

The type returned in the event of a conversion error.

fn try_from(s: &'a str) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<&Char16Str> for Char8String

Available on crate features alloc only.

fn try_from(value: &Char16Str) -> Result<Self, StringError>

Converts UCS-2 to Latin-1.

Errors

Returns StringError::NotLatin1 if any code unit is above 0xFF.

type Error = StringError

The type returned in the event of a conversion error.

impl TryFrom<&Char16String> for Char8String

Available on crate features alloc only.

type Error = StringError

The type returned in the event of a conversion error.

fn try_from(value: &Char16String) -> Result<Self, StringError>

Performs the conversion.

impl TryFrom<Char16String> for Char8String

Available on crate features alloc only.

type Error = StringError

The type returned in the event of a conversion error.

fn try_from(value: Char16String) -> Result<Self, StringError>

Performs the conversion.