Type Alias ConfigKey

pub type ConfigKey = Txt;

Unique key to a config entry.

Aliased Type

struct ConfigKey(/* private fields */);

Implementations

impl Txt

pub const fn from_static(s: &'static str) -> Txt

New text that is a &'static str.

pub const fn from_string(s: String) -> Txt

New text from a String optimized for editing.

If you don’t plan to edit the text after this call consider using from_str instead.

pub fn from_str(s: &str) -> Txt

New cloned from s.

The text will be internally optimized for sharing, if you plan to edit the text after this call consider using from_string instead.

pub fn from_arc(s: Arc<str>) -> Txt

New from a shared arc str.

Note that the text can outlive the Arc, by cloning the string data when modified or to use a more optimal representation, you cannot use the reference count of s to track the lifetime of the text.

pub fn from_char(c: char) -> Txt

New text that is an inlined char.

pub fn from_fmt(args: Arguments<'_>) -> Txt

New text from format_args!, avoids allocation if the text is static (no args) or can fit the inlined representation.

pub const fn repr(&self) -> TxtRepr

Identifies how the text is currently stored.

pub fn to_mut(&mut self) -> &mut String

Acquires a mutable reference to a String buffer.

Converts the text to an internal representation optimized for editing, you can call end_mut after editing to re-optimize the text for sharing.

pub fn end_mut(&mut self)

Convert the inner representation of the string to not be String. After this call the text can be cheaply cloned.

pub fn into_owned(self) -> String

Extracts the owned string.

Turns the text to owned if it was borrowed.

pub fn clear(&mut self)

Calls String::clear if the text is owned, otherwise replaces self with an empty str ("").

pub fn pop(&mut self) -> Option<char>

Removes the last character from the text and returns it.

Returns None if this Txt is empty.

This method only converts to TxtRepr::String if the internal representation is TxtRepr::Arc, other representations are reborrowed.

pub fn truncate(&mut self, new_len: usize)

Shortens this Txt to the specified length.

If new_len is greater than the text’s current length, this has no effect.

This method only converts to TxtRepr::String if the internal representation is TxtRepr::Arc, other representations are reborrowed.

pub fn split_off(&mut self, at: usize) -> Txt

Splits the text into two at the given index.

Returns a new Txt. self contains bytes [0, at), and the returned Txt contains bytes [at, len). at must be on the boundary of a UTF-8 code point.

This method only converts to TxtRepr::String if the internal representation is TxtRepr::Arc, other representations are reborrowed.

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

Push the character to the end of the text.

This method avoids converting to TxtRepr::String when the current text plus char can fit inlined.

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

Push the string to the end of the text.

This method avoids converting to TxtRepr::String when the current text plus char can fit inlined.

pub fn as_str(&self) -> &str

Borrow the text as a string slice.

pub fn as_static_str(&self) -> Option<&'static str>

Copy the inner static str if this text represents one.

Trait Implementations

impl<'a> Add<&'a str> for Txt

type Output = Txt

The resulting type after applying the + operator.

fn add(self, rhs: &'a str) -> <Txt as Add<&'a str>>::Output

Performs the + operation.

impl AddAssign<&str> for Txt

fn add_assign(&mut self, rhs: &str)

Performs the += operation.

impl AsRef<[u8]> for Txt

fn as_ref(&self) -> &[u8]

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

impl AsRef<OsStr> for Txt

fn as_ref(&self) -> &OsStr

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

impl AsRef<Path> for Txt

fn as_ref(&self) -> &Path

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

impl AsRef<str> for Txt

fn as_ref(&self) -> &str

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

impl Borrow<str> for Txt

fn borrow(&self) -> &str

Immutably borrows from an owned value.

impl Clone for Txt

Clones the text.

If the inner representation is TxtRepr::String the returned value is in a representation optimized for sharing, either a static empty, an inlined short or an Arc<str> long string.

fn clone(&self) -> Txt

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Txt

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

Formats the value using the given formatter.

impl Default for Txt

fn default() -> Txt

Empty.

impl Deref for Txt

type Target = str

The resulting type after dereferencing.

fn deref(&self) -> &<Txt as Deref>::Target

Dereferences the value.

impl<'de> Deserialize<'de> for Txt

fn deserialize<D>( deserializer: D, ) -> Result<Txt, <D as Deserializer<'de>>::Error>

where D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for Txt

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

Formats the value using the given formatter.

impl From<&'static str> for Txt

fn from(value: &'static str) -> Txt

Converts to this type from the input type.

impl From<Cow<'static, str>> for Txt

fn from(value: Cow<'static, str>) -> Txt

Converts to this type from the input type.

impl From<String> for Txt

fn from(value: String) -> Txt

Converts to this type from the input type.

impl From<char> for Txt

fn from(value: char) -> Txt

Converts to this type from the input type.

impl FromStr for Txt

type Err = ()

The associated error which can be returned from parsing.

fn from_str(s: &str) -> Result<Txt, <Txt as FromStr>::Err>

Parses a string s to return a value of this type.

impl Hash for Txt

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

where __H: Hasher,

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 IntoVar<CategoryId> for Txt

type Var = LocalVar<CategoryId>

Variable type that will wrap the T value.

fn into_var(self) -> Self::Var

Converts the source value into a var.

fn into_boxed_var(self) -> Box<dyn VarBoxed<T>>

where Self: Sized,

Converts into BoxedVar<T>.

impl IntoVar<CommandScope> for Txt

fn into_var(self) -> <Txt as IntoVar<CommandScope>>::Var

Widget scope.

type Var = LocalVar<CommandScope>

Variable type that will wrap the T value.

fn into_boxed_var(self) -> Box<dyn VarBoxed<T>>

where Self: Sized,

Converts into BoxedVar<T>.

impl IntoVar<Cow<'static, str>> for Txt

type Var = LocalVar<Cow<'static, str>>

Variable type that will wrap the T value.

fn into_var(self) -> <Txt as IntoVar<Cow<'static, str>>>::Var

Converts the source value into a var.

fn into_boxed_var(self) -> Box<dyn VarBoxed<T>>

where Self: Sized,

Converts into BoxedVar<T>.

impl IntoVar<DragDropData> for Txt

type Var = LocalVar<DragDropData>

Variable type that will wrap the T value.

fn into_var(self) -> <Txt as IntoVar<DragDropData>>::Var

Converts the source value into a var.

fn into_boxed_var(self) -> Box<dyn VarBoxed<T>>

where Self: Sized,

Converts into BoxedVar<T>.

impl IntoVar<FileDialogFilters> for Txt

type Var = LocalVar<FileDialogFilters>

Variable type that will wrap the T value.

fn into_var(self) -> <Txt as IntoVar<FileDialogFilters>>::Var

Converts the source value into a var.

fn into_boxed_var(self) -> Box<dyn VarBoxed<T>>

where Self: Sized,

Converts into BoxedVar<T>.

impl IntoVar<PathBuf> for Txt

type Var = LocalVar<PathBuf>

Variable type that will wrap the T value.

fn into_var(self) -> <Txt as IntoVar<PathBuf>>::Var

Converts the source value into a var.

fn into_boxed_var(self) -> Box<dyn VarBoxed<T>>

where Self: Sized,

Converts into BoxedVar<T>.

impl IntoVar<Progress> for Txt

type Var = LocalVar<Progress>

Variable type that will wrap the T value.

fn into_var(self) -> <Txt as IntoVar<Progress>>::Var

Converts the source value into a var.

fn into_boxed_var(self) -> Box<dyn VarBoxed<T>>

where Self: Sized,

Converts into BoxedVar<T>.

impl IntoVar<String> for Txt

type Var = LocalVar<String>

Variable type that will wrap the T value.

fn into_var(self) -> <Txt as IntoVar<String>>::Var

Converts the source value into a var.

fn into_boxed_var(self) -> Box<dyn VarBoxed<T>>

where Self: Sized,

Converts into BoxedVar<T>.

impl IntoVar<WidgetId> for Txt

fn into_var(self) -> <Txt as IntoVar<WidgetId>>::Var

Calls WidgetId::named.

type Var = LocalVar<WidgetId>

Variable type that will wrap the T value.

fn into_boxed_var(self) -> Box<dyn VarBoxed<T>>

where Self: Sized,

Converts into BoxedVar<T>.

impl IntoVar<WindowId> for Txt

fn into_var(self) -> <Txt as IntoVar<WindowId>>::Var

Calls WindowId::named.

type Var = LocalVar<WindowId>

Variable type that will wrap the T value.

fn into_boxed_var(self) -> Box<dyn VarBoxed<T>>

where Self: Sized,

Converts into BoxedVar<T>.

impl Ord for Txt

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

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<String> for Txt

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<str> for Txt

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 Txt

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

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

fn serialize<S>( &self, serializer: S, ) -> Result<<S as Serializer>::Ok, <S as Serializer>::Error>

where S: Serializer,

Serialize this value into the given Serde serializer.

impl Write for Txt

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

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

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

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 Txt

impl IntoValue<CategoryId> for Txt

impl IntoValue<CommandScope> for Txt

impl IntoValue<Cow<'static, str>> for Txt

impl IntoValue<DragDropData> for Txt

impl IntoValue<FileDialogFilters> for Txt

impl IntoValue<PathBuf> for Txt

impl IntoValue<Progress> for Txt

impl IntoValue<String> for Txt

impl IntoValue<WidgetId> for Txt

impl IntoValue<WindowId> for Txt

impl StructuralPartialEq for Txt