Struct gio::DBusMessage

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

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

Implements

glib::ObjectExt

Implementations

impl DBusMessage

pub fn new() -> DBusMessage

Creates a new empty DBusMessage.

Returns

A DBusMessage. Free with g_object_unref().

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

Creates a new DBusMessage from the data stored at blob. 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, IOErrorEnum::InvalidArgument will be returned.

blob

A blob representing a binary D-Bus message.

capabilities

A DBusCapabilityFlags describing what protocol features are supported.

Returns

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

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

Creates a new DBusMessage for a method call.

name

A valid D-Bus name or None.

path

A valid object path.

interface_

A valid D-Bus interface name or None.

method

A valid method name.

Returns

A DBusMessage. Free with g_object_unref().

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

Creates a new DBusMessage for a signal emission.

path

A valid object path.

interface_

A valid D-Bus interface name.

signal

A valid signal name.

Returns

A DBusMessage. Free with g_object_unref().

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

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

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

Returns

The string item or None if the first item in the body of self is not a string.

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

Gets the body of a message.

Returns

A glib::Variant or None if the body is empty. Do not free, it is owned by self.

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 DBusMessageHeaderField::Destination header field.

Returns

The value.

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

Convenience getter for the DBusMessageHeaderField::ErrorName 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 glib::Variant matches what is expected.

header_field

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

Returns

A glib::Variant with the value if the header was found, None otherwise. Do not free, it is owned by self.

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

Convenience getter for the DBusMessageHeaderField::Interface header field.

Returns

The value.

pub fn is_locked(&self) -> bool

Checks whether self is locked. To monitor changes to this value, conncet to the signal::glib::Object::notify signal to listen for changes on the property::DBusMessage::locked property.

Returns

true if self is locked, false otherwise.

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

Convenience getter for the 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 DBusMessageHeaderField::NumUnixFds header field.

Returns

The value.

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

Convenience getter for the DBusMessageHeaderField::Path header field.

Returns

The value.

pub fn reply_serial(&self) -> u32

Convenience getter for the DBusMessageHeaderField::ReplySerial header field.

Returns

The value.

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

Convenience getter for the DBusMessageHeaderField::Sender header field.

Returns

The value.

pub fn serial(&self) -> u32

Gets the serial for self.

Returns

A guint32.

pub fn signature(&self) -> GString

Convenience getter for the DBusMessageHeaderField::Signature header field.

This will always be non-None, 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 None if no file descriptors are associated. Do not free, this object is owned by self.

pub fn lock(&self)

If self is locked, does nothing. Otherwise locks the message.

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

Creates a new DBusMessage that is an error reply to self.

error_name

A valid D-Bus error name.

error_message

The D-Bus error message.

Returns

A DBusMessage. Free with g_object_unref().

pub fn new_method_reply(&self) -> DBusMessage

Creates a new DBusMessage that is a reply to self.

Returns

DBusMessage. Free with g_object_unref().

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

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

The contents of the description has no ABI guarantees, the contents and formatting is subject to change at any time. 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

A string that should be freed with g_free().

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

Sets the body self. As a side-effect the DBusMessageHeaderField::Signature header field is set to the type string of body (or cleared if body is None).

If body is floating, self assumes ownership of body.

body

Either None or a glib::Variant that is a tuple.

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 DBusMessageHeaderField::Destination header field.

value

The value to set.

pub fn set_error_name(&self, value: &str)

Convenience setter for the DBusMessageHeaderField::ErrorName 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 glib::Variant to set the header field or None to clear the header field.

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

Convenience setter for the DBusMessageHeaderField::Interface header field.

value

The value to set.

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

Convenience setter for the 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 DBusMessageHeaderField::NumUnixFds header field.

value

The value to set.

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

Convenience setter for the DBusMessageHeaderField::Path header field.

value

The value to set.

pub fn set_reply_serial(&self, value: u32)

Convenience setter for the DBusMessageHeaderField::ReplySerial header field.

value

The value to set.

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

Convenience setter for the DBusMessageHeaderField::Sender header field.

value

The value to set.

pub fn set_serial(&self, serial: u32)

Sets the serial for self.

serial

A guint32.

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

Convenience setter for the 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 DBusMessageHeaderField::NumUnixFds header field is set to the number of fds in fd_list (or cleared if fd_list is None).

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 None.

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

A DBusCapabilityFlags describing what protocol features are supported.

Returns

A pointer to a valid binary D-Bus message of out_size bytes generated by self or None if error is set. Free with g_free().

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

If self is not of type DBusMessageType::Error does nothing and returns false.

Otherwise this method encodes the error in self as a glib::Error using g_dbus_error_set_dbus_error() using the information in the DBusMessageHeaderField::ErrorName header field of self as well as the first string item in self’s body.

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.

blob

A blob representing a binary D-Bus message.

Returns

Number of bytes needed or -1 if error is set (e.g. if blob contains invalid data or not enough data is available to determine the size).

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

Trait Implementations

impl Clone for DBusMessage

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 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 Hash for DBusMessage

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

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 ParentClassIs for DBusMessage

type Parent = Object

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

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 DBusMessage

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 DBusMessage

fn static_type() -> Type

Returns the type identifier of Self.

impl Eq for DBusMessage