Struct winrt::HString

#[repr(transparent)]
pub struct HString(_);

A wrapper over an HSTRING whose memory is managed by the Windows Runtime. This is what you get as return values when calling WinRT methods that return strings. Note that dereferencing to &HStringArg is not implemented for this, because the containing HSTRING might be null (empty string), and null references are not allowed. In order to obtain an &HStringArg from an HString, first create an HStringReference using make_reference().

Methods

impl HString

pub fn new<'a>(s: &'a str) -> HString

Creates a new HString whose memory is managed by the Windows Runtime. This allocates twice (once for the conversion to UTF-16, and again within WindowsCreateString), therefore this should not be used. Use FastHString::new() instead.

pub unsafe fn wrap(hstr: HSTRING) -> HString

Wraps an existing HSTRING inside this HString. This is only safe when the HSTRING was allocated by the Windows Runtime.

pub fn empty() -> HString

Creates an empty HString.

pub fn len(&self) -> u32

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

Examples

Basic usage:

use winrt::HString;
let s = HString::new("hello");
assert_eq!(5, s.len());

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());

pub fn make_reference<'a>(&'a self) -> HStringReference<'a>

Creates an HStringReference that points to the contents of this HString.

Examples

Basic usage:

use winrt::HString;
let s = HString::new("hello");
let r = s.make_reference();  
assert_eq!(s.to_string(), r.to_string());

Trait Implementations

impl<'a> RtType for HString

type In = HStringArg

type Abi = HSTRING

type Out = HString

type OutNonNull = Self::Out

unsafe fn unwrap(input: &Self::In) -> Self::Abi

unsafe fn uninitialized() -> Self::Abi

unsafe fn wrap(abi: Self::Abi) -> Self::Out

impl Ord for HString

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 Send for HString

impl Eq for HString

impl Clone for HString

fn clone(&self) -> Self

Returns a copy of the value.

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

Performs copy-assignment from source.

impl PartialOrd<HString> for HString

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 PartialEq<HString> for HString

fn eq(&self, other: &Self) -> 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 PartialEq<FastHString> for HString

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<&'a FastHString> for HString

fn eq(&self, other: &&'a 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 PartialEq<HString> for FastHString

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 ToString for HString

fn to_string(&self) -> String

Converts the given value to a String.

impl Drop for HString

fn drop(&mut self)

Executes the destructor for this type.

impl Display for HString

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

Formats the value using the given formatter.