Struct ucs2::Ucs2LeSlice

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

Wrapper around [u8] containing a valid null-terminated UCS-2 LE string.

This type is not FFI compatible with *const u16!

Because Ucs2LeSlice uses a [u8] as the backing data type (as opposed to a [u16]), the data is not guaranteed to be u16 aligned!

Example

let raw = [b'O', 0, b'K', 0, 0, 0];
let s = Ucs2LeSlice::from_slice_with_nul(&raw).unwrap();
assert_eq!(s.as_bytes().len(), raw.len());
assert_eq!(s.to_string(), "OK");

Implementations

impl Ucs2LeSlice

pub fn from_slice_with_nul(buf: &[u8]) -> Result<&Ucs2LeSlice, Ucs2ParseError>

Validate that the provided &[u8] is a valid null-terminated UCS-2 LE string, truncating the slice to the position of the first null u16.

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

View the underlying data as raw bytes.

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

View the underlying data as raw bytes, without the trailing null u16.

pub fn to_ucs2_le_vec(&self) -> Ucs2LeVec

Copies self into a new Ucs2LeVec.

Trait Implementations

impl AsRef<Ucs2LeSlice> for Ucs2LeVec

fn as_ref(&self) -> &Ucs2LeSlice

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

impl Borrow<Ucs2LeSlice> for Ucs2LeVec

fn borrow(&self) -> &Ucs2LeSlice

Immutably borrows from an owned value.

impl Debug for Ucs2LeSlice

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

Formats the value using the given formatter.

impl<'a> Default for &'a Ucs2LeSlice

fn default() -> &'a Ucs2LeSlice

Returns the “default value” for a type.

impl Display for Ucs2LeSlice

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

Formats the value using the given formatter.

impl<'a> From<&'a Ucs2LeSlice> for Cow<'a, Ucs2LeSlice>

fn from(val: &'a Ucs2LeSlice) -> Self

Converts to this type from the input type.

impl Hash for Ucs2LeSlice

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

Feeds this value into the given Hasher.

impl Ord for Ucs2LeSlice

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

This method returns an Ordering between self and other.

impl PartialEq for Ucs2LeSlice

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

fn partial_cmp(&self, other: &Ucs2LeSlice) -> 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 ToOwned for Ucs2LeSlice

type Owned = Ucs2LeVec

The resulting type after obtaining ownership.

fn to_owned(&self) -> Ucs2LeVec

Creates owned data from borrowed data, usually by cloning.

fn clone_into(&self, target: &mut Self::Owned)

Uses borrowed data to replace owned data, usually by cloning.

impl Eq for Ucs2LeSlice

impl StructuralPartialEq for Ucs2LeSlice