Struct DBusMessage 

pub struct DBusMessage { /* private fields */ }

A type for representing D-Bus messages that can be sent or received on a DBusConnection.

Properties

locked

Readable

Implements

[trait@glib::ObjectExt]

GLib type: GObject with reference counted clone semantics.

Implementations

impl DBusMessage

pub fn new() -> DBusMessage

Creates a new empty D-Bus message.

Returns

The D-Bus message

pub fn from_blob( blob: &[u8], capabilities: DBusCapabilityFlags, ) -> Result<DBusMessage, Error>

Creates a new D-Bus message from the data stored at @blob.

You must have previously called bytes_needed() on @blob, and ensure that @blob is at least as long as the return value from that function indicates. In particular, that means that @blob must be at least 16 bytes long (but will typically be much longer).

The byte order that the message was in can be retrieved using byte_order().

If the @blob cannot be parsed, contains invalid fields, or contains invalid headers, [error@Gio.IOErrorEnum.INVALID_ARGUMENT] will be returned.

blob

a blob representing a binary D-Bus message

capabilities

flags describing what protocol features are supported

Returns

The D-Bus message

pub fn new_method_call( name: Option<&str>, path: &str, interface_: Option<&str>, method: &str, ) -> DBusMessage

Creates a new D-Bus message for a method call.

name

a valid D-Bus name, or NULL if no destination is needed

path

a valid object path

interface_

a valid D-Bus interface name, or NULL if none is needed

method

a valid method name

Returns

The D-Bus message

pub fn new_signal(path: &str, interface_: &str, signal: &str) -> DBusMessage

Creates a new D-Bus message for a signal emission.

path

a valid object path

interface_

a valid D-Bus interface name

signal

a valid signal name

Returns

The D-Bus message

pub fn copy(&self) -> Result<DBusMessage, Error>

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

Convenience to get the first item in the body of @self.

See arg0_path() for returning object-path-typed arg0 values.

Returns

The string item, or NULL if the first item in the body of @self is not a string

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

Available on crate feature v2_80 only.

Convenience to get the first item in the body of @self.

See arg0() for returning string-typed arg0 values.

Returns

The object path item, or NULL if the first item in the body of @self is not an object path

pub fn body(&self) -> Option<Variant>

Gets the body of a message.

Returns

A [type@GLib.Variant], or NULL if the body is empty

pub fn byte_order(&self) -> DBusMessageByteOrder

Gets the byte order of @self.

Returns

The byte order

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

Convenience getter for the [enum@Gio.DBusMessageHeaderField.DESTINATION] header field.

Returns

The value

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

Convenience getter for the [enum@Gio.DBusMessageHeaderField.ERROR_NAME] header field.

Returns

The value

pub fn flags(&self) -> DBusMessageFlags

Gets the flags for @self.

Returns

Flags that are set (typically values from the DBusMessageFlags enumeration bitwise ORed together)

pub fn header(&self, header_field: DBusMessageHeaderField) -> Option<Variant>

Gets a header field on @self.

The caller is responsible for checking the type of the returned [type@GLib.Variant] matches what is expected.

header_field

a 8-bit unsigned integer (typically a value from the DBusMessageHeaderField enumeration)

Returns

A [type@GLib.Variant] with the value, or NULL if the header was not found

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

Convenience getter for the [enum@Gio.DBusMessageHeaderField.INTERFACE] header field.

Returns

The value

pub fn is_locked(&self) -> bool

Checks whether @self is locked.

To monitor changes to this value, connect to the notify signal to listen for changes on the locked property.

Returns

true if @self is locked, false otherwise

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

Convenience getter for the [enum@Gio.DBusMessageHeaderField.MEMBER] header field.

Returns

The value

pub fn message_type(&self) -> DBusMessageType

Gets the type of @self.

Returns

A 8-bit unsigned integer (typically a value from the DBusMessageType enumeration)

pub fn num_unix_fds(&self) -> u32

Available on Unix only.

Convenience getter for the [enum@Gio.DBusMessageHeaderField.NUM_UNIX_FDS] header field.

Returns

The value

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

