Struct gio::DBusProxy[−][src]

pub struct DBusProxy(_);

Expand description

DBusProxy is a base class used for proxies to access a D-Bus interface on a remote object. A DBusProxy can be constructed for both well-known and unique names.

By default, DBusProxy will cache all properties (and listen to changes) of the remote object, and proxy all signals that get emitted. This behaviour can be changed by passing suitable DBusProxyFlags when the proxy is created. If the proxy is for a well-known name, the property cache is flushed when the name owner vanishes and reloaded when a name owner appears.

The unique name owner of the proxy’s name is tracked and can be read from property::DBusProxy::g-name-owner. Connect to the signal::glib::Object::notify signal to get notified of changes. Additionally, only signals and property changes emitted from the current name owner are considered and calls are always sent to the current name owner. This avoids a number of race conditions when the name is lost by one owner and claimed by another. However, if no name owner currently exists, then calls will be sent to the well-known name which may result in the message bus launching an owner (unless DBusProxyFlags::DO_NOT_AUTO_START is set).

The generic signal::DBusProxy::g-properties-changed and signal::DBusProxy::g-signal signals are not very convenient to work with. Therefore, the recommended way of working with proxies is to subclass DBusProxy, and have more natural properties and signals in your derived class. This [example][gdbus-example-gdbus-codegen] shows how this can easily be done using the [gdbus-codegen][gdbus-codegen] tool.

A DBusProxy instance can be used from multiple threads but note that all signals (e.g. signal::DBusProxy::g-signal, signal::DBusProxy::g-properties-changed and signal::glib::Object::notify) are emitted in the [thread-default main context][g-main-context-push-thread-default] of the thread where the instance was constructed.

An example using a proxy for a well-known name can be found in gdbus-example-watch-proxy.c

Implements

DBusProxyExt, glib::ObjectExt, DBusInterfaceExt

Implementations

impl DBusProxy

pub fn for_bus_sync<P: IsA<Cancellable>>(
    bus_type: BusType, 
    flags: DBusProxyFlags, 
    info: Option<&DBusInterfaceInfo>, 
    name: &str, 
    object_path: &str, 
    interface_name: &str, 
    cancellable: Option<&P>
) -> Result<DBusProxy, Error>

Like new_sync() but takes a BusType instead of a DBusConnection.

DBusProxy is used in this [example][gdbus-wellknown-proxy].

`bus_type`

`flags`

Flags used when constructing the proxy.

`info`

A DBusInterfaceInfo specifying the minimal interface that proxy conforms to or None.

`name`

A bus name (well-known or unique).

`object_path`

An object path.

`interface_name`

A D-Bus interface name.

`cancellable`

A Cancellable or None.

Returns

A DBusProxy or None if error is set. Free with g_object_unref().

pub fn new_sync<P: IsA<Cancellable>>(
    connection: &DBusConnection, 
    flags: DBusProxyFlags, 
    info: Option<&DBusInterfaceInfo>, 
    name: Option<&str>, 
    object_path: &str, 
    interface_name: &str, 
    cancellable: Option<&P>
) -> Result<DBusProxy, Error>

Creates a proxy for accessing interface_name on the remote object at object_path owned by name at connection and synchronously loads D-Bus properties unless the DBusProxyFlags::DO_NOT_LOAD_PROPERTIES flag is used.

If the DBusProxyFlags::DO_NOT_CONNECT_SIGNALS flag is not set, also sets up match rules for signals. Connect to the signal::DBusProxy::g-signal signal to handle signals from the remote object.

If both DBusProxyFlags::DO_NOT_LOAD_PROPERTIES and DBusProxyFlags::DO_NOT_CONNECT_SIGNALS are set, this constructor is guaranteed to return immediately without blocking.

If name is a well-known name and the DBusProxyFlags::DO_NOT_AUTO_START and DBusProxyFlags::DO_NOT_AUTO_START_AT_CONSTRUCTION flags aren’t set and no name owner currently exists, the message bus will be requested to launch a name owner for the name.

