Struct windows_core::HSTRING

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

An (HSTRING) is a reference-counted and immutable UTF-16 string type.

Implementations

impl HSTRING

pub const fn new() -> HSTRING

Create an empty HSTRING.

This function does not allocate memory.

pub fn is_empty(&self) -> bool

Returns true if the string is empty.

pub fn len(&self) -> usize

Returns the length of the string. The length is measured in u16s (UTF-16 code units), not including the terminating null character.

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

Get the string as 16-bit wide characters (wchars).

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

Returns a raw pointer to the HSTRING buffer.

pub fn from_wide(value: &[u16]) -> Result<HSTRING, Error>

Create a HSTRING from a slice of 16 bit characters (wchars).

pub fn to_string_lossy(&self) -> String

Get the contents of this HSTRING as a String lossily.

pub fn to_os_string(&self) -> OsString

Get the contents of this HSTRING as a OsString.

Trait Implementations

impl Clone for HSTRING

fn clone(&self) -> HSTRING

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for HSTRING

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

Formats the value using the given formatter.

impl Default for HSTRING

fn default() -> HSTRING

Returns the “default value” for a type.

impl Display for HSTRING

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

Formats the value using the given formatter.

impl Drop for HSTRING

fn drop(&mut self)

Executes the destructor for this type.

impl From<&OsStr> for HSTRING

fn from(value: &OsStr) -> HSTRING

Converts to this type from the input type.

impl From<&OsString> for HSTRING

fn from(value: &OsString) -> HSTRING

Converts to this type from the input type.

impl From<&Path> for HSTRING

fn from(value: &Path) -> HSTRING

Converts to this type from the input type.

impl From<&String> for HSTRING

fn from(value: &String) -> HSTRING

Converts to this type from the input type.

impl From<&str> for HSTRING

fn from(value: &str) -> HSTRING

Converts to this type from the input type.

impl From<HStringBuilder> for HSTRING

fn from(value: HStringBuilder) -> HSTRING

Converts to this type from the input type.

impl From<OsString> for HSTRING

fn from(value: OsString) -> HSTRING

Converts to this type from the input type.

impl From<String> for HSTRING

fn from(value: String) -> HSTRING

Converts to this type from the input type.

impl Hash for HSTRING

fn hash<H>(&self, hasher: &mut H)

where H: Hasher,

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 HSTRING

fn cmp(&self, other: &HSTRING) -> 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 + PartialOrd,

Restrict a value to a certain interval.

impl PartialEq<&HSTRING> for OsStr

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

This method tests for self and other values to be equal, and is used by ==.

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

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

impl PartialEq<&HSTRING> for str

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

This method tests for self and other values to be equal, and is used by ==.

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

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

impl PartialEq<&OsStr> for HSTRING

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

This method tests for self and other values to be equal, and is used by ==.

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

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

impl PartialEq<&OsString> for HSTRING

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

This method tests for self and other values to be equal, and is used by ==.

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

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

impl PartialEq<&String> for HSTRING

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

This method tests for self and other values to be equal, and is used by ==.

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

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

impl PartialEq<&str> for HSTRING

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

This method tests for self and other values to be equal, and is used by ==.

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

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

impl PartialEq<HSTRING> for &OsStr

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

This method tests for self and other values to be equal, and is used by ==.

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

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

impl PartialEq<HSTRING> for &str

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

This method tests for self and other values to be equal, and is used by ==.

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

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

impl PartialEq<HSTRING> for OsStr

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

This method tests for self and other values to be equal, and is used by ==.

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

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

impl PartialEq<HSTRING> for str

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

This method tests for self and other values to be equal, and is used by ==.

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

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

impl PartialEq<OsStr> for &HSTRING

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

This method tests for self and other values to be equal, and is used by ==.

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

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

impl PartialEq<OsStr> for HSTRING

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

This method tests for self and other values to be equal, and is used by ==.

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

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

impl PartialEq<OsString> for &HSTRING

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

This method tests for self and other values to be equal, and is used by ==.

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

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

impl PartialEq<OsString> for HSTRING

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

This method tests for self and other values to be equal, and is used by ==.

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

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

impl PartialEq<String> for &HSTRING

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

This method tests for self and other values to be equal, and is used by ==.

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

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

impl PartialEq<String> for HSTRING

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

This method tests for self and other values to be equal, and is used by ==.

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

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

impl PartialEq<str> for &HSTRING

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

This method tests for self and other values to be equal, and is used by ==.

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

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

impl PartialEq<str> for HSTRING

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

This method tests for self and other values to be equal, and is used by ==.

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

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

impl PartialEq for HSTRING

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

This method tests for self and other values to be equal, and is used by ==.

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

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

impl PartialOrd for HSTRING

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

impl Param<PCWSTR> for &HSTRING

impl Send for HSTRING

impl Sync for HSTRING