Struct ImString

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

A UTF-8 encoded, growable, implicitly nul-terminated string.

Implementations

impl ImString

pub fn new<T: Into<String>>(value: T) -> ImString

Creates a new ImString from an existing string.

pub fn with_capacity(capacity: usize) -> ImString

Creates a new empty ImString with a particular capacity

pub unsafe fn from_utf8_unchecked(v: Vec<u8>) -> ImString

Converts a vector of bytes to a ImString without checking that the string contains valid UTF-8

Safety

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

pub unsafe fn from_utf8_with_nul_unchecked(v: Vec<u8>) -> ImString

Converts a vector of bytes to a ImString without checking that the string contains valid UTF-8

Safety

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

pub fn clear(&mut self)

Truncates this ImString, removing all contents

pub fn push(&mut self, ch: char)

Appends the given character to the end of this ImString

pub fn push_str(&mut self, string: &str)

Appends a given string slice to the end of this ImString

pub fn capacity(&self) -> usize

Returns the capacity of this ImString in bytes

pub fn capacity_with_nul(&self) -> usize

Returns the capacity of this ImString in bytes, including the implicit null byte

pub fn reserve(&mut self, additional: usize)

Ensures that the capacity of this ImString is at least additional bytes larger than the current length.

The capacity may be increased by more than additional bytes.

pub fn reserve_exact(&mut self, additional: usize)

Ensures that the capacity of this ImString is at least additional bytes larger than the current length

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

Returns a raw pointer to the underlying buffer

pub fn as_mut_ptr(&mut self) -> *mut c_char

Returns a raw mutable pointer to the underlying buffer.

If the underlying data is modified, refresh_len must be called afterwards.

pub unsafe fn refresh_len(&mut self)

Updates the underlying buffer length based on the current contents.

This function must be called if the underlying data is modified via a pointer obtained by as_mut_ptr.

Safety

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

Methods from Deref<Target = ImStr>

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

fn as_ref(&self) -> &ImStr

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

impl AsRef<str> for ImString

fn as_ref(&self) -> &str

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

impl Borrow<ImStr> for ImString

fn borrow(&self) -> &ImStr

Immutably borrows from an owned value.

impl Borrow<str> for ImString

fn borrow(&self) -> &str

Immutably borrows from an owned value.

impl Clone for ImString

fn clone(&self) -> ImString

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for ImString

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

Formats the value using the given formatter.

impl<'a> Default for ImString

fn default() -> ImString

Returns the “default value” for a type.

impl Deref for ImString

type Target = ImStr

The resulting type after dereferencing.

fn deref(&self) -> &ImStr

Dereferences the value.

impl Display for ImString

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

Formats the value using the given formatter.

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

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

Converts to this type from the input type.

impl<'a, T: ?Sized + AsRef<ImStr>> From<&'a T> for ImString

fn from(s: &'a T) -> ImString

Converts to this type from the input type.

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

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

Converts to this type from the input type.

impl From<String> for ImString

fn from(s: String) -> ImString

Converts to this type from the input type.

impl Hash for ImString

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 Index<RangeFull> for ImString

type Output = ImStr

The returned type after indexing.

fn index(&self, _index: RangeFull) -> &ImStr

Performs the indexing (container[index]) operation.

impl Ord for ImString

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

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

fn partial_cmp(&self, other: &ImString) -> 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 Write for ImString

fn write_str(&mut self, s: &str) -> Result

Writes a string slice into this writer, returning whether the write succeeded.

fn write_char(&mut self, c: char) -> Result

Writes a char into this writer, returning whether the write succeeded.

fn write_fmt(&mut self, args: Arguments<'_>) -> Result<(), Error>

Glue for usage of the write! macro with implementors of this trait.

impl Eq for ImString

impl StructuralPartialEq for ImString