Struct windy::WString

#[repr(C)]
pub struct WString { /* fields omitted */ }

Represents a wide string (Unicode string).

Implementations

impl WString

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

pub fn as_bytes_with_nul_mut(&mut self) -> &mut [u16]

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

pub fn as_u8_bytes_with_nul(&self) -> &[u8]

pub fn as_u8_bytes(&self) -> &[u8]

pub fn as_c_str(&self) -> &WStr

Returns &WStr.

pub fn as_mut_c_str(&mut self) -> &mut WStr

Returns &mut WStr.

pub fn len(&self) -> usize

Returns the length of bytes.

pub fn is_empty(&self) -> bool

Returns true if the length of bytes is 0.

pub unsafe fn new_unchecked<T: Into<Vec<u16>>>(v: T) -> Self

Creates WString from Vec without any encoding checks.

Safety

v must be a correct Unicode string.

pub unsafe fn new_c_unchecked<T: Into<Vec<u8>>>(v: T) -> Self

Creates WString from Vec without any encoding checks.

Safety

v must be a correct Unicode string.

pub unsafe fn new_nul_unchecked<T: Into<Vec<u16>>>(v: T) -> Self

Creates WString from v without a null-terminated check and any encoding checks.

Safety

v must be a null-terminated Unicode string.

pub fn from_str(x: &str) -> ConvertResult<Self>

Converts &str to WString.

Example

use windy::WString;
let s = WString::from_str("test🍣").unwrap();
println!("{:?}", s);

pub fn from_str_lossy(x: &str) -> Self

Converts &str to WString.

Example

use windy::WString;
let s = WString::from_str_lossy("test🍣");
println!("{:?}", s);

pub unsafe fn clone_from_raw(ptr: *mut u16) -> Self

Creates WString from ptr.

Safety

ptr must be a null-terminated Unicode string.

pub unsafe fn clone_from_raw_s(ptr: *mut u16, len: usize) -> Self

Creates WString from ptr and len.

Safety

ptr must be a null-terminated Unicode string.

pub unsafe fn clone_from_raw_s_unchecked(ptr: *mut u16, len: usize) -> Self

Creates WString from ptr and len without length check.

Safety

ptr must be a null-terminated Unicode string.

Methods from Deref<Target = WStr>

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

pub fn len(&self) -> usize

Returns the length of bytes.

pub fn is_empty(&self) -> bool

Returns true if the length of bytes is 0.

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

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

pub fn to_u8_bytes_with_nul(&self) -> &[u8]

pub fn to_u8_bytes(&self) -> &[u8]

pub fn try_to_string(&self) -> ConvertResult<String>

Converts WString to UTF-8 string.

If an input has an invalid character, this function returns ConvertError::ConvertToUtf8Error.

pub fn to_string_lossy(&self) -> String

Converts WStr to UTF-8 string.

The function replaces Illegal sequences with with \u{FFFD}.

pub fn to_wstring(&self) -> WString

Creates WString from WStr.

pub fn to_astring(&self) -> ConvertResult<AString>

Converts WStr to AString.

Example

use windy::{AString, WString};
let s = AString::from_str("test").unwrap();
let s2 = WString::from_str("test").unwrap().to_astring().unwrap();
assert_eq!(s, s2);

pub fn to_astring_lossy(&self) -> AString

Converts WStr to AString.

Example

use windy::{AString, WString};
let s = AString::from_str("test").unwrap();
let s2 = WString::from_str("test").unwrap().to_astring_lossy();
assert_eq!(s, s2);

Trait Implementations

impl Add<&'_ WStr> for WString

type Output = Self

The resulting type after applying the + operator.

fn add(self, rhs: &WStr) -> Self::Output

Performs the + operation.

impl Clone for WString

fn clone(&self) -> WString

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for WString

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

Formats the value using the given formatter.

impl Deref for WString

type Target = WStr

The resulting type after dereferencing.

fn deref(&self) -> &Self::Target

Dereferences the value.

impl Display for WString

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

Formats the value using the given formatter.

impl Drop for WString

fn drop(&mut self)

Executes the destructor for this type.

impl From<&'_ WStr> for WString

fn from(x: &WStr) -> Self

Performs the conversion.

impl Hash for WString

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

Feeds this value into the given Hasher.

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

Feeds a slice of this type into the given Hasher.

impl Index<RangeFull> for WString

type Output = WStr

The returned type after indexing.

fn index(&self, _: RangeFull) -> &Self::Output

Performs the indexing (container[index]) operation.

impl Ord for WString

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

Restrict a value to a certain interval.

impl PartialEq<WString> for WString

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

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

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

This method tests for !=.

impl PartialOrd<WString> for WString

fn partial_cmp(&self, other: &WString) -> 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 TryFrom<&'_ AStr> for WString

type Error = ConvertError

The type returned in the event of a conversion error.

fn try_from(x: &AStr) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<&'_ AString> for WString

type Error = ConvertError

The type returned in the event of a conversion error.

fn try_from(x: &AString) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<&'_ String> for WString

type Error = ConvertError

The type returned in the event of a conversion error.

fn try_from(x: &String) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<&'_ WString> for AString

type Error = ConvertError

The type returned in the event of a conversion error.

fn try_from(x: &WString) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<&'_ str> for WString

type Error = ConvertError

The type returned in the event of a conversion error.

fn try_from(x: &str) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<AString> for WString

type Error = ConvertError

The type returned in the event of a conversion error.

fn try_from(x: AString) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<String> for WString

type Error = ConvertError

The type returned in the event of a conversion error.

fn try_from(x: String) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<WString> for AString

type Error = ConvertError

The type returned in the event of a conversion error.

fn try_from(x: WString) -> Result<Self, Self::Error>

Performs the conversion.

impl TryInto<String> for WString

type Error = ConvertError

The type returned in the event of a conversion error.

fn try_into(self) -> Result<String, Self::Error>

Performs the conversion.

impl Eq for WString

impl StructuralEq for WString

impl StructuralPartialEq for WString