Struct static_link_module::StaticLink

source ·
pub struct StaticLink {
    pub(crate) args: OnceCell<Vec<StaticLinkArgs>>,
    pub(crate) handles: SourceHandlesCell,
}
Expand description

The plugin instance

The instance struct contains any relevant mutable data, and is initialized by SimplePlugin::init_args. It is also a shared ref-counted GObject instance via SimplePluginObject<Self>, so it must be accessed and manipulated via &self.

Fields§

§args: OnceCell<Vec<StaticLinkArgs>>

Arguments specified by the user at plugin initialization

§handles: SourceHandlesCell

Mutable data keeps track of any futures that the plugin spawns on the MainLoop.

Implementations§

source

pub(crate) fn register_type()

Registers the type only once.

source

pub fn downgrade(&self) -> <Self as Downgrade>::Weak

Trait Implementations§

This makes StaticLink an async plugin that can be used with plugin::plugin_export below.

source§

fn enable(&self, this: Self::Type) -> Self::EnableFuture

The real entry point of the plugin

Spawns as asynchronous main_async for each StaticLinkArgs supplied by the user.

source§

fn disable(&self)

Plugin deinitializer

Cleans up after itself by cancelling any pending futures that were previously spawned by enable

§

type EnableFuture = Pin<Box<dyn Future<Output = Result<(), Error>>>>

source§

fn register_source(&self, source: SourceId)

source§

fn default() -> StaticLink

Returns the “default value” for a type. Read more
source§

fn properties() -> &'static [ParamSpec]

Properties installed for this type.
source§

fn signals() -> &'static [Signal]

Signals installed for this type.
source§

fn set_property(&self, _id: usize, _value: &Value, _pspec: &ParamSpec)

Property setter. Read more
source§

fn property(&self, _id: usize, _pspec: &ParamSpec) -> Value

Property getter. Read more
source§

fn constructed(&self)

Constructed. Read more
source§

fn dispose(&self)

Disposes of the object. Read more
source§

fn notify(&self, pspec: &ParamSpec)

Function to be called when property change is notified for with self.notify("property").
source§

fn dispatch_properties_changed(&self, pspecs: &[ParamSpec])

source§

fn supported_features(&self, object: &Self::Type) -> ObjectFeatures

source§

fn activate_get_next_step( &self, object: &Self::Type, transition: FeatureActivationTransition, step: u32, features: ObjectFeatures ) -> u32

source§

fn activate_execute_step( &self, object: &Self::Type, transition: FeatureActivationTransition, step: u32, features: ObjectFeatures )

source§

fn deactivate(&self, object: &Self::Type, features: ObjectFeatures)

§

type Interfaces = ()

List of interfaces implemented by this type.
§

type Class = ClassStruct<StaticLink>

The C class struct. Read more
§

type Instance = InstanceStruct<StaticLink>

The C instance struct. Read more
source§

fn new() -> Self

Constructor. Read more
§

type Type = SimplePluginObject<StaticLink>

Wrapper around this subclass defined with wrapper!
§

type ParentType = Plugin

Parent Rust type to inherit from.
source§

const NAME: &'static str = LOG_DOMAIN

GObject type name. Read more
source§

const ABSTRACT: bool = false

If this subclass is an abstract class or not. Read more
source§

fn type_init(_type_: &mut InitializingType<Self>)

Additional type initialization. Read more
source§

fn class_init(_klass: &mut Self::Class)

Class initialization. Read more
source§

fn with_class(_klass: &Self::Class) -> Self

Constructor. Read more
source§

fn instance_init(_obj: &InitializingObject<Self>)

Performs additional instance initialization. Read more
source§

fn type_data() -> NonNull<TypeData>

Storage for the type-specific data used during registration.
source§

fn type_() -> Type

Returns the glib::Type ID of the subclass. Read more

This makes StaticLink a plugin that can be used with plugin::simple_plugin_subclass below.

§

type Args = Vec<StaticLinkArgs>

source§

fn init_args(&self, args: Self::Args)

source§

fn decode_args(args: Option<Variant>) -> Result<Self::Args, Error>

source§

fn instance_ref(&self) -> BorrowedObject<'_, Self::Type>

source§

fn new_plugin(core: &Core, args: Self::Args) -> Self::Type
where Self::Type: IsA<Object>,

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> 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> ModuleExport for T

source§

fn init(core: Core, args: Option<Variant>) -> Result<(), Error>

source§

impl<T> ObjectImplExt for T
where T: ObjectImpl,

source§

impl<T> ObjectImplExt for T
where T: ObjectImpl,

source§

fn parent_constructed(&self)

Chain up to the parent class’ implementation of glib::Object::constructed().
source§

fn parent_notify(&self, pspec: &ParamSpec)

Chain up to the parent class’ implementation of glib::Object::notify().
source§

fn parent_dispatch_properties_changed(&self, pspecs: &[ParamSpec])

Chain up to the parent class’ implementation of glib::Object::dispatch_properties_changed().
source§

fn signal_chain_from_overridden( &self, token: &SignalClassHandlerToken, values: &[Value] ) -> Option<Value>

Chain up to parent class signal handler.
source§

impl<T> ObjectSubclassExt for T
where T: ObjectSubclass,

source§

fn instance(&self) -> BorrowedObject<'_, <T as ObjectSubclass>::Type>

👎Deprecated: Use obj() instead
Returns the corresponding object instance.
source§

fn from_instance(obj: &<T as ObjectSubclass>::Type) -> &T

👎Deprecated: Use from_obj() instead
Returns the implementation from an instance.
source§

fn obj(&self) -> BorrowedObject<'_, <T as ObjectSubclass>::Type>

Returns the corresponding object instance. Read more
source§

fn from_obj(obj: &<T as ObjectSubclass>::Type) -> &T

Returns the implementation from an instance. Read more
source§

fn ref_counted(&self) -> ObjectImplRef<T>

Returns a new reference-counted wrapper around self.
source§

fn instance_data<U>(&self, type_: Type) -> Option<&U>
where U: Any + Send + Sync + 'static,

Returns a pointer to the instance implementation specific data. Read more
source§

impl<T> PluginImpl for T

source§

fn enable(&self, this: &<T as ObjectSubclass>::Type, error_handler: Transition)

source§

fn disable(&self, _plugin: &<T as ObjectSubclass>::Type)

source§

impl<T> PluginImplExt for T
where T: PluginImpl,

source§

fn parent_class(&self) -> &WpPluginClass

source§

fn parent_enable( &self, plugin: &<T as ObjectSubclass>::Type, error_handler: Transition )

source§

fn parent_disable(&self, plugin: &<T as ObjectSubclass>::Type)

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.