Struct gio::Initable

#[repr(transparent)]
pub struct Initable { /* private fields */ }

Initable is implemented by objects that can fail during initialization. If an object implements this interface then it must be initialized as the first thing after construction, either via InitableExt::init() or AsyncInitableExt::init_async() (the latter is only available if it also implements AsyncInitable).

If the object is not initialized, or initialization returns with an error, then all operations on the object except g_object_ref() and g_object_unref() are considered to be invalid, and have undefined behaviour. They will often fail with g_critical() or g_warning(), but this must not be relied on.

Users of objects implementing this are not intended to use the interface method directly, instead it will be used automatically in various ways. For C applications you generally just call new() directly, or indirectly via a foo_thing_new() wrapper. This will call InitableExt::init() under the cover, returning None and setting a glib::Error on failure (at which point the instance is unreferenced).

For bindings in languages where the native constructor supports exceptions the binding could check for objects implementing GInitable during normal construction and automatically initialize them, throwing an exception on failure.

Implements

InitableExt

Implementations

impl Initable

pub fn new<T: IsA<Object> + IsClass + IsA<Initable>>( cancellable: Option<&impl IsA<Cancellable>> ) -> Result<T, Error>

Create a new instance of an object with the default property values.

Similar to Object::new but can fail because the object initialization in Initable::init failed. Helper function for constructing Initable object. This is similar to glib::Object::new() but also initializes the object and returns None, setting an error on failure.

object_type

a GType supporting Initable.

cancellable

optional Cancellable object, None to ignore.

first_property_name

the name of the first property, or None if no properties

Returns

a newly allocated glib::Object, or None on error

pub fn with_type( type_: Type, cancellable: Option<&impl IsA<Cancellable>> ) -> Result<Object, Error>

Create a new instance of an object with the default property values.

Similar to Object::with_type but can fail because the object initialization in Initable::init failed.

pub fn with_mut_values( type_: Type, properties: &mut [(&str, Value)], cancellable: Option<&impl IsA<Cancellable>> ) -> Result<Object, Error>

Create a new instance of an object of the given type with the given properties as mutable values.

Panics

This panics if the object is not instantiable, doesn’t have all the given properties or property values of the wrong type are provided.

pub fn builder<'a, O: IsA<Object> + IsClass + IsA<Initable>>( ) -> InitableBuilder<'a, O>

Create a new object builder for a specific type.

pub fn builder_with_type<'a>(type_: Type) -> InitableBuilder<'a, Object>

Create a new object builder for a specific type.

impl Initable

pub const NONE: Option<&'static Initable> = None

Trait Implementations

impl Clone for Initable

fn clone(&self) -> Self

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Initable

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

Formats the value using the given formatter.

impl Display for Initable

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

Formats the value using the given formatter.

impl HasParamSpec for Initable

type ParamSpec = ParamSpecObject

type SetValue = Initable

Preferred value to be used as setter for the associated ParamSpec.

type BuilderFn = fn(_: &str) -> ParamSpecObjectBuilder<'_, Initable>

fn param_spec_builder() -> Self::BuilderFn

impl Hash for Initable

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<T: InitableImpl> IsImplementable<T> for Initable

fn interface_init(iface: &mut Interface<Self>)

Override the virtual methods of this interface for the given subclass and do other interface initialization.

fn instance_init(_instance: &mut InitializingObject<T>)

Instance specific initialization.

impl Ord for Initable

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

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Selfwhere Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Selfwhere Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Selfwhere Self: Sized + PartialOrd<Self>,

Restrict a value to a certain interval.

impl<OT: ObjectType> PartialEq<OT> for Initable

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

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

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

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl<OT: ObjectType> PartialOrd<OT> for Initable

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

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

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

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

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

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

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

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

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

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

impl StaticType for Initable

fn static_type() -> Type

Returns the type identifier of Self.

impl Eq for Initable

impl IsA<Initable> for CharsetConverter

impl IsA<Initable> for DBusConnection

impl IsA<Initable> for DBusProxy

impl IsA<Initable> for DBusServer

impl IsA<Initable> for DebugController

Available on crate feature v2_72 only.

impl IsA<Initable> for DebugControllerDBus

Available on crate feature v2_72 only.

impl IsA<Initable> for InetAddressMask

impl IsA<Initable> for MemoryMonitor

Available on crate feature v2_64 only.

impl IsA<Initable> for NetworkMonitor

impl IsA<Initable> for PowerProfileMonitor

Available on crate feature v2_70 only.

impl IsA<Initable> for Socket

impl IsA<Initable> for Subprocess