Struct DBusConnection 

pub struct DBusConnection { /* private fields */ }

GLib type: GObject with reference counted clone semantics.

Implementations

impl DBusConnection

pub fn register_object<'a>( &'a self, object_path: &'a str, interface_info: &'a DBusInterfaceInfo, ) -> RegistrationBuilder<'a>

pub fn unregister_object( &self, registration_id: RegistrationId, ) -> Result<(), BoolError>

pub fn export_action_group<P: IsA<ActionGroup>>( &self, object_path: &str, action_group: &P, ) -> Result<ActionGroupExportId, Error>

pub fn unexport_action_group(&self, export_id: ActionGroupExportId)

pub fn export_menu_model<P: IsA<MenuModel>>( &self, object_path: &str, menu: &P, ) -> Result<MenuModelExportId, Error>

pub fn unexport_menu_model(&self, export_id: MenuModelExportId)

pub fn add_filter<P: Fn(&DBusConnection, &DBusMessage, bool) -> Option<DBusMessage> + 'static>( &self, filter_function: P, ) -> FilterId

pub fn remove_filter(&self, filter_id: FilterId)

pub fn subscribe_to_signal<P: Fn(DBusSignalRef<'_>) + 'static>( &self, sender: Option<&str>, interface_name: Option<&str>, member: Option<&str>, object_path: Option<&str>, arg0: Option<&str>, flags: DBusSignalFlags, callback: P, ) -> SignalSubscription

Subscribe to a D-Bus signal.

See Self::signal_subscribe for arguments.

Return a signal subscription which keeps a reference to this D-Bus connection and unsubscribes from the signal when dropped.

To avoid reference cycles you may wish to downgrade the returned subscription to a weak one with SignalSubscription::downgrade.

pub fn signal_subscribe<P: Fn(&DBusConnection, &str, &str, &str, &str, &Variant) + 'static>( &self, sender: Option<&str>, interface_name: Option<&str>, member: Option<&str>, object_path: Option<&str>, arg0: Option<&str>, flags: DBusSignalFlags, callback: P, ) -> SignalSubscriptionId

👎Deprecated: Prefer subscribe_to_signal

pub fn signal_unsubscribe(&self, subscription_id: SignalSubscriptionId)

👎Deprecated: Prefer subscribe_to_signal

pub fn receive_signal<T: 'static, F: Fn(DBusSignalRef<'_>) -> T + 'static>( &self, sender: Option<&str>, interface_name: Option<&str>, member: Option<&str>, object_path: Option<&str>, arg0: Option<&str>, flags: DBusSignalFlags, map_signal: F, ) -> SubscribedSignalStream<SignalSubscription, impl Stream<Item = T> + use<T, F>>

Subscribe to a D-Bus signal and receive signal emissions as a stream.

See Self::signal_subscribe for arguments. map_signal maps the received signal to the stream’s element.

The returned stream holds a strong reference to this D-Bus connection, and unsubscribes from the signal when dropped. To avoid reference cycles you may wish to downgrade the returned stream to hold only weak reference to the connection using SubscribedSignalStream::downgrade.

After invoking map_signal the stream threads incoming signals through an unbounded channel. Hence, memory consumption will keep increasing as long as the stream consumer does not keep up with signal emissions. If you need to perform expensive processing in response to signals it’s therefore recommended to insert an extra buffering and if the buffer overruns, either fail drop the entire stream, or drop individual signal emissions until the buffer has space again.

pub fn receive_signal_parameters<T>( &self, sender: Option<&str>, interface_name: Option<&str>, member: Option<&str>, object_path: Option<&str>, arg0: Option<&str>, flags: DBusSignalFlags, ) -> SubscribedSignalStream<SignalSubscription, impl Stream<Item = Result<T, VariantTypeMismatchError>> + use<T>>

where T: FromVariant + 'static,

Subscribe to a D-Bus signal and receive signal parameters as a stream.

Like Self::receive_signal (which see for more information), but automatically decodes the emitted signal parameters to type T. If decoding fails the corresponding variant type error is sent downstream.

impl DBusConnection

pub fn for_address_sync( address: &str, flags: DBusConnectionFlags, observer: Option<&DBusAuthObserver>, cancellable: Option<&impl IsA<Cancellable>>, ) -> Result<DBusConnection, Error>

