Struct winrt::FastHString

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

A string type that should be used to create strings that can be passed to Windows Runtime functions. Creating a new FastHString is faster than creating an instance of HString because it eliminates an additional allocation. Furthermore, obtaining a HStringArg from a FastHString is basically free, which is not the case for HString.

Methods

impl FastHString

pub fn new(s: &str) -> FastHString

Creates a new FastHString from a Rust string. FastHString uses the Rust allocator to create a storage buffer for its contents, where the string is stored in UTF-16 encoding. The buffer is freed on when the FastHString is dropped.

Examples

Basic usage:

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

pub fn empty() -> FastHString

Creates an empty FastHString.

pub fn len(&self) -> u32

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

Examples

Basic usage:

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

pub fn is_empty(&self) -> bool

Checks whether the string is empty.

Examples

Basic usage:

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

pub fn make_reference(&self) -> HStringReference

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

Examples

Basic usage:

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

Methods from Deref<Target = HStringArg>

pub unsafe fn get(&self) -> HSTRING

Trait Implementations

impl Ord for FastHString

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 Eq for FastHString

impl PartialOrd<FastHString> for FastHString

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<FastHString> for FastHString

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<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 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 FastHString

fn to_string(&self) -> String

Converts the given value to a String.

impl Drop for FastHString

fn drop(&mut self)

Executes the destructor for this type.

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

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

Performs the conversion.

impl Display for FastHString

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

Formats the value using the given formatter.

impl<'a> Deref for FastHString

type Target = HStringArg

The resulting type after dereferencing.

fn deref(&self) -> &HStringArg

Dereferences the value.