gio/auto/dbus_method_invocation.rs
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310
// This file was generated by gir (https://github.com/gtk-rs/gir)
// from gir-files (https://github.com/gtk-rs/gir-files)
// DO NOT EDIT
#[cfg(unix)]
#[cfg_attr(docsrs, doc(cfg(unix)))]
use crate::UnixFDList;
use crate::{ffi, DBusConnection, DBusMessage, DBusMethodInfo, DBusPropertyInfo};
#[cfg(unix)]
#[cfg_attr(docsrs, doc(cfg(unix)))]
use glib::prelude::*;
use glib::translate::*;
glib::wrapper! {
/// Instances of the `GDBusMethodInvocation` class are used when
/// handling D-Bus method calls. It provides a way to asynchronously
/// return results and errors.
///
/// The normal way to obtain a `GDBusMethodInvocation` object is to receive
/// it as an argument to the `handle_method_call()` function in a
/// [type@Gio.DBusInterfaceVTable] that was passed to
/// [`DBusConnection::register_object()`][crate::DBusConnection::register_object()].
///
/// # Implements
///
/// [`trait@glib::ObjectExt`]
#[doc(alias = "GDBusMethodInvocation")]
pub struct DBusMethodInvocation(Object<ffi::GDBusMethodInvocation>);
match fn {
type_ => || ffi::g_dbus_method_invocation_get_type(),
}
}
impl DBusMethodInvocation {
/// Gets the #GDBusConnection the method was invoked on.
///
/// # Returns
///
/// A #GDBusConnection. Do not free, it is owned by @self.
#[doc(alias = "g_dbus_method_invocation_get_connection")]
#[doc(alias = "get_connection")]
pub fn connection(&self) -> DBusConnection {
unsafe {
from_glib_none(ffi::g_dbus_method_invocation_get_connection(
self.to_glib_none().0,
))
}
}
/// Gets the name of the D-Bus interface the method was invoked on.
///
/// If this method call is a property Get, Set or GetAll call that has
/// been redirected to the method call handler then
/// "org.freedesktop.DBus.Properties" will be returned. See
/// #GDBusInterfaceVTable for more information.
///
/// # Returns
///
/// A string. Do not free, it is owned by @self.
#[doc(alias = "g_dbus_method_invocation_get_interface_name")]
#[doc(alias = "get_interface_name")]
pub fn interface_name(&self) -> glib::GString {
unsafe {
from_glib_none(ffi::g_dbus_method_invocation_get_interface_name(
self.to_glib_none().0,
))
}
}
/// Gets the #GDBusMessage for the method invocation. This is useful if
/// you need to use low-level protocol features, such as UNIX file
/// descriptor passing, that cannot be properly expressed in the
/// #GVariant API.
///
/// See this [server][gdbus-server] and [client][gdbus-unix-fd-client]
/// for an example of how to use this low-level API to send and receive
/// UNIX file descriptors.
///
/// # Returns
///
/// #GDBusMessage. Do not free, it is owned by @self.
#[doc(alias = "g_dbus_method_invocation_get_message")]
#[doc(alias = "get_message")]
pub fn message(&self) -> DBusMessage {
unsafe {
from_glib_none(ffi::g_dbus_method_invocation_get_message(
self.to_glib_none().0,
))
}
}
/// Gets information about the method call, if any.
///
/// If this method invocation is a property Get, Set or GetAll call that
/// has been redirected to the method call handler then [`None`] will be
/// returned. See g_dbus_method_invocation_get_property_info() and
/// #GDBusInterfaceVTable for more information.
///
/// # Returns
///
/// A #GDBusMethodInfo or [`None`]. Do not free, it is owned by @self.
#[doc(alias = "g_dbus_method_invocation_get_method_info")]
#[doc(alias = "get_method_info")]
pub fn method_info(&self) -> Option<DBusMethodInfo> {
unsafe {
from_glib_none(ffi::g_dbus_method_invocation_get_method_info(
self.to_glib_none().0,
))
}
}
/// Gets the name of the method that was invoked.
///
/// # Returns
///
/// A string. Do not free, it is owned by @self.
#[doc(alias = "g_dbus_method_invocation_get_method_name")]
#[doc(alias = "get_method_name")]
pub fn method_name(&self) -> glib::GString {
unsafe {
from_glib_none(ffi::g_dbus_method_invocation_get_method_name(
self.to_glib_none().0,
))
}
}
/// Gets the object path the method was invoked on.
///
/// # Returns
///
/// A string. Do not free, it is owned by @self.
#[doc(alias = "g_dbus_method_invocation_get_object_path")]
#[doc(alias = "get_object_path")]
pub fn object_path(&self) -> glib::GString {
unsafe {
from_glib_none(ffi::g_dbus_method_invocation_get_object_path(
self.to_glib_none().0,
))
}
}
/// Gets the parameters of the method invocation. If there are no input
/// parameters then this will return a GVariant with 0 children rather than NULL.
///
/// # Returns
///
/// A #GVariant tuple. Do not unref this because it is owned by @self.
#[doc(alias = "g_dbus_method_invocation_get_parameters")]
#[doc(alias = "get_parameters")]
pub fn parameters(&self) -> glib::Variant {
unsafe {
from_glib_none(ffi::g_dbus_method_invocation_get_parameters(
self.to_glib_none().0,
))
}
}
/// Gets information about the property that this method call is for, if
/// any.
///
/// This will only be set in the case of an invocation in response to a
/// property Get or Set call that has been directed to the method call
/// handler for an object on account of its property_get() or
/// property_set() vtable pointers being unset.
///
/// See #GDBusInterfaceVTable for more information.
///
/// If the call was GetAll, [`None`] will be returned.
///
/// # Returns
///
/// a #GDBusPropertyInfo or [`None`]
#[doc(alias = "g_dbus_method_invocation_get_property_info")]
#[doc(alias = "get_property_info")]
pub fn property_info(&self) -> Option<DBusPropertyInfo> {
unsafe {
from_glib_none(ffi::g_dbus_method_invocation_get_property_info(
self.to_glib_none().0,
))
}
}
/// Gets the bus name that invoked the method.
///
/// # Returns
///
/// A string. Do not free, it is owned by @self.
#[doc(alias = "g_dbus_method_invocation_get_sender")]
#[doc(alias = "get_sender")]
pub fn sender(&self) -> glib::GString {
unsafe {
from_glib_none(ffi::g_dbus_method_invocation_get_sender(
self.to_glib_none().0,
))
}
}
//#[doc(alias = "g_dbus_method_invocation_get_user_data")]
//#[doc(alias = "get_user_data")]
//pub fn user_data(&self) -> /*Unimplemented*/Option<Basic: Pointer> {
// unsafe { TODO: call ffi:g_dbus_method_invocation_get_user_data() }
//}
/// Finishes handling a D-Bus method call by returning an error.
///
/// This method will take ownership of @self. See
/// #GDBusInterfaceVTable for more information about the ownership of
/// @self.
/// ## `error_name`
/// A valid D-Bus error name.
/// ## `error_message`
/// A valid D-Bus error message.
#[doc(alias = "g_dbus_method_invocation_return_dbus_error")]
pub fn return_dbus_error(self, error_name: &str, error_message: &str) {
unsafe {
ffi::g_dbus_method_invocation_return_dbus_error(
self.into_glib_ptr(),
error_name.to_glib_none().0,
error_message.to_glib_none().0,
);
}
}
//#[doc(alias = "g_dbus_method_invocation_return_error")]
//pub fn return_error(self, domain: glib::Quark, code: i32, format: &str, : /*Unknown conversion*//*Unimplemented*/Basic: VarArgs) {
// unsafe { TODO: call ffi:g_dbus_method_invocation_return_error() }
//}
//#[doc(alias = "g_dbus_method_invocation_return_error_valist")]
//pub fn return_error_valist(self, domain: glib::Quark, code: i32, format: &str, var_args: /*Unknown conversion*//*Unimplemented*/Unsupported) {
// unsafe { TODO: call ffi:g_dbus_method_invocation_return_error_valist() }
//}
/// Finishes handling a D-Bus method call by returning @parameters.
/// If the @parameters GVariant is floating, it is consumed.
///
/// It is an error if @parameters is not of the right format: it must be a tuple
/// containing the out-parameters of the D-Bus method. Even if the method has a
/// single out-parameter, it must be contained in a tuple. If the method has no
/// out-parameters, @parameters may be [`None`] or an empty tuple.
///
///
///
/// **⚠️ The following code is in C ⚠️**
///
/// ```C
/// GDBusMethodInvocation *invocation = some_invocation;
/// g_autofree gchar *result_string = NULL;
/// g_autoptr (GError) error = NULL;
///
/// result_string = calculate_result (&error);
///
/// if (error != NULL)
/// g_dbus_method_invocation_return_gerror (invocation, error);
/// else
/// g_dbus_method_invocation_return_value (invocation,
/// g_variant_new ("(s)", result_string));
///
/// // Do not free @self here; returning a value does that
/// ```
///
/// This method will take ownership of @self. See
/// #GDBusInterfaceVTable for more information about the ownership of
/// @self.
///
/// Since 2.48, if the method call requested for a reply not to be sent
/// then this call will sink @parameters and free @self, but
/// otherwise do nothing (as per the recommendations of the D-Bus
/// specification).
/// ## `parameters`
/// A #GVariant tuple with out parameters for the method or [`None`] if not passing any parameters.
#[doc(alias = "g_dbus_method_invocation_return_value")]
pub fn return_value(self, parameters: Option<&glib::Variant>) {
unsafe {
ffi::g_dbus_method_invocation_return_value(
self.into_glib_ptr(),
parameters.to_glib_none().0,
);
}
}
/// Like g_dbus_method_invocation_return_value() but also takes a #GUnixFDList.
///
/// This method is only available on UNIX.
///
/// This method will take ownership of @self. See
/// #GDBusInterfaceVTable for more information about the ownership of
/// @self.
/// ## `parameters`
/// A #GVariant tuple with out parameters for the method or [`None`] if not passing any parameters.
/// ## `fd_list`
/// A #GUnixFDList or [`None`].
#[cfg(unix)]
#[cfg_attr(docsrs, doc(cfg(unix)))]
#[doc(alias = "g_dbus_method_invocation_return_value_with_unix_fd_list")]
pub fn return_value_with_unix_fd_list(
self,
parameters: Option<&glib::Variant>,
fd_list: Option<&impl IsA<UnixFDList>>,
) {
unsafe {
ffi::g_dbus_method_invocation_return_value_with_unix_fd_list(
self.into_glib_ptr(),
parameters.to_glib_none().0,
fd_list.map(|p| p.as_ref()).to_glib_none().0,
);
}
}
}