This is a synchronous failable constructor. See new() and g_dbus_proxy_new_finish() for the asynchronous version.

DBusProxy is used in this [example][gdbus-wellknown-proxy].

`connection`

A DBusConnection.

`flags`

Flags used when constructing the proxy.

`info`

A DBusInterfaceInfo specifying the minimal interface that proxy conforms to or None.

`name`

A bus name (well-known or unique) or None if connection is not a message bus connection.

`object_path`

An object path.

`interface_name`

A D-Bus interface name.

`cancellable`

A Cancellable or None.

Returns

A DBusProxy or None if error is set. Free with g_object_unref().

pub fn new<P: IsA<Cancellable>, Q: FnOnce(Result<DBusProxy, Error>) + Send + 'static>(
    connection: &DBusConnection, 
    flags: DBusProxyFlags, 
    info: Option<&DBusInterfaceInfo>, 
    name: Option<&str>, 
    object_path: &str, 
    interface_name: &str, 
    cancellable: Option<&P>, 
    callback: Q
)

Creates a proxy for accessing interface_name on the remote object at object_path owned by name at connection and asynchronously loads D-Bus properties unless the DBusProxyFlags::DO_NOT_LOAD_PROPERTIES flag is used. Connect to the signal::DBusProxy::g-properties-changed signal to get notified about property changes.

If the DBusProxyFlags::DO_NOT_CONNECT_SIGNALS flag is not set, also sets up match rules for signals. Connect to the signal::DBusProxy::g-signal signal to handle signals from the remote object.

If both DBusProxyFlags::DO_NOT_LOAD_PROPERTIES and DBusProxyFlags::DO_NOT_CONNECT_SIGNALS are set, this constructor is guaranteed to complete immediately without blocking.

If name is a well-known name and the DBusProxyFlags::DO_NOT_AUTO_START and DBusProxyFlags::DO_NOT_AUTO_START_AT_CONSTRUCTION flags aren’t set and no name owner currently exists, the message bus will be requested to launch a name owner for the name.

This is a failable asynchronous constructor - when the proxy is ready, callback will be invoked and you can use g_dbus_proxy_new_finish() to get the result.

See new_sync() and for a synchronous version of this constructor.

DBusProxy is used in this [example][gdbus-wellknown-proxy].

`connection`

A DBusConnection.

`flags`

Flags used when constructing the proxy.

`info`

A DBusInterfaceInfo specifying the minimal interface that proxy conforms to or None.

`name`

A bus name (well-known or unique) or None if connection is not a message bus connection.

`object_path`

An object path.

`interface_name`

A D-Bus interface name.

`cancellable`

A Cancellable or None.

`callback`

Callback function to invoke when the proxy is ready.

pub fn new_future(
    connection: &DBusConnection, 
    flags: DBusProxyFlags, 
    info: Option<&DBusInterfaceInfo>, 
    name: Option<&str>, 
    object_path: &str, 
    interface_name: &str
) -> Pin<Box_<dyn Future<Output = Result<DBusProxy, Error>> + 'static>>

pub fn for_bus<P: IsA<Cancellable>, Q: FnOnce(Result<DBusProxy, Error>) + Send + 'static>(
    bus_type: BusType, 
    flags: DBusProxyFlags, 
    info: Option<&DBusInterfaceInfo>, 
    name: &str, 
    object_path: &str, 
    interface_name: &str, 
    cancellable: Option<&P>, 
    callback: Q
)

Like new() but takes a BusType instead of a DBusConnection.

DBusProxy is used in this [example][gdbus-wellknown-proxy].

`bus_type`

`flags`

Flags used when constructing the proxy.

`info`

A DBusInterfaceInfo specifying the minimal interface that proxy conforms to or None.

`name`

A bus name (well-known or unique).

`object_path`

An object path.

`interface_name`

A D-Bus interface name.

`cancellable`

A Cancellable or None.

`callback`

Callback function to invoke when the proxy is ready.

