Skip to main content

WStrBuf

Struct WStrBuf 

Source
pub struct WStrBuf<const N: usize>(/* private fields */);
Expand description

A fixed-size UTF-16 string buffer inside a struct (wchar_t name[N]), holding a string up to the first NUL.

§Examples

use imping_runtime::WStrBuf;

let mut name = WStrBuf::<4>::new();
name.set("Héllo");
assert_eq!(name.to_string_lossy(), "Hél"); // at most 3 code units, then the NUL

Implementations§

Source§

impl<const N: usize> WStrBuf<N>

Source

pub const fn new() -> Self

Creates an empty, all-zero buffer.

Source

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

Returns the string’s UTF-16 code units: up to the first NUL, or the whole buffer if it has none.

Source

pub fn to_string_lossy(&self) -> String

Returns the string as UTF-8, with unpaired surrogates replaced by �.

Source

pub fn set(&mut self, value: &str)

Stores value as UTF-16, truncated to fit before the terminating NUL.

Truncation never splits a surrogate pair. A NUL in value ends it, and the rest of the buffer is zeroed.

Source

pub fn as_array(&self) -> &[u16; N]

Returns the whole buffer.

Source

pub fn as_array_mut(&mut self) -> &mut [u16; N]

Returns the whole buffer, to write to it directly.

Source

pub fn as_ptr(&self) -> WStrPtr

Returns a pointer to the buffer, valid while it is alive and unmoved.

Reading through it needs a NUL within the buffer, which set guarantees.

Trait Implementations§

Source§

impl<const N: usize> Clone for WStrBuf<N>

Source§

fn clone(&self) -> WStrBuf<N>

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl<const N: usize> Copy for WStrBuf<N>

Source§

impl<const N: usize> Debug for WStrBuf<N>

Source§

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

Formats the value using the given formatter. Read more
Source§

impl<const N: usize> Default for WStrBuf<N>

Source§

fn default() -> Self

Returns an empty, all-zero buffer.

Source§

impl<const N: usize> Eq for WStrBuf<N>

Source§

impl<const N: usize> Hash for WStrBuf<N>

Source§

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

Feeds this value into the given Hasher. Read more
1.3.0 · Source§

fn hash_slice<H>(data: &[Self], state: &mut H)
where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher. Read more
Source§

impl<const N: usize> PartialEq for WStrBuf<N>

Source§

fn eq(&self, other: &WStrBuf<N>) -> bool

Equality operator ==. Read more
1.0.0 (const: unstable) · Source§

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

Inequality operator !=. Read more
Source§

impl<const N: usize> Plain for WStrBuf<N>

Source§

impl<const N: usize> StructuralPartialEq for WStrBuf<N>

Auto Trait Implementations§

§

impl<const N: usize> Freeze for WStrBuf<N>

§

impl<const N: usize> RefUnwindSafe for WStrBuf<N>

§

impl<const N: usize> Send for WStrBuf<N>

§

impl<const N: usize> Sync for WStrBuf<N>

§

impl<const N: usize> Unpin for WStrBuf<N>

§

impl<const N: usize> UnsafeUnpin for WStrBuf<N>

§

impl<const N: usize> UnwindSafe for WStrBuf<N>

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.