Convenience getter for the [enum@Gio.DBusMessageHeaderField.PATH] header field.

Returns

The value

pub fn reply_serial(&self) -> u32

Convenience getter for the [enum@Gio.DBusMessageHeaderField.REPLY_SERIAL] header field.

Returns

The value

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

Convenience getter for the [enum@Gio.DBusMessageHeaderField.SENDER] header field.

Returns

The value

pub fn serial(&self) -> u32

Gets the serial for @self.

Returns

The serial number, which should not be zero

pub fn signature(&self) -> GString

Convenience getter for the [enum@Gio.DBusMessageHeaderField.SIGNATURE header field.

This will always be non-NULL, but may be an empty string.

Returns

The value

pub fn unix_fd_list(&self) -> Option<UnixFDList>

Available on Unix only.

Gets the UNIX file descriptors associated with @self, if any.

This method is only available on UNIX.

The file descriptors normally correspond to G_VARIANT_TYPE_HANDLE values in the body of the message. For example, if [glib::Variant::handle()][crate::glib::Variant::handle()] returns 5, that is intended to be a reference to the file descriptor that can be accessed by g_unix_fd_list_get (list, 5, ...).

Returns

A UnixFDList or NULL if no file descriptors are associated

pub fn lock(&self)

Locks the message.

If @self is locked already, this does nothing.

pub fn new_method_error_literal( &self, error_name: &str, error_message: &str, ) -> DBusMessage

Creates a new D-Bus message that is an error reply to @self.

error_name

a valid D-Bus error name

error_message

the D-Bus error message

Returns

The D-Bus message

pub fn new_method_reply(&self) -> DBusMessage

Creates a new D-Bus message that is a reply to @self.

Returns

The D-Bus message

pub fn print(&self, indent: u32) -> GString

Produces a human-readable multi-line description of @self.

The contents and formatting are subject to change at any time and no ABI guarantees are given. Typical output looks something like this:

Flags:   none
Version: 0
Serial:  4
Headers:
  path -> objectpath '/org/gtk/GDBus/TestObject'
  interface -> 'org.gtk.GDBus.TestInterface'
  member -> 'GimmeStdout'
  destination -> ':1.146'
Body: ()
UNIX File Descriptors:
  (none)

or

Flags:   no-reply-expected
Version: 0
Serial:  477
Headers:
  reply-serial -> uint32 4
  destination -> ':1.159'
  sender -> ':1.146'
  num-unix-fds -> uint32 1
Body: ()
UNIX File Descriptors:
  fd 12: dev=0:10,mode=020620,ino=5,uid=500,gid=5,rdev=136:2,size=0,atime=1273085037,mtime=1273085851,ctime=1272982635

indent

indentation level

Returns

Human readable description of @self

pub fn set_body(&self, body: &Variant)

Sets the body of @self.

As a side-effect the [enum@Gio.DBusMessageHeaderField.SIGNATURE] header field is set to the type string of @body (or cleared if @body is NULL).

If @body is floating, @self assumes ownership of @body.

body

a [type@GLib.Variant] containing a tuple, or NULL if no body is needed

pub fn set_byte_order(&self, byte_order: DBusMessageByteOrder)

Sets the byte order of @self.

byte_order

the byte order

pub fn set_destination(&self, value: Option<&str>)

Convenience setter for the [enum@Gio.DBusMessageHeaderField.DESTINATION] header field.

value

the value to set

pub fn set_error_name(&self, value: Option<&str>)

Convenience setter for the [enum@Gio.DBusMessageHeaderField.ERROR_NAME] header field.

value

the value to set

pub fn set_flags(&self, flags: DBusMessageFlags)

Sets the flags to set on @self.

flags

flags for @self that are set (typically values from the DBusMessageFlags enumeration bitwise ORed together)

pub fn set_header( &self, header_field: DBusMessageHeaderField, value: Option<&Variant>, )

Sets a header field on @self.

If @value is floating, @self assumes ownership of @value.

header_field

a 8-bit unsigned integer (typically a value from the DBusMessageHeaderField enumeration)

value

a [type@GLib.Variant] to set the header field, or NULL to clear the header field.

pub fn set_interface(&self, value: Option<&str>)

Convenience setter for the [enum@Gio.DBusMessageHeaderField.INTERFACE] header field.

value

the value to set

pub fn set_member(&self, value: Option<&str>)

Convenience setter for the [enum@Gio.DBusMessageHeaderField.MEMBER] header field.

value

the value to set

pub fn set_message_type(&self, type_: DBusMessageType)

Sets @self to be of @type_.

type_

a 8-bit unsigned integer (typically a value from the DBusMessageType enumeration)

pub fn set_num_unix_fds(&self, value: u32)

Available on Unix only.

Convenience setter for the [enum@Gio.DBusMessageHeaderField.NUM_UNIX_FDS] header field.

value

the value to set

pub fn set_path(&self, value: Option<&str>)

Convenience setter for the [enum@Gio.DBusMessageHeaderField.PATH] header field.

value

the value to set

pub fn set_reply_serial(&self, value: u32)

Convenience setter for the [enum@Gio.DBusMessageHeaderField.REPLY_SERIAL] header field.

value

the value to set

pub fn set_sender(&self, value: Option<&str>)

Convenience setter for the [enum@Gio.DBusMessageHeaderField.SENDER] header field.

value

the value to set

pub fn set_serial(&self, serial: u32)

Sets the serial for @self.

The D-Bus specification does not allow the @serial to be zero.

serial

a serial number, which must not be zero

pub fn set_signature(&self, value: Option<&str>)

Convenience setter for the [enum@Gio.DBusMessageHeaderField.SIGNATURE] header field.

value

the value to set

pub fn set_unix_fd_list(&self, fd_list: Option<&impl IsA<UnixFDList>>)

Available on Unix only.

Sets the UNIX file descriptors associated with @self.

As a side-effect the [enum@Gio.DBusMessageHeaderField.NUM_UNIX_FDS] header field is set to the number of fds in @fd_list (or cleared if @fd_list is NULL).

This method is only available on UNIX.

When designing D-Bus APIs that are intended to be interoperable, please note that non-GDBus implementations of D-Bus can usually only access file descriptors if they are referenced by a value of type G_VARIANT_TYPE_HANDLE in the body of the message.

fd_list

A UnixFDList, or NULL to clear

pub fn to_blob( &self, capabilities: DBusCapabilityFlags, ) -> Result<Vec<u8>, Error>

Serializes @self to a blob.

The byte order returned by byte_order() will be used.

capabilities

flags describing what protocol features are supported

Returns

A pointer to a valid binary D-Bus message of @out_size bytes generated by @self

pub fn to_gerror(&self) -> Result<(), Error>

Encodes the error in @self as a [type@GLib.Error].

If @self is of type [enum@Gio.DBusMessageType.ERROR], this function calls Gio::DBusError::set_dbus_error() using the information in the [enum@Gio.DBusMessageHeaderField.ERROR_NAME] header field of @self as well as the first string item in @self’s body.

If @self is not of type [enum@Gio.DBusMessageType.ERROR], this function does nothing and returns false.

Returns

true if @error was set, false otherwise

pub fn bytes_needed(blob: &[u8]) -> Result<isize, Error>

Utility function to calculate how many bytes are needed to completely deserialize the D-Bus message stored at @blob.

An error will be returned if @blob contains invalid data, or if not enough data is available to determine the size.

blob

a blob representing a binary D-Bus message.

Returns

Number of bytes needed or -1 if @error is set

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

Trait Implementations

impl Clone for DBusMessage

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 DBusMessage

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

Formats the value using the given formatter.

impl Default for DBusMessage

fn default() -> Self

Returns the “default value” for a type.

impl Display for DBusMessage

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

Formats the value using the given formatter.

impl HasParamSpec for DBusMessage

type ParamSpec = ParamSpecObject

type SetValue = DBusMessage

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

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

fn param_spec_builder() -> Self::BuilderFn

impl Hash for DBusMessage

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 DBusMessage

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 DBusMessage

type Parent = Object

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

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 DBusMessage

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 DBusMessage

fn static_type() -> Type

Returns the type identifier of Self.

impl Eq for DBusMessage