Struct UCStr 

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

A UTF-8 string stored as a NUL-terminated CStr.

Use the ucstringify! macro to construct UCStr constants.

Implementations

impl UCStr

pub const fn from_literal(literal: &'static CStr) -> Result<Self, Utf8Error>

pub const unsafe fn from_literal_unchecked(literal: &'static CStr) -> Self

pub fn as_str(&self) -> &str

pub fn as_c_str(&self) -> &CStr

pub fn as_ptr(&self) -> FREStr

Borrow

pub fn to_c_string(&self) -> CString

Trait Implementations

impl AsRef<CStr> for UCStr

fn as_ref(&self) -> &CStr

Converts this type into a shared reference of the (usually inferred) input type.

impl AsRef<str> for UCStr

fn as_ref(&self) -> &str

Converts this type into a shared reference of the (usually inferred) input type.

impl Borrow<str> for UCStr

fn borrow(&self) -> &str

Immutably borrows from an owned value.

impl Clone for UCStr

fn clone(&self) -> UCStr

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for UCStr

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

Formats the value using the given formatter.

impl Default for UCStr

fn default() -> Self

Returns the “default value” for a type.

impl Display for UCStr

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

Formats the value using the given formatter.

impl From<UCStr> for CString

fn from(value: UCStr) -> Self

Converts to this type from the input type.

impl From<UCStr> for String

fn from(value: UCStr) -> Self

Converts to this type from the input type.

impl Hash for UCStr

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, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl Ord for UCStr

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

Restrict a value to a certain interval.

impl PartialEq<String<'_>> for UCStr

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

Tests for self and other values to be equal, and is used by ==.

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

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

impl PartialEq<UCStr> for String<'_>

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

Tests for self and other values to be equal, and is used by ==.

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

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

impl PartialEq<UCStr> for str

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

Tests for self and other values to be equal, and is used by ==.

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

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

impl PartialEq<str> for UCStr

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

Tests for self and other values to be equal, and is used by ==.

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

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

impl PartialEq for UCStr

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

Tests for self and other values to be equal, and is used by ==.

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

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

impl PartialOrd for UCStr

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

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

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

Tests less than (for self and other) and is used by the < operator.

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

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

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

Tests greater than (for self and other) and is used by the > operator.

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

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl ToUcstrLossy for UCStr

fn to_ucstr_lossy(&self) -> UCStr

impl TryFrom<&CStr> for UCStr

type Error = Utf8Error

The type returned in the event of a conversion error.

fn try_from(value: &CStr) -> Result<Self, Utf8Error>

Performs the conversion.

impl TryFrom<&str> for UCStr

type Error = NulError

The type returned in the event of a conversion error.

fn try_from(value: &str) -> Result<Self, NulError>

Performs the conversion.

impl TryFrom<CString> for UCStr

type Error = Utf8Error

The type returned in the event of a conversion error.

fn try_from(value: CString) -> Result<Self, Utf8Error>

Performs the conversion.

impl TryFrom<String> for UCStr

type Error = NulError

The type returned in the event of a conversion error.

fn try_from(value: String) -> Result<Self, NulError>

Performs the conversion.

impl Eq for UCStr

impl StructuralPartialEq for UCStr