pub fn for_bus_future(
    bus_type: BusType, 
    flags: DBusProxyFlags, 
    info: Option<&DBusInterfaceInfo>, 
    name: &str, 
    object_path: &str, 
    interface_name: &str
) -> Pin<Box_<dyn Future<Output = Result<DBusProxy, Error>> + 'static>>

Trait Implementations

impl Clone for DBusProxy

fn clone(&self) -> DBusProxy

Returns a copy of the value. Read more

1.0.0[src]

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

Performs copy-assignment from source. Read more

impl Debug for DBusProxy

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

Formats the value using the given formatter. Read more

impl Display for DBusProxy

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

Formats the value using the given formatter. Read more

impl Hash for DBusProxy

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

Feeds this value into the given Hasher. Read more

1.3.0[src]

fn hash_slice<H>(data: &[Self], state: &mut H) where
    H: Hasher,

Feeds a slice of this type into the given Hasher. Read more

impl Ord for DBusProxy

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

This method returns an Ordering between self and other. Read more

1.21.0[src]

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

Compares and returns the maximum of two values. Read more

1.21.0[src]

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

Compares and returns the minimum of two values. Read more

1.50.0[src]

fn clamp(self, min: Self, max: Self) -> Self

Restrict a value to a certain interval. Read more

impl ParentClassIs for DBusProxy

type Parent = Object

impl<T: ObjectType> PartialEq<T> for DBusProxy

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

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

1.0.0[src]

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

This method tests for !=.

impl<T: ObjectType> PartialOrd<T> for DBusProxy

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

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

1.0.0[src]

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

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

1.0.0[src]

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

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

1.0.0[src]

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

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

1.0.0[src]

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

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

impl StaticType for DBusProxy

fn static_type() -> Type

Returns the type identifier of Self.

impl Eq for DBusProxy

impl IsA<DBusInterface> for DBusProxy

impl Send for DBusProxy

impl StructuralEq for DBusProxy

impl Sync for DBusProxy

Auto Trait Implementations

impl RefUnwindSafe for DBusProxy

impl Unpin for DBusProxy

impl UnwindSafe for DBusProxy

Blanket Implementations

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

pub fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more

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

pub fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

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

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

Mutably borrows from an owned value. Read more

impl<T> Cast for T where
    T: ObjectType,

fn upcast<T>(self) -> T where
    Self: IsA<T>,
    T: ObjectType,

Upcasts an object to a superclass or interface T. Read more

fn upcast_ref<T>(&self) -> &T where
    Self: IsA<T>,
    T: ObjectType,

Upcasts an object to a reference of its superclass or interface T. Read more

fn downcast<T>(self) -> Result<T, Self> where
    Self: CanDowncast<T>,
    T: ObjectType,

Tries to downcast to a subclass or interface implementor T. Read more

fn downcast_ref<T>(&self) -> Option<&T> where
    Self: CanDowncast<T>,
    T: ObjectType,

Tries to downcast to a reference of its subclass or interface implementor T. Read more

fn dynamic_cast<T>(self) -> Result<T, Self> where
    T: ObjectType,

Tries to cast to an object of type T. This handles upcasting, downcasting and casting between interface and interface implementors. All checks are performed at runtime, while downcast and upcast will do many checks at compile-time already. Read more

fn dynamic_cast_ref<T>(&self) -> Option<&T> where
    T: ObjectType,

Tries to cast to reference to an object of type T. This handles upcasting, downcasting and casting between interface and interface implementors. All checks are performed at runtime, while downcast and upcast will do many checks at compile-time already. Read more

unsafe fn unsafe_cast<T>(self) -> T where
    T: ObjectType,

Casts to T unconditionally. Read more

unsafe fn unsafe_cast_ref<T>(&self) -> &T where
    T: ObjectType,

Casts to &T unconditionally. Read more

impl<T> From<T> for T

pub fn from(t: T) -> T

Performs the conversion.

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

pub fn into(self) -> U

Performs the conversion.

impl<T> ObjectExt for T where
    T: ObjectType,

pub fn is<U>(&self) -> bool where
    U: StaticType,

