Struct uefi::data_types::CString16

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

Available on crate feature alloc only.

An owned UCS-2 null-terminated string.

For convenience, a CString16 is comparable with &str and String from the standard library through the trait EqStrUntilNul.

Examples

Round-trip conversion from a &str to a CString16 and back:

use uefi::CString16;

let s = CString16::try_from("abc").unwrap();
assert_eq!(s.to_string(), "abc");

Implementations

impl CString16

pub fn new() -> Self

Creates a new empty string with a terminating null character.

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

Inserts a character at the end of the string, right before the null character.

Panics

Panics if the char is a null character.

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

Extends the string with the given CStr16. The null character is automatically kept at the end.

pub fn replace_char(&mut self, search: Char16, replace: Char16)

Replaces all chars in the string with the replace value in-place.

pub fn num_chars(&self) -> usize

Returns the number of characters without the trailing null character.

pub fn is_empty(&self) -> bool

Returns if the string is empty. This ignores the null character.

Methods from Deref<Target = CStr16>

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

Returns the inner pointer to this C16 string.

pub fn as_slice(&self) -> &[Char16]

Get the underlying Char16s as slice without the trailing null.

pub fn as_slice_with_nul(&self) -> &[Char16]

Get the underlying Char16s as slice including the trailing null.

pub fn to_u16_slice(&self) -> &[u16]

Converts this C string to a u16 slice without the trailing null.

pub fn to_u16_slice_with_nul(&self) -> &[u16]

Converts this C string to a u16 slice containing the trailing null.

pub fn iter(&self) -> CStr16Iter<'_>

Returns an iterator over this C string

pub fn num_chars(&self) -> usize

Returns the number of characters without the trailing null. character

pub fn is_empty(&self) -> bool

Returns if the string is empty. This ignores the null character.

pub fn num_bytes(&self) -> usize

Get the number of bytes in the string (including the trailing null).

pub fn is_ascii(&self) -> bool

Checks if all characters in this string are within the ASCII range.

pub fn as_str_in_buf(&self, buf: &mut dyn Write) -> Result

Writes each Char16 as a char (4 bytes long in Rust language) into the buffer. It is up to the implementer of core::fmt::Write to convert the char to a string with proper encoding/charset. For example, in the case of alloc::string::String all Rust chars (UTF-32) get converted to UTF-8.

Example

let firmware_vendor_c16_str: CStr16 = ...;
// crate "arrayvec" uses stack-allocated arrays for Strings => no heap allocations
let mut buf = arrayvec::ArrayString::<128>::new();
firmware_vendor_c16_str.as_str_in_buf(&mut buf);
log::info!("as rust str: {}", buf.as_str());

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

Returns the underlying bytes as slice including the terminating null character.

Trait Implementations

impl AsRef<CStr16> for CString16

fn as_ref(&self) -> &CStr16

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

impl Borrow<CStr16> for CString16

fn borrow(&self) -> &CStr16

Immutably borrows from an owned value.

impl Clone for CString16

fn clone(&self) -> CString16

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for CString16

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

Formats the value using the given formatter.

impl Default for CString16

fn default() -> Self

Returns the “default value” for a type.

impl Deref for CString16

type Target = CStr16

The resulting type after dereferencing.

fn deref(&self) -> &CStr16

Dereferences the value.

impl Display for CString16

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

Formats the value using the given formatter.

impl<StrType: AsRef<str> + ?Sized> EqStrUntilNul<StrType> for CString16

fn eq_str_until_nul(&self, other: &StrType) -> bool

Checks if the provided Rust string StrType is equal to Self until the first null character is found. An exception is the terminating null character of Self which is ignored.

impl From<&CStr16> for CString16

fn from(value: &CStr16) -> Self

Converts to this type from the input type.

impl From<&CString16> for String

fn from(value: &CString16) -> Self

Converts to this type from the input type.

impl From<CString16> for PathBuf

fn from(value: CString16) -> Self

Converts to this type from the input type.

impl Hash for CString16

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 CString16

fn cmp(&self, other: &CString16) -> 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 + PartialOrd,

Restrict a value to a certain interval.

impl PartialEq<&CStr16> for CString16

fn eq(&self, other: &&CStr16) -> 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 PartialEq<CString16> for &CStr16

fn eq(&self, other: &CString16) -> 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 PartialEq for CString16

fn eq(&self, other: &CString16) -> 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 PartialOrd for CString16

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

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

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

This method tests less than (for self and other) and is used by the < operator.

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

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

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

This method tests greater than (for self and other) and is used by the > operator.

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

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

impl<'a> TryFrom<&UnalignedSlice<'a, u16>> for CString16

type Error = FromSliceWithNulError

The type returned in the event of a conversion error.

fn try_from(input: &UnalignedSlice<'_, u16>) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<&str> for CString16

type Error = FromStrError

The type returned in the event of a conversion error.

fn try_from(input: &str) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<Vec<u16>> for CString16

type Error = FromSliceWithNulError

The type returned in the event of a conversion error.

fn try_from(input: Vec<u16>) -> Result<Self, Self::Error>

Performs the conversion.

impl Eq for CString16

impl StructuralPartialEq for CString16