pub fn new_sync( stream: &impl IsA<IOStream>, guid: Option<&str>, flags: DBusConnectionFlags, observer: Option<&DBusAuthObserver>, cancellable: Option<&impl IsA<Cancellable>>, ) -> Result<DBusConnection, Error>

pub fn call<P: FnOnce(Result<Variant, Error>) + 'static>( &self, bus_name: Option<&str>, object_path: &str, interface_name: &str, method_name: &str, parameters: Option<&Variant>, reply_type: Option<&VariantTy>, flags: DBusCallFlags, timeout_msec: i32, cancellable: Option<&impl IsA<Cancellable>>, callback: P, )

pub fn call_future( &self, bus_name: Option<&str>, object_path: &str, interface_name: &str, method_name: &str, parameters: Option<&Variant>, reply_type: Option<&VariantTy>, flags: DBusCallFlags, timeout_msec: i32, ) -> Pin<Box_<dyn Future<Output = Result<Variant, Error>> + 'static>>

pub fn call_sync( &self, bus_name: Option<&str>, object_path: &str, interface_name: &str, method_name: &str, parameters: Option<&Variant>, reply_type: Option<&VariantTy>, flags: DBusCallFlags, timeout_msec: i32, cancellable: Option<&impl IsA<Cancellable>>, ) -> Result<Variant, Error>

pub fn call_with_unix_fd_list<P: FnOnce(Result<(Variant, Option<UnixFDList>), Error>) + 'static>( &self, bus_name: Option<&str>, object_path: &str, interface_name: &str, method_name: &str, parameters: Option<&Variant>, reply_type: Option<&VariantTy>, flags: DBusCallFlags, timeout_msec: i32, fd_list: Option<&impl IsA<UnixFDList>>, cancellable: Option<&impl IsA<Cancellable>>, callback: P, )

Available on Unix only.

