Struct glib::enums::EnumClass

source ·
pub struct EnumClass(/* private fields */);
Expand description

Representation of an enum for dynamically, at runtime, querying the values of the enum and using them.

Implementations§

source§

impl EnumClass

source

pub fn new<T: StaticType + HasParamSpec<ParamSpec = ParamSpecEnum>>() -> Self

Create a new EnumClass from a static type T.

Panics if T is not representing an enum.

source

pub fn with_type(type_: Type) -> Option<Self>

Create a new EnumClass from a Type.

Returns None if type_ is not representing an enum.

source

pub fn type_(&self) -> Type

Type of the enum.

source

pub fn value(&self, value: i32) -> Option<&EnumValue>

Gets EnumValue by integer value, if existing.

Returns None if the enum does not contain any value with value.

source

pub fn value_by_name(&self, name: &str) -> Option<&EnumValue>

Gets EnumValue by string name name, if existing.

Returns None if the enum does not contain any value with name name.

source

pub fn value_by_nick(&self, nick: &str) -> Option<&EnumValue>

Gets EnumValue by string nick nick, if existing.

Returns None if the enum does not contain any value with nick nick.

source

pub fn values(&self) -> &[EnumValue]

Gets all EnumValue of this EnumClass.

source

pub fn to_value(&self, value: i32) -> Option<Value>

Converts integer value to a Value, if part of the enum.

source

pub fn to_value_by_name(&self, name: &str) -> Option<Value>

Converts string name name to a Value, if part of the enum.

source

pub fn to_value_by_nick(&self, nick: &str) -> Option<Value>

Converts string nick nick to a Value, if part of the enum.

source

pub fn complete_type_info( type_: Type, const_static_values: &'static EnumValues, ) -> Option<TypeInfo>

Complete TypeInfo for an enum with values. This is an associated function. A method would result in a stack overflow due to a recurvice call: callers should first create an EnumClass instance by calling EnumClass::with_type() which indirectly calls TypePluginRegisterImpl::register_dynamic_enum() and TypePluginImpl::complete_type_info() and one of them should call EnumClass::with_type() before calling this method. const_static_values is a reference on a wrapper of a slice of EnumValue. It must be static to ensure enumeration values are never dropped, and ensures that slice is terminated by an EnumValue with all members being 0, as expected by GLib.

Trait Implementations§

source§

impl Clone for EnumClass

source§

fn clone(&self) -> Self

Returns a copy of the value. Read more
1.0.0 · source§

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

Performs copy-assignment from source. Read more
source§

impl Debug for EnumClass

source§

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

Formats the value using the given formatter. Read more
source§

impl Drop for EnumClass

source§

fn drop(&mut self)

Executes the destructor for this type. Read more
source§

impl Send for EnumClass

source§

impl Sync for EnumClass

Auto Trait Implementations§

Blanket Implementations§

source§

impl<T> Any for T
where T: 'static + ?Sized,

source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
source§

impl<T> Borrow<T> for T
where T: ?Sized,

source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
source§

impl<T> CloneToUninit for T
where T: Clone,

source§

default unsafe fn clone_to_uninit(&self, dst: *mut T)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dst. Read more
source§

impl<T> From<T> for T

source§

fn from(t: T) -> T

Returns the argument unchanged.

source§

impl<T, U> Into<U> for T
where U: From<T>,

source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

source§

impl<T> ToOwned for T
where T: Clone,

§

type Owned = T

The resulting type after obtaining ownership.
source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

§

type Error = Infallible

The type returned in the event of a conversion error.
source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.