Returns true if the object is an instance of (can be cast to) T.

pub fn type_(&self) -> Type

pub fn object_class(&self) -> &Class<Object>

pub fn class(&self) -> &Class<T> where
    T: IsClass,

pub fn class_of<U>(&self) -> Option<&Class<U>> where
    U: IsClass,

pub fn interface<U>(&self) -> Option<InterfaceRef<'_, U>> where
    U: IsInterface,

pub fn set_properties(
    &self, 
    property_values: &[(&str, &dyn ToValue)]
) -> Result<(), BoolError>

pub fn set_properties_from_value(
    &self, 
    property_values: &[(&str, Value)]
) -> Result<(), BoolError>

pub fn set_property<'a, N, V>(
    &self, 
    property_name: N, 
    value: V
) -> Result<(), BoolError> where
    V: ToValue,
    N: Into<&'a str>,

pub fn set_property_from_value<'a, N>(
    &self, 
    property_name: N, 
    value: &Value
) -> Result<(), BoolError> where
    N: Into<&'a str>,

pub fn property<'a, N>(&self, property_name: N) -> Result<Value, BoolError> where
    N: Into<&'a str>,

pub unsafe fn set_qdata<QD>(&self, key: Quark, value: QD) where
    QD: 'static,

Safety Read more

pub unsafe fn qdata<QD>(&self, key: Quark) -> Option<NonNull<QD>> where
    QD: 'static,

Safety Read more

pub unsafe fn steal_qdata<QD>(&self, key: Quark) -> Option<QD> where
    QD: 'static,

Safety Read more

pub unsafe fn set_data<QD>(&self, key: &str, value: QD) where
    QD: 'static,

Safety Read more

pub unsafe fn data<QD>(&self, key: &str) -> Option<NonNull<QD>> where
    QD: 'static,

Safety Read more

pub unsafe fn steal_data<QD>(&self, key: &str) -> Option<QD> where
    QD: 'static,

Safety Read more

pub fn block_signal(&self, handler_id: &SignalHandlerId)

pub fn unblock_signal(&self, handler_id: &SignalHandlerId)

pub fn stop_signal_emission(&self, signal_name: &str)

pub fn disconnect(&self, handler_id: SignalHandlerId)

pub fn connect_notify<F>(&self, name: Option<&str>, f: F) -> SignalHandlerId where
    F: 'static + Fn(&T, &ParamSpec) + Send + Sync,

pub fn connect_notify_local<F>(
    &self, 
    name: Option<&str>, 
    f: F
) -> SignalHandlerId where
    F: 'static + Fn(&T, &ParamSpec),

pub unsafe fn connect_notify_unsafe<F>(
    &self, 
    name: Option<&str>, 
    f: F
) -> SignalHandlerId where
    F: Fn(&T, &ParamSpec),

pub fn notify<'a, N>(&self, property_name: N) where
    N: Into<&'a str>,

pub fn notify_by_pspec(&self, pspec: &ParamSpec)

pub fn has_property<'a, N>(&self, property_name: N, type_: Option<Type>) -> bool where
    N: Into<&'a str>,

pub fn property_type<'a, N>(&self, property_name: N) -> Option<Type> where
    N: Into<&'a str>,

pub fn find_property<'a, N>(&self, property_name: N) -> Option<ParamSpec> where
    N: Into<&'a str>,

pub fn list_properties(&self) -> Vec<ParamSpec, Global>

pub fn freeze_notify(&self) -> PropertyNotificationFreezeGuard

pub fn connect<'a, N, F>(
    &self, 
    signal_name: N, 
    after: bool, 
    callback: F
) -> Result<SignalHandlerId, BoolError> where
    F: Fn(&[Value]) -> Option<Value> + Send + Sync + 'static,
    N: Into<&'a str>,

pub fn connect_id<F>(
    &self, 
    signal_id: SignalId, 
    details: Option<Quark>, 
    after: bool, 
    callback: F
) -> Result<SignalHandlerId, BoolError> where
    F: Fn(&[Value]) -> Option<Value> + Send + Sync + 'static,