pub fn call_with_unix_fd_list_future( &self, bus_name: Option<&str>, object_path: &str, interface_name: &str, method_name: &str, parameters: Option<&Variant>, reply_type: Option<&VariantTy>, flags: DBusCallFlags, timeout_msec: i32, fd_list: Option<&(impl IsA<UnixFDList> + Clone + 'static)>, ) -> Pin<Box_<dyn Future<Output = Result<(Variant, Option<UnixFDList>), Error>> + 'static>>

Available on Unix only.

pub fn call_with_unix_fd_list_sync( &self, bus_name: Option<&str>, object_path: &str, interface_name: &str, method_name: &str, parameters: Option<&Variant>, reply_type: Option<&VariantTy>, flags: DBusCallFlags, timeout_msec: i32, fd_list: Option<&impl IsA<UnixFDList>>, cancellable: Option<&impl IsA<Cancellable>>, ) -> Result<(Variant, Option<UnixFDList>), Error>

Available on Unix only.

pub fn close<P: FnOnce(Result<(), Error>) + 'static>( &self, cancellable: Option<&impl IsA<Cancellable>>, callback: P, )

pub fn close_future( &self, ) -> Pin<Box_<dyn Future<Output = Result<(), Error>> + 'static>>

pub fn close_sync( &self, cancellable: Option<&impl IsA<Cancellable>>, ) -> Result<(), Error>

pub fn emit_signal( &self, destination_bus_name: Option<&str>, object_path: &str, interface_name: &str, signal_name: &str, parameters: Option<&Variant>, ) -> Result<(), Error>

pub fn flush<P: FnOnce(Result<(), Error>) + 'static>( &self, cancellable: Option<&impl IsA<Cancellable>>, callback: P, )

pub fn flush_future( &self, ) -> Pin<Box_<dyn Future<Output = Result<(), Error>> + 'static>>

pub fn flush_sync( &self, cancellable: Option<&impl IsA<Cancellable>>, ) -> Result<(), Error>

pub fn capabilities(&self) -> DBusCapabilityFlags

pub fn exits_on_close(&self) -> bool

pub fn flags(&self) -> DBusConnectionFlags

Available on crate feature v2_60 only.

pub fn guid(&self) -> GString

pub fn last_serial(&self) -> u32

pub fn peer_credentials(&self) -> Option<Credentials>

pub fn stream(&self) -> IOStream

pub fn unique_name(&self) -> Option<GString>

pub fn is_closed(&self) -> bool

pub fn send_message( &self, message: &DBusMessage, flags: DBusSendMessageFlags, ) -> Result<u32, Error>

pub fn send_message_with_reply<P: FnOnce(Result<DBusMessage, Error>) + 'static>( &self, message: &DBusMessage, flags: DBusSendMessageFlags, timeout_msec: i32, cancellable: Option<&impl IsA<Cancellable>>, callback: P, ) -> u32

pub fn send_message_with_reply_future( &self, message: &DBusMessage, flags: DBusSendMessageFlags, timeout_msec: i32, ) -> Pin<Box_<dyn Future<Output = Result<DBusMessage, Error>> + 'static>>

pub fn send_message_with_reply_sync( &self, message: &DBusMessage, flags: DBusSendMessageFlags, timeout_msec: i32, cancellable: Option<&impl IsA<Cancellable>>, ) -> Result<(DBusMessage, u32), Error>

pub fn set_exit_on_close(&self, exit_on_close: bool)

pub fn start_message_processing(&self)

pub fn new<P: FnOnce(Result<DBusConnection, Error>) + 'static>( stream: &impl IsA<IOStream>, guid: Option<&str>, flags: DBusConnectionFlags, observer: Option<&DBusAuthObserver>, cancellable: Option<&impl IsA<Cancellable>>, callback: P, )

pub fn new_future( stream: &(impl IsA<IOStream> + Clone + 'static), guid: Option<&str>, flags: DBusConnectionFlags, observer: Option<&DBusAuthObserver>, ) -> Pin<Box_<dyn Future<Output = Result<DBusConnection, Error>> + 'static>>

pub fn for_address<P: FnOnce(Result<DBusConnection, Error>) + 'static>( address: &str, flags: DBusConnectionFlags, observer: Option<&DBusAuthObserver>, cancellable: Option<&impl IsA<Cancellable>>, callback: P, )

pub fn for_address_future( address: &str, flags: DBusConnectionFlags, observer: Option<&DBusAuthObserver>, ) -> Pin<Box_<dyn Future<Output = Result<DBusConnection, Error>> + 'static>>

pub fn connect_closed<F: Fn(&Self, bool, Option<&Error>) + Send + Sync + 'static>( &self, f: F, ) -> SignalHandlerId

pub fn connect_capabilities_notify<F: Fn(&Self) + Send + Sync + 'static>( &self, f: F, ) -> SignalHandlerId

pub fn connect_closed_notify<F: Fn(&Self) + Send + Sync + 'static>( &self, f: F, ) -> SignalHandlerId

pub fn connect_exit_on_close_notify<F: Fn(&Self) + Send + Sync + 'static>( &self, f: F, ) -> SignalHandlerId

pub fn connect_unique_name_notify<F: Fn(&Self) + Send + Sync + 'static>( &self, f: F, ) -> SignalHandlerId

Trait Implementations

impl Clone for DBusConnection

fn clone(&self) -> Self

Makes a clone of this shared reference.

This increments the strong reference count of the object. Dropping the object will decrement it again.

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

Performs copy-assignment from source.

impl Debug for DBusConnection

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

Formats the value using the given formatter.

impl HasParamSpec for DBusConnection

type ParamSpec = ParamSpecObject

type SetValue = DBusConnection

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

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

fn param_spec_builder() -> Self::BuilderFn

impl Hash for DBusConnection

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

where H: Hasher,

Hashes the memory address of this object.

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 Ord for DBusConnection

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

Comparison for two GObjects.

Compares the memory addresses of the provided objects.

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

where Self: Sized,

Compares and returns the maximum of two values.

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

where Self: Sized,

Compares and returns the minimum of two values.

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

where Self: Sized,

Restrict a value to a certain interval.

impl ParentClassIs for DBusConnection

type Parent = Object

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

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

Equality for two GObjects.

Two GObjects are equal if their memory addresses are equal.

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

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

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

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

Partial comparison for two GObjects.

Compares the memory addresses of the provided objects.

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

Tests less than (for self and other) and is used by the < operator.

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

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

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

Tests greater than (for self and other) and is used by the > operator.

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

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

impl StaticType for DBusConnection

fn static_type() -> Type

Returns the type identifier of Self.

impl Eq for DBusConnection

impl IsA<AsyncInitable> for DBusConnection

impl IsA<Initable> for DBusConnection

impl Send for DBusConnection

impl Sync for DBusConnection