libsecret/collection.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 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363
// Take a look at the license at the top of the repository in the LICENSE file.
use crate::{hashtable::attribute_names_and_values, Item};
use crate::{Collection, Schema, SearchFlags};
use glib::object::IsA;
use glib::translate::*;
use std::boxed::Box as Box_;
use std::collections::HashMap;
use std::pin::Pin;
use std::ptr;
pub trait CollectionExtManual: 'static {
/// Search for items matching the @attributes in the @collection.
/// The @attributes should be a table of string keys and string values.
///
/// If [`SearchFlags::ALL`][crate::SearchFlags::ALL] is set in @flags, then all the items matching the
/// search will be returned. Otherwise only the first item will be returned.
/// This is almost always the unlocked item that was most recently stored.
///
/// If [`SearchFlags::UNLOCK`][crate::SearchFlags::UNLOCK] is set in @flags, then items will be unlocked
/// if necessary. In either case, locked and unlocked items will match the
/// search and be returned. If the unlock fails, the search does not fail.
///
/// If [`SearchFlags::LOAD_SECRETS`][crate::SearchFlags::LOAD_SECRETS] is set in @flags, then the items will have
/// their secret values loaded and available via [`ItemExt::secret()`][crate::prelude::ItemExt::secret()].
///
/// This function returns immediately and completes asynchronously.
/// ## `schema`
/// the schema for the attributes
/// ## `attributes`
/// search for items matching these attributes
/// ## `flags`
/// search option flags
/// ## `cancellable`
/// optional cancellation object
/// ## `callback`
/// called when the operation completes
#[doc(alias = "secret_collection_search")]
fn search<P: FnOnce(Result<Vec<Item>, glib::Error>) + 'static>(
&self,
schema: Option<&Schema>,
attributes: HashMap<&str, &str>,
flags: SearchFlags,
cancellable: Option<&impl IsA<gio::Cancellable>>,
callback: P,
);
fn search_future(
&self,
schema: Option<&Schema>,
attributes: HashMap<&str, &str>,
flags: SearchFlags,
) -> Pin<Box_<dyn std::future::Future<Output = Result<Vec<Item>, glib::Error>> + 'static>>;
/// Search for items matching the @attributes in the @collection.
/// The @attributes should be a table of string keys and string values.
///
/// If [`SearchFlags::ALL`][crate::SearchFlags::ALL] is set in @flags, then all the items matching the
/// search will be returned. Otherwise only the first item will be returned.
/// This is almost always the unlocked item that was most recently stored.
///
/// If [`SearchFlags::UNLOCK`][crate::SearchFlags::UNLOCK] is set in @flags, then items will be unlocked
/// if necessary. In either case, locked and unlocked items will match the
/// search and be returned. If the unlock fails, the search does not fail.
///
/// If [`SearchFlags::LOAD_SECRETS`][crate::SearchFlags::LOAD_SECRETS] is set in @flags, then the items will have
/// their secret values loaded and available via [`ItemExt::secret()`][crate::prelude::ItemExt::secret()].
///
/// This function may block indefinitely. Use the asynchronous version
/// in user interface threads.
/// ## `schema`
/// the schema for the attributes
/// ## `attributes`
/// search for items matching these attributes
/// ## `flags`
/// search option flags
/// ## `cancellable`
/// optional cancellation object
///
/// # Returns
///
///
/// a list of items that matched the search
#[doc(alias = "secret_collection_search_sync")]
fn search_sync(
&self,
schema: Option<&Schema>,
attributes: HashMap<&str, &str>,
flags: SearchFlags,
cancellable: Option<&impl IsA<gio::Cancellable>>,
) -> Result<Vec<Item>, glib::Error>;
/// Search for items in @self matching the @attributes, and return their
/// DBus object paths.
///
/// Only the specified collection is searched. The @attributes should be a table
/// of string keys and string values.
///
/// This function returns immediately and completes asynchronously.
///
/// When your callback is called use `Collection::search_for_dbus_paths_finish()`
/// to get the results of this function. Only the DBus object paths of the
/// items will be returned. If you would like [`Item`][crate::Item] objects to be returned
/// instead, then use the [`search()`][Self::search()] function.
/// ## `schema`
/// the schema for the attributes
/// ## `attributes`
/// search for items matching these attributes
/// ## `cancellable`
/// optional cancellation object
/// ## `callback`
/// called when the operation completes
#[doc(alias = "secret_collection_search_for_dbus_paths")]
fn search_for_dbus_paths<P: FnOnce(Result<Vec<glib::GString>, glib::Error>) + 'static>(
&self,
schema: Option<&Schema>,
attributes: HashMap<&str, &str>,
cancellable: Option<&impl IsA<gio::Cancellable>>,
callback: P,
);
fn search_for_dbus_paths_future(
&self,
schema: Option<&Schema>,
attributes: HashMap<&str, &str>,
) -> Pin<
Box_<dyn std::future::Future<Output = Result<Vec<glib::GString>, glib::Error>> + 'static>,
>;
/// Search for items matching the @attributes in @self, and return their
/// DBus object paths.
///
/// The @attributes should be a table of string keys and string values.
///
/// This function may block indefinitely. Use the asynchronous version
/// in user interface threads.
///
/// DBus object paths of the items will be returned. If you would to have
/// [`Item`][crate::Item] objects to be returned instead, then use the
/// [`search_sync()`][Self::search_sync()] function.
/// ## `schema`
/// the schema for the attributes
/// ## `attributes`
/// search for items matching these attributes
/// ## `cancellable`
/// optional cancellation object
///
/// # Returns
///
/// an array of DBus object
/// paths for matching items.
#[doc(alias = "secret_collection_search_for_dbus_paths_sync")]
fn search_for_dbus_paths_sync(
&self,
schema: Option<&Schema>,
attributes: HashMap<&str, &str>,
cancellable: Option<&impl IsA<gio::Cancellable>>,
) -> Result<Vec<glib::GString>, glib::Error>;
}
impl<O: IsA<Collection>> CollectionExtManual for O {
fn search<P: FnOnce(Result<Vec<Item>, glib::Error>) + 'static>(
&self,
schema: Option<&Schema>,
attributes: HashMap<&str, &str>,
flags: SearchFlags,
cancellable: Option<&impl IsA<gio::Cancellable>>,
callback: P,
) {
unsafe {
let user_data: Box_<glib::thread_guard::ThreadGuard<P>> =
Box_::new(glib::thread_guard::ThreadGuard::new(callback));
unsafe extern "C" fn search_trampoline<
P: FnOnce(Result<Vec<Item>, glib::Error>) + 'static,
>(
_source_object: *mut glib::gobject_ffi::GObject,
res: *mut gio::ffi::GAsyncResult,
user_data: glib::ffi::gpointer,
) {
let mut error = ptr::null_mut();
let ret =
ffi::secret_collection_search_finish(_source_object as *mut _, res, &mut error);
let result = if error.is_null() {
Ok(FromGlibPtrContainer::from_glib_full(ret))
} else {
Err(from_glib_full(error))
};
let callback: Box_<glib::thread_guard::ThreadGuard<P>> =
Box_::from_raw(user_data as *mut _);
let callback: P = callback.into_inner();
callback(result);
}
let callback = search_trampoline::<P>;
ffi::secret_collection_search(
self.as_ref().to_glib_none().0,
schema.to_glib_none().0,
attribute_names_and_values(attributes),
flags.into_glib(),
cancellable.map(|p| p.as_ref()).to_glib_none().0,
Some(callback),
Box_::into_raw(user_data) as *mut _,
);
}
}
fn search_future(
&self,
schema: Option<&Schema>,
attributes: HashMap<&str, &str>,
flags: SearchFlags,
) -> Pin<Box_<dyn std::future::Future<Output = Result<Vec<Item>, glib::Error>> + 'static>> {
let schema = schema.map(ToOwned::to_owned);
let owned_map = attributes
.into_iter()
.map(|(k, v)| (k.to_string(), v.to_string()))
.collect::<HashMap<String, String>>();
Box_::pin(gio::GioFuture::new(self, move |obj, cancellable, send| {
let attributes = owned_map
.iter()
.map(|(k, v)| (k.as_str(), v.as_str()))
.collect::<HashMap<&str, &str>>();
obj.search(
schema.as_ref().map(::std::borrow::Borrow::borrow),
attributes,
flags,
Some(cancellable),
move |res| {
send.resolve(res);
},
);
}))
}
fn search_sync(
&self,
schema: Option<&Schema>,
attributes: HashMap<&str, &str>,
flags: SearchFlags,
cancellable: Option<&impl IsA<gio::Cancellable>>,
) -> Result<Vec<Item>, glib::Error> {
unsafe {
let mut err = std::ptr::null_mut();
let res = ffi::secret_collection_search_sync(
self.as_ref().to_glib_none().0,
schema.to_glib_none().0,
attribute_names_and_values(attributes),
flags.into_glib(),
cancellable.map(|p| p.as_ref()).to_glib_none().0,
&mut err,
);
if err.is_null() {
Ok(FromGlibPtrContainer::from_glib_full(res))
} else {
Err(from_glib_full(err))
}
}
}
#[doc(alias = "secret_collection_search_for_dbus_paths_sync")]
fn search_for_dbus_paths_sync(
&self,
schema: Option<&Schema>,
attributes: HashMap<&str, &str>,
cancellable: Option<&impl IsA<gio::Cancellable>>,
) -> Result<Vec<glib::GString>, glib::Error> {
unsafe {
let mut err = std::ptr::null_mut();
let res = ffi::secret_collection_search_for_dbus_paths_sync(
self.as_ref().to_glib_none().0,
schema.to_glib_none().0,
attribute_names_and_values(attributes),
cancellable.map(|p| p.as_ref()).to_glib_none().0,
&mut err,
);
if err.is_null() {
Ok(FromGlibPtrContainer::from_glib_full(res))
} else {
Err(from_glib_full(err))
}
}
}
#[doc(alias = "secret_collection_search_for_dbus_paths")]
fn search_for_dbus_paths<P: FnOnce(Result<Vec<glib::GString>, glib::Error>) + 'static>(
&self,
schema: Option<&Schema>,
attributes: HashMap<&str, &str>,
cancellable: Option<&impl IsA<gio::Cancellable>>,
callback: P,
) {
unsafe {
let user_data: Box_<glib::thread_guard::ThreadGuard<P>> =
Box_::new(glib::thread_guard::ThreadGuard::new(callback));
unsafe extern "C" fn search_trampoline<
P: FnOnce(Result<Vec<glib::GString>, glib::Error>) + 'static,
>(
_source_object: *mut glib::gobject_ffi::GObject,
res: *mut gio::ffi::GAsyncResult,
user_data: glib::ffi::gpointer,
) {
let mut error = ptr::null_mut();
let ret = ffi::secret_collection_search_for_dbus_paths_finish(
_source_object as *mut _,
res,
&mut error,
);
let result = if error.is_null() {
Ok(FromGlibPtrContainer::from_glib_full(ret))
} else {
Err(from_glib_full(error))
};
let callback: Box_<glib::thread_guard::ThreadGuard<P>> =
Box_::from_raw(user_data as *mut _);
let callback: P = callback.into_inner();
callback(result);
}
let callback = search_trampoline::<P>;
ffi::secret_collection_search_for_dbus_paths(
self.as_ref().to_glib_none().0,
schema.to_glib_none().0,
attribute_names_and_values(attributes),
cancellable.map(|p| p.as_ref()).to_glib_none().0,
Some(callback),
Box_::into_raw(user_data) as *mut _,
);
}
}
fn search_for_dbus_paths_future(
&self,
schema: Option<&Schema>,
attributes: HashMap<&str, &str>,
) -> Pin<
Box_<dyn std::future::Future<Output = Result<Vec<glib::GString>, glib::Error>> + 'static>,
> {
let schema = schema.map(ToOwned::to_owned);
let owned_map = attributes
.into_iter()
.map(|(k, v)| (k.to_string(), v.to_string()))
.collect::<HashMap<String, String>>();
Box_::pin(gio::GioFuture::new(self, move |obj, cancellable, send| {
let attributes = owned_map
.iter()
.map(|(k, v)| (k.as_str(), v.as_str()))
.collect::<HashMap<&str, &str>>();
obj.search_for_dbus_paths(
schema.as_ref().map(::std::borrow::Borrow::borrow),
attributes,
Some(cancellable),
move |res| {
send.resolve(res);
},
);
}))
}
}