Same as connect but takes a SignalId instead of a signal name.

pub fn connect_local<'a, N, F>(
    &self, 
    signal_name: N, 
    after: bool, 
    callback: F
) -> Result<SignalHandlerId, BoolError> where
    F: Fn(&[Value]) -> Option<Value> + 'static,
    N: Into<&'a str>,

pub fn connect_local_id<F>(
    &self, 
    signal_id: SignalId, 
    details: Option<Quark>, 
    after: bool, 
    callback: F
) -> Result<SignalHandlerId, BoolError> where
    F: Fn(&[Value]) -> Option<Value> + 'static,

Same as connect_local but takes a SignalId instead of a signal name.

pub unsafe fn connect_unsafe<'a, N, F>(
    &self, 
    signal_name: N, 
    after: bool, 
    callback: F
) -> Result<SignalHandlerId, BoolError> where
    F: Fn(&[Value]) -> Option<Value>,
    N: Into<&'a str>,

pub unsafe fn connect_unsafe_id<F>(
    &self, 
    signal_id: SignalId, 
    details: Option<Quark>, 
    after: bool, 
    callback: F
) -> Result<SignalHandlerId, BoolError> where
    F: Fn(&[Value]) -> Option<Value>,

Same as connect_unsafe but takes a SignalId instead of a signal name.

pub fn emit(
    &self, 
    signal_id: SignalId, 
    args: &[&dyn ToValue]
) -> Result<Option<Value>, BoolError>

Emit signal by signal id.

pub fn emit_with_details(
    &self, 
    signal_id: SignalId, 
    details: Quark, 
    args: &[&dyn ToValue]
) -> Result<Option<Value>, BoolError>

Emit signal with details by signal id.

pub fn emit_by_name<'a, N>(
    &self, 
    signal_name: N, 
    args: &[&dyn ToValue]
) -> Result<Option<Value>, BoolError> where
    N: Into<&'a str>,

Emit signal by it’s name.

pub fn downgrade(&self) -> WeakRef<T>

pub fn bind_property<'a, O, N, M>(
    &'a self, 
    source_property: N, 
    target: &'a O, 
    target_property: M
) -> BindingBuilder<'a> where
    O: ObjectType,
    N: Into<&'a str>,
    M: Into<&'a str>,

pub fn ref_count(&self) -> u32

pub fn emit_with_values(
    &self, 
    signal_id: SignalId, 
    args: &[Value]
) -> Result<Option<Value>, BoolError>

Same as emit but takes Value for the arguments.

pub fn emit_by_name_with_values<'a, N>(
    &self, 
    signal_name: N, 
    args: &[Value]
) -> Result<Option<Value>, BoolError> where
    N: Into<&'a str>,

Same as emit_by_name but takes Value for the arguments.

pub fn emit_with_details_and_values(
    &self, 
    signal_id: SignalId, 
    details: Quark, 
    args: &[Value]
) -> Result<Option<Value>, BoolError>

Same as emit_with_details but takes Value for the arguments.

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

type Owned = T

The resulting type after obtaining ownership.

pub fn to_owned(&self) -> T

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

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

🔬 This is a nightly-only experimental API. (toowned_clone_into)

recently added

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

impl<T> ToSendValue for T where
    T: Send + ToValue + ?Sized,

pub fn to_send_value(&self) -> SendValue

Returns a SendValue clone of self.

impl<T> ToString for T where
    T: Display + ?Sized,

pub default fn to_string(&self) -> String

Converts the given value to a String. Read more

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

type Error = Infallible

The type returned in the event of a conversion error.

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

Performs the conversion.

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.

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

Performs the conversion.

impl<Super, Sub> CanDowncast<Sub> for Super where
    Sub: IsA<Super>,
    Super: IsA<Super>,

impl<'a, T, C> FromValueOptional<'a> for T where
    C: ValueTypeChecker<Error = ValueTypeMismatchOrNoneError>,
    T: FromValue<'a, Checker = C>,