Struct Ucs2LeVec

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

Wrapper around Vec<u8> containing a valid null-terminated UCS-2 LE string.

This type is not FFI compatible with *const u16!

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

DEVNOTE: While we want Ucs2LeSlice to be backed by a [u8], Ucs2LeVec should likely get switched over to a Vec<u16>, so we can get proper u16 alignment. Note that in this case, we could use a bit of (trivially save) unsafe code to impl Deref<Target = Ucs2LeSlice> by reinterpretting the Vec<u16> as a &[u8], so there wouldn’t be any major ergonomic hit.

Implementations

impl Ucs2LeVec

pub fn from_vec_with_nul(buf: Vec<u8>) -> Result<Ucs2LeVec, Ucs2ParseError>

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

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

Consume self, returning the underlying raw Vec<u8>

Methods from Deref<Target = Ucs2LeSlice>

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 Clone for Ucs2LeVec

fn clone(&self) -> Ucs2LeVec

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Ucs2LeVec

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

Formats the value using the given formatter.

impl Default for Ucs2LeVec

fn default() -> Ucs2LeVec

Returns the “default value” for a type.

impl Deref for Ucs2LeVec

type Target = Ucs2LeSlice

The resulting type after dereferencing.

fn deref(&self) -> &Ucs2LeSlice

Dereferences the value.

impl Display for Ucs2LeVec

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

Formats the value using the given formatter.

impl<'a> From<&'a str> for Ucs2LeVec

fn from(s: &'a str) -> Ucs2LeVec

Converts to this type from the input type.

impl From<String> for Ucs2LeVec

fn from(s: String) -> Ucs2LeVec

Converts to this type from the input type.

impl From<Ucs2LeVec> for Cow<'_, Ucs2LeSlice>

fn from(val: Ucs2LeVec) -> Self

Converts to this type from the input type.

impl Hash for Ucs2LeVec

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 Ucs2LeVec

fn cmp(&self, other: &Ucs2LeVec) -> 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.

impl PartialEq for Ucs2LeVec

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

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

impl StructuralPartialEq for Ucs2LeVec