Struct imgui::ImStr

pub struct ImStr(_);

A UTF-8 encoded, implicitly null-terminated string slice.

Implementations

impl ImStr

pub unsafe fn from_ptr_unchecked<'a>(ptr: *const c_char) -> &'a ImStr

Wraps a raw UTF-8 encoded C string

Safety

It is up to the caller to guarantee the pointer is not null and it points to a null-terminated UTF-8 string valid for the duration of the arbitrary lifetime 'a.

pub unsafe fn from_utf8_with_nul_unchecked(bytes: &[u8]) -> &ImStr

Converts a slice of bytes to an imgui-rs string slice without checking for valid UTF-8 or null termination.

Safety

It is up to the caller to guarantee the slice contains valid UTF-8 and a null terminator.

pub unsafe fn from_cstr_unchecked(value: &CStr) -> &ImStr

Converts a CStr reference to an imgui-rs string slice without checking for valid UTF-8.

Safety

It is up to the caller to guarantee the CStr reference contains valid UTF-8.

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

Converts an imgui-rs string slice to a raw pointer

pub fn to_str(&self) -> &str

Converts an imgui-rs string slice to a normal string slice

pub fn is_empty(&self) -> bool

Returns true if the imgui-rs string slice is empty

Trait Implementations

impl AsRef<CStr> for ImStr

fn as_ref(&self) -> &CStr

Performs the conversion.

impl AsRef<ImStr> for ImString

fn as_ref(&self) -> &ImStr

Performs the conversion.

impl AsRef<ImStr> for ImStr

fn as_ref(&self) -> &ImStr

Performs the conversion.

impl AsRef<str> for ImStr

fn as_ref(&self) -> &str

Performs the conversion.

impl Borrow<ImStr> for ImString

fn borrow(&self) -> &ImStr

Immutably borrows from an owned value.

impl Debug for ImStr

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

Formats the value using the given formatter.

impl<'a> Default for &'a ImStr

fn default() -> &'a ImStr

Returns the "default value" for a type.

impl Display for ImStr

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

Formats the value using the given formatter.

impl Eq for ImStr

impl<'a> From<&'a ImStr> for Cow<'a, ImStr>

fn from(s: &'a ImStr) -> Cow<'a, ImStr>

Performs the conversion.

impl Hash for ImStr

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 Ord for ImStr

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

This method returns an [Ordering] between self and other.

#[must_use]fn max(self, other: Self) -> Self

Compares and returns the maximum of two values.

#[must_use]fn min(self, other: Self) -> Self

Compares and returns the minimum of two values.

#[must_use]fn clamp(self, min: Self, max: Self) -> Self

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

Restrict a value to a certain interval.

impl PartialEq<ImStr> for ImStr

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

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

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

This method tests for !=.

impl PartialOrd<ImStr> for ImStr

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

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

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

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

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

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

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

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

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

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

impl StructuralEq for ImStr

impl StructuralPartialEq for ImStr

impl ToOwned for ImStr

type Owned = ImString

The resulting type after obtaining ownership.

fn to_owned(&self) -> ImString

Creates owned data from borrowed data, usually by cloning.

fn clone_into(&self, target: &mut Self::Owned)

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

recently added

Uses borrowed data to replace owned data, usually by cloning.