Struct winrt::HStringReference

#[repr(transparent)]
pub struct HStringReference<'a>(_, _);

A reference to either an HString, a FastHString, or a raw null-terminated UTF-16 buffer.

Methods

impl<'a> HStringReference<'a>

pub fn from_utf16(slice: &'a [u16]) -> HStringReference<'a>

Creates a new HStringReference from a UTF-16 encoded slice, which must be null-terminated. This function does not allocate and is the fastest option if you already have UTF-16 encoded data.

Examples

Basic usage:

use winrt::HStringReference;
let sparkle_heart = vec![0xD83D, 0xDC96, 0x0];
let r = HStringReference::from_utf16(&sparkle_heart);
assert_eq!("💖", r.to_string());

pub unsafe fn from_utf16_unchecked(slice: &'a [u16]) -> HStringReference<'a>

Creates a new HStringReference from a UTF-16 encoded slice, which must be null-terminated. This function is unsafe because the caller must make sure that the data really is null-terminated.

pub fn len(&self) -> u32

Returns the length of the string in Unicode characters, as specified by WindowsGetStringLen.

pub fn is_empty(&self) -> bool

Checks whether the string is empty.

Examples

Basic usage:

use winrt::HString;
let s = HString::empty();
assert!(s.is_empty());

Methods from Deref<Target = HStringArg>

pub unsafe fn get(&self) -> HSTRING

Trait Implementations

impl<'a> Ord for HStringReference<'a>

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

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

🔬 This is a nightly-only experimental API. (clamp)

Restrict a value to a certain interval.

impl<'a> Eq for HStringReference<'a>

impl<'a> Clone for HStringReference<'a>

fn clone(&self) -> HStringReference<'a>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<'a> PartialOrd<HStringReference<'a>> for HStringReference<'a>

fn partial_cmp(&self, other: &Self) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

#[must_use]

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

This method tests less than (for self and other) and is used by the < operator.

#[must_use]

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

This method tests less than or equal to (for self and other) and is used by the <= operator.

#[must_use]

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

This method tests greater than (for self and other) and is used by the > operator.

#[must_use]

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<'a, 'b> PartialEq<HStringReference<'a>> for HStringReference<'b>

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

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

#[must_use]

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

This method tests for !=.

impl<'a> PartialEq<HString> for HStringReference<'a>

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

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

#[must_use]

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

This method tests for !=.

impl<'a> PartialEq<HStringReference<'a>> for HString

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

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

#[must_use]

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

This method tests for !=.

impl<'a> PartialEq<FastHString> for HStringReference<'a>

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

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

#[must_use]

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

This method tests for !=.

impl<'a> PartialEq<HStringReference<'a>> for FastHString

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

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

#[must_use]

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

This method tests for !=.

impl<'a> ToString for HStringReference<'a>

fn to_string(&self) -> String

Converts the given value to a String.

impl<'a> Copy for HStringReference<'a>

impl<'a> Display for HStringReference<'a>

fn fmt(&self, formatter: &mut Formatter) -> Result<(), Error>

Formats the value using the given formatter.

impl<'a> Deref for HStringReference<'a>

type Target = HStringArg

The resulting type after dereferencing.

fn deref(&self) -> &HStringArg

Dereferences the value.