Struct uefi::CString16

pub struct CString16(_);

An owned UCS-2 null-terminated string.

Examples

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

use core::convert::TryFrom;
use uefi::CString16;

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

Methods from Deref<Target = CStr16>

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

Returns the inner pointer to this C string

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

Converts this C string to a u16 slice

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

Converts this C string to a u16 slice containing the trailing 0 char

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

Returns an iterator over this C string

pub fn num_bytes(&self) -> usize

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

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 the 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_string(&self) -> String

Transforms the C16Str to a regular Rust String. WARNING This will require heap allocation, i.e. you need an global allocator. If the UEFI boot services are exited, your OS/Kernel needs to provide another allocation mechanism!

Trait Implementations

impl AsRef<CStr16> for CString16

fn as_ref(&self) -> &CStr16

Performs the conversion.

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() -> CString16

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 Ord for CString16

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

This method returns an Ordering between self and other.

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

Compares and returns the maximum of two values.

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

Compares and returns the minimum of two values.

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

Restrict a value to a certain interval.

impl PartialEq<CString16> 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: &CString16) -> bool

This method tests for !=.

impl PartialOrd<CString16> 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 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 Eq for CString16

impl StructuralEq for CString16

impl StructuralPartialEq for CString16