Struct glib::FlagsClass
source · #[repr(transparent)]pub struct FlagsClass(_);Expand description
Representation of a flags for dynamically, at runtime, querying the values of the enum and
using them
Implementations§
source§impl FlagsClass
impl FlagsClass
sourcepub fn new(type_: Type) -> Option<Self>
pub fn new(type_: Type) -> Option<Self>
Create a new FlagsClass from a Type
Returns None if type_ is not representing a flags type.
sourcepub fn value(&self, value: u32) -> Option<&FlagsValue>
pub fn value(&self, value: u32) -> Option<&FlagsValue>
Gets FlagsValue by integer value, if existing.
Returns None if the flags do not contain any value
with value.
sourcepub fn value_by_name(&self, name: &str) -> Option<&FlagsValue>
pub fn value_by_name(&self, name: &str) -> Option<&FlagsValue>
Gets FlagsValue by string name name, if existing.
Returns None if the flags do not contain any value
with name name.
sourcepub fn value_by_nick(&self, nick: &str) -> Option<&FlagsValue>
pub fn value_by_nick(&self, nick: &str) -> Option<&FlagsValue>
Gets FlagsValue by string nick nick, if existing.
Returns None if the flags do not contain any value
with nick nick.
sourcepub fn values(&self) -> &[FlagsValue]
pub fn values(&self) -> &[FlagsValue]
Gets all FlagsValue of this FlagsClass.
sourcepub fn to_value(&self, value: u32) -> Option<Value>
pub fn to_value(&self, value: u32) -> Option<Value>
Converts integer value to a Value, if part of the flags.
sourcepub fn to_value_by_name(&self, name: &str) -> Option<Value>
pub fn to_value_by_name(&self, name: &str) -> Option<Value>
Converts string name name to a Value, if part of the flags.
sourcepub fn to_value_by_nick(&self, nick: &str) -> Option<Value>
pub fn to_value_by_nick(&self, nick: &str) -> Option<Value>
Converts string nick nick to a Value, if part of the flags.
sourcepub fn is_set(&self, value: &Value, f: u32) -> bool
pub fn is_set(&self, value: &Value, f: u32) -> bool
Checks if the flags corresponding to integer f is set in value.
sourcepub fn is_set_by_name(&self, value: &Value, name: &str) -> bool
pub fn is_set_by_name(&self, value: &Value, name: &str) -> bool
Checks if the flags corresponding to string name name is set in value.
sourcepub fn is_set_by_nick(&self, value: &Value, nick: &str) -> bool
pub fn is_set_by_nick(&self, value: &Value, nick: &str) -> bool
Checks if the flags corresponding to string nick nick is set in value.
sourcepub fn set(&self, value: Value, f: u32) -> Result<Value, Value>
pub fn set(&self, value: Value, f: u32) -> Result<Value, Value>
Set flags value corresponding to integer f in value, if part of that flags. If the
flag is already set, it will succeed without doing any changes.
Returns Ok(value) with the flag set if successful, or Err(value) with the original
value otherwise.
sourcepub fn set_by_name(&self, value: Value, name: &str) -> Result<Value, Value>
pub fn set_by_name(&self, value: Value, name: &str) -> Result<Value, Value>
Set flags value corresponding to string name name in value, if part of that flags.
If the flag is already set, it will succeed without doing any changes.
Returns Ok(value) with the flag set if successful, or Err(value) with the original
value otherwise.
sourcepub fn set_by_nick(&self, value: Value, nick: &str) -> Result<Value, Value>
pub fn set_by_nick(&self, value: Value, nick: &str) -> Result<Value, Value>
Set flags value corresponding to string nick nick in value, if part of that flags.
If the flag is already set, it will succeed without doing any changes.
Returns Ok(value) with the flag set if successful, or Err(value) with the original
value otherwise.
sourcepub fn unset(&self, value: Value, f: u32) -> Result<Value, Value>
pub fn unset(&self, value: Value, f: u32) -> Result<Value, Value>
Unset flags value corresponding to integer f in value, if part of that flags.
If the flag is already unset, it will succeed without doing any changes.
Returns Ok(value) with the flag unset if successful, or Err(value) with the original
value otherwise.
sourcepub fn unset_by_name(&self, value: Value, name: &str) -> Result<Value, Value>
pub fn unset_by_name(&self, value: Value, name: &str) -> Result<Value, Value>
Unset flags value corresponding to string name name in value, if part of that flags.
If the flag is already unset, it will succeed without doing any changes.
Returns Ok(value) with the flag unset if successful, or Err(value) with the original
value otherwise.
sourcepub fn unset_by_nick(&self, value: Value, nick: &str) -> Result<Value, Value>
pub fn unset_by_nick(&self, value: Value, nick: &str) -> Result<Value, Value>
Unset flags value corresponding to string nick nick in value, if part of that flags.
If the flag is already unset, it will succeed without doing any changes.
Returns Ok(value) with the flag unset if successful, or Err(value) with the original
value otherwise.
sourcepub fn to_nick_string(&self, value: u32) -> String
pub fn to_nick_string(&self, value: u32) -> String
Converts an integer value to a string of nicks separated by |.
sourcepub fn from_nick_string(&self, s: &str) -> Result<u32, ParseFlagsError>
pub fn from_nick_string(&self, s: &str) -> Result<u32, ParseFlagsError>
Converts a string of nicks s separated by | to an integer value.
sourcepub fn builder(&self) -> FlagsBuilder<'_>
pub fn builder(&self) -> FlagsBuilder<'_>
Returns a new FlagsBuilder for conveniently setting/unsetting flags
and building a Value.
sourcepub fn builder_with_value(&self, value: Value) -> Option<FlagsBuilder<'_>>
pub fn builder_with_value(&self, value: Value) -> Option<FlagsBuilder<'_>>
Returns a new FlagsBuilder for conveniently setting/unsetting flags
and building a Value. The Value is initialized with value.