Struct WString 

pub struct WString<const LEN: usize>(/* private fields */);

Represents a fixed-length wide string.

This type can be created from a &[u16] if its length does not exceed the fixed length. It can be created from a &str if its length, encoded in UTF16, does not exceed the fixed length.

It can be freely converted from and to a [u16; N] array, and to a Vec<u16> where it will be cut at the first null.

It can be converted to a Rust String if it is properly UTF16 encoded.

Implementations

impl<const LEN: usize> WString<LEN>

pub fn new() -> Self

Create a new empty string.

pub fn len(&self) -> usize

Return the number of code units up to the first null.

pub fn is_empty(&self) -> bool

Returns true if the string is empty.

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

Get the slice up to the first null code unit.

pub fn backing_array(&mut self) -> &mut [u16; LEN]

Get a reference to the full array of code units.

Trait Implementations

impl<const LEN: usize> AsBytes for WString<LEN>

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

Gets the bytes of this value.

fn as_bytes_mut(&mut self) -> &mut [u8]

where Self: FromBytes,

Gets the bytes of this value mutably.

fn write_to(&self, bytes: &mut [u8]) -> Option<()>

Writes a copy of self to bytes.

fn write_to_prefix(&self, bytes: &mut [u8]) -> Option<()>

Writes a copy of self to the prefix of bytes.

fn write_to_suffix(&self, bytes: &mut [u8]) -> Option<()>

Writes a copy of self to the suffix of bytes.

impl<const LEN: usize> Clone for WString<LEN>

fn clone(&self) -> WString<LEN>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<const LEN: usize> Debug for WString<LEN>

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

Formats the value using the given formatter.

impl<const LEN: usize> Default for WString<LEN>

fn default() -> Self

Returns the “default value” for a type.

impl<const LEN: usize> From<[u16; LEN]> for WString<LEN>

fn from(arr: [u16; LEN]) -> Self

Converts to this type from the input type.

impl<const LEN: usize> From<WString<LEN>> for [u16; LEN]

fn from(wstr: WString<LEN>) -> Self

Converts to this type from the input type.

impl<const LEN: usize> From<WString<LEN>> for Vec<u16>

fn from(wstr: WString<LEN>) -> Self

Converts to this type from the input type.

impl<const LEN: usize> FromBytes for WString<LEN>

where [u16; LEN]: FromBytes, u16: FromBytes,

fn ref_from(bytes: &[u8]) -> Option<&Self>

where Self: Sized,

Interprets the given bytes as a &Self without copying.

fn ref_from_prefix(bytes: &[u8]) -> Option<&Self>

where Self: Sized,

Interprets the prefix of the given bytes as a &Self without copying.

fn ref_from_suffix(bytes: &[u8]) -> Option<&Self>

where Self: Sized,

Interprets the suffix of the given bytes as a &Self without copying.

fn mut_from(bytes: &mut [u8]) -> Option<&mut Self>

where Self: Sized + AsBytes,

Interprets the given bytes as a &mut Self without copying.

fn mut_from_prefix(bytes: &mut [u8]) -> Option<&mut Self>

where Self: Sized + AsBytes,

Interprets the prefix of the given bytes as a &mut Self without copying.

fn mut_from_suffix(bytes: &mut [u8]) -> Option<&mut Self>

where Self: Sized + AsBytes,

Interprets the suffix of the given bytes as a &mut Self without copying.

fn slice_from(bytes: &[u8]) -> Option<&[Self]>

where Self: Sized,

Interprets the given bytes as a &[Self] without copying.

fn slice_from_prefix(bytes: &[u8], count: usize) -> Option<(&[Self], &[u8])>

where Self: Sized,

Interprets the prefix of the given bytes as a &[Self] with length equal to count without copying.

fn slice_from_suffix(bytes: &[u8], count: usize) -> Option<(&[u8], &[Self])>

where Self: Sized,

Interprets the suffix of the given bytes as a &[Self] with length equal to count without copying.

fn mut_slice_from(bytes: &mut [u8]) -> Option<&mut [Self]>

where Self: Sized + AsBytes,

Interprets the given bytes as a &mut [Self] without copying.

fn mut_slice_from_prefix( bytes: &mut [u8], count: usize, ) -> Option<(&mut [Self], &mut [u8])>

where Self: Sized + AsBytes,

Interprets the prefix of the given bytes as a &mut [Self] with length equal to count without copying.

fn mut_slice_from_suffix( bytes: &mut [u8], count: usize, ) -> Option<(&mut [u8], &mut [Self])>

where Self: Sized + AsBytes,

Interprets the suffix of the given bytes as a &mut [Self] with length equal to count without copying.

fn read_from(bytes: &[u8]) -> Option<Self>

where Self: Sized,

Reads a copy of Self from bytes.

fn read_from_prefix(bytes: &[u8]) -> Option<Self>

where Self: Sized,

Reads a copy of Self from the prefix of bytes.

fn read_from_suffix(bytes: &[u8]) -> Option<Self>

where Self: Sized,

Reads a copy of Self from the suffix of bytes.

impl<const LEN: usize> FromZeroes for WString<LEN>

where [u16; LEN]: FromZeroes, u16: FromZeroes,

fn zero(&mut self)

Overwrites self with zeroes.

fn new_zeroed() -> Self

where Self: Sized,

Creates an instance of Self from zeroed bytes.

impl<const LEN: usize> PartialEq<&[u16]> for WString<LEN>

fn eq(&self, other: &&[u16]) -> bool

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl<const LEN: usize> PartialEq<&str> for WString<LEN>

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

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl<const LEN: usize> PartialEq for WString<LEN>

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

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl<const LEN: usize> TryFrom<&[u16]> for WString<LEN>

type Error = ()

The type returned in the event of a conversion error.

fn try_from(arr: &[u16]) -> Result<Self, ()>

Performs the conversion.

impl<const LEN: usize> TryFrom<&str> for WString<LEN>

type Error = ()

The type returned in the event of a conversion error.

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

Performs the conversion.

impl<const LEN: usize> TryFrom<WString<LEN>> for String

type Error = DecodeUtf16Error

The type returned in the event of a conversion error.

fn try_from(wstr: WString<LEN>) -> Result<Self, Self::Error>

Performs the conversion.

impl<const LEN: usize> Copy for WString<LEN>