[−]Struct gio::DBusMessage
A type for representing D-Bus messages that can be sent or received
on a DBusConnection.
Implements
Implementations
impl DBusMessage[src]
pub fn new() -> DBusMessage[src]
pub fn from_blob(
blob: &[u8],
capabilities: DBusCapabilityFlags
) -> Result<DBusMessage, Error>[src]
blob: &[u8],
capabilities: DBusCapabilityFlags
) -> Result<DBusMessage, Error>
pub fn new_method_call(
name: Option<&str>,
path: &str,
interface_: Option<&str>,
method: &str
) -> DBusMessage[src]
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 gobject::ObjectExt::unref.
pub fn new_signal(path: &str, interface_: &str, signal: &str) -> DBusMessage[src]
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 gobject::ObjectExt::unref.
pub fn copy(&self) -> Result<DBusMessage, Error>[src]
Copies self. The copy is a deep copy and the returned
DBusMessage is completely identical except that it is guaranteed
to not be locked.
This operation can fail if e.g. self contains file descriptors
and the per-process or system-wide open files limit is reached.
Returns
A new DBusMessage or None if error is set.
Free with gobject::ObjectExt::unref.
pub fn get_arg0(&self) -> Option<GString>[src]
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 get_body(&self) -> Option<Variant>[src]
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 get_byte_order(&self) -> DBusMessageByteOrder[src]
pub fn get_destination(&self) -> Option<GString>[src]
pub fn get_error_name(&self) -> Option<GString>[src]
pub fn get_flags(&self) -> DBusMessageFlags[src]
Gets the flags for self.
Returns
Flags that are set (typically values from the DBusMessageFlags enumeration bitwise ORed together).
pub fn get_header(
&self,
header_field: DBusMessageHeaderField
) -> Option<Variant>[src]
&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 get_interface(&self) -> Option<GString>[src]
pub fn get_locked(&self) -> bool[src]
Checks whether self is locked. To monitor changes to this
value, conncet to the gobject::Object::notify signal to listen for changes
on the DBusMessage:locked property.
Returns
true if self is locked, false otherwise.
pub fn get_member(&self) -> Option<GString>[src]
pub fn get_message_type(&self) -> DBusMessageType[src]
Gets the type of self.
Returns
A 8-bit unsigned integer (typically a value from the DBusMessageType enumeration).
pub fn get_num_unix_fds(&self) -> u32[src]
pub fn get_path(&self) -> Option<GString>[src]
pub fn get_reply_serial(&self) -> u32[src]
pub fn get_sender(&self) -> Option<GString>[src]
pub fn get_serial(&self) -> u32[src]
pub fn get_signature(&self) -> Option<GString>[src]
pub fn get_unix_fd_list(&self) -> Option<UnixFDList>[src]
Gets the UNIX file descriptors associated with self, if any.
This method is only available on UNIX.
Returns
A UnixFDList or None if no file descriptors are
associated. Do not free, this object is owned by self.
pub fn lock(&self)[src]
If self is locked, does nothing. Otherwise locks the message.
pub fn new_method_error_literal(
&self,
error_name: &str,
error_message: &str
) -> Option<DBusMessage>[src]
&self,
error_name: &str,
error_message: &str
) -> Option<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 gobject::ObjectExt::unref.
pub fn new_method_reply(&self) -> Option<DBusMessage>[src]
Creates a new DBusMessage that is a reply to self.
Returns
DBusMessage. Free with gobject::ObjectExt::unref.
pub fn print(&self, indent: u32) -> Option<GString>[src]
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)[src]
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)[src]
pub fn set_destination(&self, value: &str)[src]
Convenience setter for the DBusMessageHeaderField::Destination header field.
value
The value to set.
pub fn set_error_name(&self, value: &str)[src]
pub fn set_flags(&self, flags: DBusMessageFlags)[src]
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>
)[src]
&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: &str)[src]
pub fn set_member(&self, value: &str)[src]
pub fn set_message_type(&self, type_: DBusMessageType)[src]
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)[src]
pub fn set_path(&self, value: &str)[src]
pub fn set_reply_serial(&self, value: u32)[src]
Convenience setter for the DBusMessageHeaderField::ReplySerial header field.
value
The value to set.
pub fn set_sender(&self, value: &str)[src]
pub fn set_serial(&self, serial: u32)[src]
pub fn set_signature(&self, value: &str)[src]
pub fn set_unix_fd_list<P: IsA<UnixFDList>>(&self, fd_list: Option<&P>)[src]
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.
fd_list
A UnixFDList or None.
pub fn to_blob(
&self,
capabilities: DBusCapabilityFlags
) -> Result<Vec<u8>, Error>[src]
&self,
capabilities: DBusCapabilityFlags
) -> Result<Vec<u8>, Error>
Serializes self to a blob. The byte order returned by
DBusMessage::get_byte_order will be used.
out_size
Return location for size of generated blob.
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>[src]
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 DBusError::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>[src]
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.
blob_len
The length of blob (must be at least 16).
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_property_locked_notify<F: Fn(&DBusMessage) + 'static>(
&self,
f: F
) -> SignalHandlerId[src]
&self,
f: F
) -> SignalHandlerId
Trait Implementations
impl Clone for DBusMessage
fn clone(&self) -> DBusMessage
fn clone_from(&mut self, source: &Self)1.0.0[src]
impl Debug for DBusMessage
impl Default for DBusMessage[src]
impl Display for DBusMessage[src]
impl Eq for DBusMessage
impl Hash for DBusMessage
fn hash<__H: Hasher>(&self, state: &mut __H)
fn hash_slice<H>(data: &[Self], state: &mut H) where
H: Hasher, 1.3.0[src]
H: Hasher,
impl Ord for DBusMessage
fn cmp(&self, other: &DBusMessage) -> Ordering
#[must_use]fn max(self, other: Self) -> Self1.21.0[src]
#[must_use]fn min(self, other: Self) -> Self1.21.0[src]
#[must_use]fn clamp(self, min: Self, max: Self) -> Self[src]
impl<T: ObjectType> PartialEq<T> for DBusMessage
impl<T: ObjectType> PartialOrd<T> for DBusMessage
fn partial_cmp(&self, other: &T) -> Option<Ordering>
#[must_use]fn lt(&self, other: &Rhs) -> bool1.0.0[src]
#[must_use]fn le(&self, other: &Rhs) -> bool1.0.0[src]
#[must_use]fn gt(&self, other: &Rhs) -> bool1.0.0[src]
#[must_use]fn ge(&self, other: &Rhs) -> bool1.0.0[src]
impl StaticType for DBusMessage
fn static_type() -> Type
Auto Trait Implementations
impl RefUnwindSafe for DBusMessage
impl !Send for DBusMessage
impl !Sync for DBusMessage
impl Unpin for DBusMessage
impl UnwindSafe for DBusMessage
Blanket Implementations
impl<T> Any for T where
T: 'static + ?Sized, [src]
T: 'static + ?Sized,
impl<T> Borrow<T> for T where
T: ?Sized, [src]
T: ?Sized,
impl<T> BorrowMut<T> for T where
T: ?Sized, [src]
T: ?Sized,
fn borrow_mut(&mut self) -> &mut T[src]
impl<Super, Sub> CanDowncast<Sub> for Super where
Sub: IsA<Super>,
Super: IsA<Super>,
Sub: IsA<Super>,
Super: IsA<Super>,
impl<T> Cast for T where
T: ObjectType,
T: ObjectType,
fn upcast<T>(self) -> T where
Self: IsA<T>,
T: ObjectType,
Self: IsA<T>,
T: ObjectType,
fn upcast_ref<T>(&self) -> &T where
Self: IsA<T>,
T: ObjectType,
Self: IsA<T>,
T: ObjectType,
fn downcast<T>(self) -> Result<T, Self> where
Self: CanDowncast<T>,
T: ObjectType,
Self: CanDowncast<T>,
T: ObjectType,
fn downcast_ref<T>(&self) -> Option<&T> where
Self: CanDowncast<T>,
T: ObjectType,
Self: CanDowncast<T>,
T: ObjectType,
fn dynamic_cast<T>(self) -> Result<T, Self> where
T: ObjectType,
T: ObjectType,
fn dynamic_cast_ref<T>(&self) -> Option<&T> where
T: ObjectType,
T: ObjectType,
unsafe fn unsafe_cast<T>(self) -> T where
T: ObjectType,
T: ObjectType,
unsafe fn unsafe_cast_ref<T>(&self) -> &T where
T: ObjectType,
T: ObjectType,
impl<T> From<T> for T[src]
impl<T, U> Into<U> for T where
U: From<T>, [src]
U: From<T>,
impl<T> ObjectExt for T where
T: ObjectType,
T: ObjectType,
fn is<U>(&self) -> bool where
U: StaticType,
U: StaticType,
fn get_type(&self) -> Type
fn get_object_class(&self) -> &ObjectClass
fn set_properties(
&self,
property_values: &[(&str, &dyn ToValue)]
) -> Result<(), BoolError>
&self,
property_values: &[(&str, &dyn ToValue)]
) -> Result<(), BoolError>
fn set_property<'a, N>(
&self,
property_name: N,
value: &dyn ToValue
) -> Result<(), BoolError> where
N: Into<&'a str>,
&self,
property_name: N,
value: &dyn ToValue
) -> Result<(), BoolError> where
N: Into<&'a str>,
fn get_property<'a, N>(&self, property_name: N) -> Result<Value, BoolError> where
N: Into<&'a str>,
N: Into<&'a str>,
unsafe fn set_qdata<QD>(&self, key: Quark, value: QD) where
QD: 'static,
QD: 'static,
unsafe fn get_qdata<QD>(&self, key: Quark) -> Option<&QD> where
QD: 'static,
QD: 'static,
unsafe fn steal_qdata<QD>(&self, key: Quark) -> Option<QD> where
QD: 'static,
QD: 'static,
unsafe fn set_data<QD>(&self, key: &str, value: QD) where
QD: 'static,
QD: 'static,
unsafe fn get_data<QD>(&self, key: &str) -> Option<&QD> where
QD: 'static,
QD: 'static,
unsafe fn steal_data<QD>(&self, key: &str) -> Option<QD> where
QD: 'static,
QD: 'static,
fn block_signal(&self, handler_id: &SignalHandlerId)
fn unblock_signal(&self, handler_id: &SignalHandlerId)
fn stop_signal_emission(&self, signal_name: &str)
fn disconnect(&self, handler_id: SignalHandlerId)
fn connect_notify<F>(&self, name: Option<&str>, f: F) -> SignalHandlerId where
F: 'static + Send + Sync + Fn(&T, &ParamSpec),
F: 'static + Send + Sync + Fn(&T, &ParamSpec),
unsafe fn connect_notify_unsafe<F>(
&self,
name: Option<&str>,
f: F
) -> SignalHandlerId where
F: Fn(&T, &ParamSpec),
&self,
name: Option<&str>,
f: F
) -> SignalHandlerId where
F: Fn(&T, &ParamSpec),
fn notify<'a, N>(&self, property_name: N) where
N: Into<&'a str>,
N: Into<&'a str>,
fn notify_by_pspec(&self, pspec: &ParamSpec)
fn has_property<'a, N>(&self, property_name: N, type_: Option<Type>) -> bool where
N: Into<&'a str>,
N: Into<&'a str>,
fn get_property_type<'a, N>(&self, property_name: N) -> Option<Type> where
N: Into<&'a str>,
N: Into<&'a str>,
fn find_property<'a, N>(&self, property_name: N) -> Option<ParamSpec> where
N: Into<&'a str>,
N: Into<&'a str>,
fn list_properties(&self) -> Vec<ParamSpec>
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>,
&self,
signal_name: N,
after: bool,
callback: F
) -> Result<SignalHandlerId, BoolError> where
F: Fn(&[Value]) -> Option<Value> + Send + Sync + 'static,
N: Into<&'a str>,
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>,
&self,
signal_name: N,
after: bool,
callback: F
) -> Result<SignalHandlerId, BoolError> where
F: Fn(&[Value]) -> Option<Value> + 'static,
N: Into<&'a str>,
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>,
&self,
signal_name: N,
after: bool,
callback: F
) -> Result<SignalHandlerId, BoolError> where
F: Fn(&[Value]) -> Option<Value>,
N: Into<&'a str>,
fn emit<'a, N>(
&self,
signal_name: N,
args: &[&dyn ToValue]
) -> Result<Option<Value>, BoolError> where
N: Into<&'a str>,
&self,
signal_name: N,
args: &[&dyn ToValue]
) -> Result<Option<Value>, BoolError> where
N: Into<&'a str>,
fn downgrade(&self) -> WeakRef<T>
fn bind_property<'a, O, N, M>(
&'a self,
source_property: N,
target: &'a O,
target_property: M
) -> BindingBuilder<'a> where
M: Into<&'a str>,
N: Into<&'a str>,
O: ObjectType,
&'a self,
source_property: N,
target: &'a O,
target_property: M
) -> BindingBuilder<'a> where
M: Into<&'a str>,
N: Into<&'a str>,
O: ObjectType,
fn ref_count(&self) -> u32
impl<'a, T> ToGlibContainerFromSlice<'a, *const GList> for T where
T: GlibPtrDefault + ToGlibPtr<'a, <T as GlibPtrDefault>::GlibType>,
T: GlibPtrDefault + ToGlibPtr<'a, <T as GlibPtrDefault>::GlibType>,
type Storage = (Option<List>, Vec<Stash<'a, <T as GlibPtrDefault>::GlibType, T>>)
fn to_glib_none_from_slice(
t: &'a [T]
) -> (*const GList, <T as ToGlibContainerFromSlice<'a, *const GList>>::Storage)
t: &'a [T]
) -> (*const GList, <T as ToGlibContainerFromSlice<'a, *const GList>>::Storage)
fn to_glib_container_from_slice(
_t: &'a [T]
) -> (*const GList, <T as ToGlibContainerFromSlice<'a, *const GList>>::Storage)
_t: &'a [T]
) -> (*const GList, <T as ToGlibContainerFromSlice<'a, *const GList>>::Storage)
fn to_glib_full_from_slice(_t: &[T]) -> *const GList
impl<'a, T> ToGlibContainerFromSlice<'a, *const GPtrArray> for T where
T: GlibPtrDefault + ToGlibPtr<'a, <T as GlibPtrDefault>::GlibType>,
T: GlibPtrDefault + ToGlibPtr<'a, <T as GlibPtrDefault>::GlibType>,
type Storage = (Option<PtrArray>, Vec<Stash<'a, <T as GlibPtrDefault>::GlibType, T>>)
fn to_glib_none_from_slice(
t: &'a [T]
) -> (*const GPtrArray, <T as ToGlibContainerFromSlice<'a, *const GPtrArray>>::Storage)
t: &'a [T]
) -> (*const GPtrArray, <T as ToGlibContainerFromSlice<'a, *const GPtrArray>>::Storage)
fn to_glib_container_from_slice(
_t: &'a [T]
) -> (*const GPtrArray, <T as ToGlibContainerFromSlice<'a, *const GPtrArray>>::Storage)
_t: &'a [T]
) -> (*const GPtrArray, <T as ToGlibContainerFromSlice<'a, *const GPtrArray>>::Storage)
fn to_glib_full_from_slice(_t: &[T]) -> *const GPtrArray
impl<'a, T> ToGlibContainerFromSlice<'a, *mut GArray> for T where
T: GlibPtrDefault + ToGlibPtr<'a, <T as GlibPtrDefault>::GlibType>,
T: GlibPtrDefault + ToGlibPtr<'a, <T as GlibPtrDefault>::GlibType>,
type Storage = (Option<Array>, Vec<Stash<'a, <T as GlibPtrDefault>::GlibType, T>>)
fn to_glib_none_from_slice(
t: &'a [T]
) -> (*mut GArray, <T as ToGlibContainerFromSlice<'a, *mut GArray>>::Storage)
t: &'a [T]
) -> (*mut GArray, <T as ToGlibContainerFromSlice<'a, *mut GArray>>::Storage)
fn to_glib_container_from_slice(
t: &'a [T]
) -> (*mut GArray, <T as ToGlibContainerFromSlice<'a, *mut GArray>>::Storage)
t: &'a [T]
) -> (*mut GArray, <T as ToGlibContainerFromSlice<'a, *mut GArray>>::Storage)
fn to_glib_full_from_slice(t: &[T]) -> *mut GArray
impl<'a, T> ToGlibContainerFromSlice<'a, *mut GList> for T where
T: GlibPtrDefault + ToGlibPtr<'a, <T as GlibPtrDefault>::GlibType>,
T: GlibPtrDefault + ToGlibPtr<'a, <T as GlibPtrDefault>::GlibType>,
type Storage = (Option<List>, Vec<Stash<'a, <T as GlibPtrDefault>::GlibType, T>>)
fn to_glib_none_from_slice(
t: &'a [T]
) -> (*mut GList, <T as ToGlibContainerFromSlice<'a, *mut GList>>::Storage)
t: &'a [T]
) -> (*mut GList, <T as ToGlibContainerFromSlice<'a, *mut GList>>::Storage)
fn to_glib_container_from_slice(
t: &'a [T]
) -> (*mut GList, <T as ToGlibContainerFromSlice<'a, *mut GList>>::Storage)
t: &'a [T]
) -> (*mut GList, <T as ToGlibContainerFromSlice<'a, *mut GList>>::Storage)
fn to_glib_full_from_slice(t: &[T]) -> *mut GList
impl<'a, T> ToGlibContainerFromSlice<'a, *mut GPtrArray> for T where
T: GlibPtrDefault + ToGlibPtr<'a, <T as GlibPtrDefault>::GlibType>,
T: GlibPtrDefault + ToGlibPtr<'a, <T as GlibPtrDefault>::GlibType>,
type Storage = (Option<PtrArray>, Vec<Stash<'a, <T as GlibPtrDefault>::GlibType, T>>)
fn to_glib_none_from_slice(
t: &'a [T]
) -> (*mut GPtrArray, <T as ToGlibContainerFromSlice<'a, *mut GPtrArray>>::Storage)
t: &'a [T]
) -> (*mut GPtrArray, <T as ToGlibContainerFromSlice<'a, *mut GPtrArray>>::Storage)
fn to_glib_container_from_slice(
t: &'a [T]
) -> (*mut GPtrArray, <T as ToGlibContainerFromSlice<'a, *mut GPtrArray>>::Storage)
t: &'a [T]
) -> (*mut GPtrArray, <T as ToGlibContainerFromSlice<'a, *mut GPtrArray>>::Storage)
fn to_glib_full_from_slice(t: &[T]) -> *mut GPtrArray
impl<T> ToOwned for T where
T: Clone, [src]
T: Clone,
type Owned = T
The resulting type after obtaining ownership.
fn to_owned(&self) -> T[src]
fn clone_into(&self, target: &mut T)[src]
impl<T> ToSendValue for T where
T: ToValue + SetValue + Send + ?Sized,
T: ToValue + SetValue + Send + ?Sized,
fn to_send_value(&self) -> SendValue
impl<T> ToString for T where
T: Display + ?Sized, [src]
T: Display + ?Sized,
impl<T> ToValue for T where
T: SetValue + ?Sized,
T: SetValue + ?Sized,
fn to_value(&self) -> Value
fn to_value_type(&self) -> Type
impl<T, U> TryFrom<U> for T where
U: Into<T>, [src]
U: Into<T>,
type Error = Infallible
The type returned in the event of a conversion error.
fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>[src]
impl<T, U> TryInto<U> for T where
U: TryFrom<T>, [src]
U: TryFrom<T>,