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 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411
// This file was generated by gir (https://github.com/gtk-rs/gir)
// from gir-files (https://github.com/gtk-rs/gir-files)
// from webkit-gir-files
// DO NOT EDIT
use crate::{ffi, FaviconDatabase, ITPThirdParty, WebsiteData, WebsiteDataTypes};
use glib::{prelude::*, translate::*};
use std::{boxed::Box as Box_, pin::Pin};
glib::wrapper! {
/// Manages data stored locally by web sites.
///
/// You can use WebKitWebsiteDataManager to configure the local directories
/// where website data will be stored. Use #WebKitWebsiteDataManager:base-data-directory
/// and #WebKitWebsiteDataManager:base-cache-directory set a common base directory for all
/// website data and caches.
///
/// A WebKitWebsiteDataManager can be ephemeral, in which case all the directory configuration
/// is not needed because website data will never persist. You can create an ephemeral WebKitWebsiteDataManager
/// with webkit_website_data_manager_new_ephemeral().
///
/// WebKitWebsiteDataManager can also be used to fetch website data, remove data
/// stored by particular websites, or clear data for all websites modified since a given
/// period of time.
///
/// ## Properties
///
///
/// #### `base-cache-directory`
/// The base directory for caches. If [`None`], a default location will be used.
///
/// Readable | Writeable | Construct Only
///
///
/// #### `base-data-directory`
/// The base directory for website data. If [`None`], a default location will be used.
///
/// Readable | Writeable | Construct Only
///
///
/// #### `is-ephemeral`
/// Whether the #WebKitWebsiteDataManager is ephemeral. An ephemeral #WebKitWebsiteDataManager
/// handles all websites data as non-persistent, and nothing will be written to the client
/// storage. Note that if you create an ephemeral #WebKitWebsiteDataManager all other construction
/// parameters to configure data directories will be ignored.
///
/// Readable | Writeable | Construct Only
///
///
/// #### `origin-storage-ratio`
/// The percentage of volume space that can be used for data storage for every domain.
/// If the maximum storage is reached the storage request will fail with a QuotaExceededError exception.
/// A value of 0.0 means that data storage is not allowed. A value of -1.0, which is the default,
/// means WebKit will use the default quota (1 GiB).
///
/// Writeable | Construct Only
///
///
/// #### `total-storage-ratio`
/// The percentage of volume space that can be used for data storage for all domains.
/// If the maximum storage is reached the eviction will happen.
/// A value of 0.0 means that data storage is not allowed. A value of -1.0, which is the default,
/// means there's no limit for the total storage.
///
/// Writeable | Construct Only
#[doc(alias = "WebKitWebsiteDataManager")]
pub struct WebsiteDataManager(Object<ffi::WebKitWebsiteDataManager, ffi::WebKitWebsiteDataManagerClass>);
match fn {
type_ => || ffi::webkit_website_data_manager_get_type(),
}
}
impl WebsiteDataManager {
// rustdoc-stripper-ignore-next
/// Creates a new builder-pattern struct instance to construct [`WebsiteDataManager`] objects.
///
/// This method returns an instance of [`WebsiteDataManagerBuilder`](crate::builders::WebsiteDataManagerBuilder) which can be used to create [`WebsiteDataManager`] objects.
pub fn builder() -> WebsiteDataManagerBuilder {
WebsiteDataManagerBuilder::new()
}
/// Asynchronously get the list of #WebKitWebsiteData for the given @types.
///
/// When the operation is finished, @callback will be called. You can then call
/// webkit_website_data_manager_fetch_finish() to get the result of the operation.
/// ## `types`
/// #WebKitWebsiteDataTypes
/// ## `cancellable`
/// a #GCancellable or [`None`] to ignore
/// ## `callback`
/// a #GAsyncReadyCallback to call when the request is satisfied
#[doc(alias = "webkit_website_data_manager_fetch")]
pub fn fetch<P: FnOnce(Result<Vec<WebsiteData>, glib::Error>) + 'static>(
&self,
types: WebsiteDataTypes,
cancellable: Option<&impl IsA<gio::Cancellable>>,
callback: P,
) {
let main_context = glib::MainContext::ref_thread_default();
let is_main_context_owner = main_context.is_owner();
let has_acquired_main_context = (!is_main_context_owner)
.then(|| main_context.acquire().ok())
.flatten();
assert!(
is_main_context_owner || has_acquired_main_context.is_some(),
"Async operations only allowed if the thread is owning the MainContext"
);
let user_data: Box_<glib::thread_guard::ThreadGuard<P>> =
Box_::new(glib::thread_guard::ThreadGuard::new(callback));
unsafe extern "C" fn fetch_trampoline<
P: FnOnce(Result<Vec<WebsiteData>, glib::Error>) + 'static,
>(
_source_object: *mut glib::gobject_ffi::GObject,
res: *mut gio::ffi::GAsyncResult,
user_data: glib::ffi::gpointer,
) {
let mut error = std::ptr::null_mut();
let ret = ffi::webkit_website_data_manager_fetch_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 = fetch_trampoline::<P>;
unsafe {
ffi::webkit_website_data_manager_fetch(
self.to_glib_none().0,
types.into_glib(),
cancellable.map(|p| p.as_ref()).to_glib_none().0,
Some(callback),
Box_::into_raw(user_data) as *mut _,
);
}
}
pub fn fetch_future(
&self,
types: WebsiteDataTypes,
) -> Pin<Box_<dyn std::future::Future<Output = Result<Vec<WebsiteData>, glib::Error>> + 'static>>
{
Box_::pin(gio::GioFuture::new(self, move |obj, cancellable, send| {
obj.fetch(types, Some(cancellable), move |res| {
send.resolve(res);
});
}))
}
/// Get the #WebKitWebsiteDataManager:base-cache-directory property.
///
/// # Returns
///
/// the base directory for caches, or [`None`] if
/// #WebKitWebsiteDataManager:base-cache-directory was not provided or @self is ephemeral.
#[doc(alias = "webkit_website_data_manager_get_base_cache_directory")]
#[doc(alias = "get_base_cache_directory")]
#[doc(alias = "base-cache-directory")]
pub fn base_cache_directory(&self) -> Option<glib::GString> {
unsafe {
from_glib_none(ffi::webkit_website_data_manager_get_base_cache_directory(
self.to_glib_none().0,
))
}
}
/// Get the #WebKitWebsiteDataManager:base-data-directory property.
///
/// # Returns
///
/// the base directory for website data, or [`None`] if
/// #WebKitWebsiteDataManager:base-data-directory was not provided or @self is ephemeral.
#[doc(alias = "webkit_website_data_manager_get_base_data_directory")]
#[doc(alias = "get_base_data_directory")]
#[doc(alias = "base-data-directory")]
pub fn base_data_directory(&self) -> Option<glib::GString> {
unsafe {
from_glib_none(ffi::webkit_website_data_manager_get_base_data_directory(
self.to_glib_none().0,
))
}
}
/// Get the #WebKitFaviconDatabase of @self.
///
/// # Returns
///
/// a #WebKitFaviconDatabase, or [`None`] if website icons are disabled
#[doc(alias = "webkit_website_data_manager_get_favicon_database")]
#[doc(alias = "get_favicon_database")]
pub fn favicon_database(&self) -> Option<FaviconDatabase> {
unsafe {
from_glib_none(ffi::webkit_website_data_manager_get_favicon_database(
self.to_glib_none().0,
))
}
}
/// Get whether website icons are enabled.
///
/// # Returns
///
/// [`true`] if website icons are enabled, or [`false`] otherwise.
#[doc(alias = "webkit_website_data_manager_get_favicons_enabled")]
#[doc(alias = "get_favicons_enabled")]
pub fn is_favicons_enabled(&self) -> bool {
unsafe {
from_glib(ffi::webkit_website_data_manager_get_favicons_enabled(
self.to_glib_none().0,
))
}
}
/// Asynchronously get the list of #WebKitITPThirdParty seen for @self.
///
/// Every #WebKitITPThirdParty
/// contains the list of #WebKitITPFirstParty under which it has been seen.
///
/// When the operation is finished, @callback will be called. You can then call
/// webkit_website_data_manager_get_itp_summary_finish() to get the result of the operation.
/// ## `cancellable`
/// a #GCancellable or [`None`] to ignore
/// ## `callback`
/// a #GAsyncReadyCallback to call when the request is satisfied
#[doc(alias = "webkit_website_data_manager_get_itp_summary")]
#[doc(alias = "get_itp_summary")]
pub fn itp_summary<P: FnOnce(Result<Vec<ITPThirdParty>, glib::Error>) + 'static>(
&self,
cancellable: Option<&impl IsA<gio::Cancellable>>,
callback: P,
) {
let main_context = glib::MainContext::ref_thread_default();
let is_main_context_owner = main_context.is_owner();
let has_acquired_main_context = (!is_main_context_owner)
.then(|| main_context.acquire().ok())
.flatten();
assert!(
is_main_context_owner || has_acquired_main_context.is_some(),
"Async operations only allowed if the thread is owning the MainContext"
);
let user_data: Box_<glib::thread_guard::ThreadGuard<P>> =
Box_::new(glib::thread_guard::ThreadGuard::new(callback));
unsafe extern "C" fn itp_summary_trampoline<
P: FnOnce(Result<Vec<ITPThirdParty>, glib::Error>) + 'static,
>(
_source_object: *mut glib::gobject_ffi::GObject,
res: *mut gio::ffi::GAsyncResult,
user_data: glib::ffi::gpointer,
) {
let mut error = std::ptr::null_mut();
let ret = ffi::webkit_website_data_manager_get_itp_summary_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 = itp_summary_trampoline::<P>;
unsafe {
ffi::webkit_website_data_manager_get_itp_summary(
self.to_glib_none().0,
cancellable.map(|p| p.as_ref()).to_glib_none().0,
Some(callback),
Box_::into_raw(user_data) as *mut _,
);
}
}
pub fn itp_summary_future(
&self,
) -> Pin<
Box_<dyn std::future::Future<Output = Result<Vec<ITPThirdParty>, glib::Error>> + 'static>,
> {
Box_::pin(gio::GioFuture::new(self, move |obj, cancellable, send| {
obj.itp_summary(Some(cancellable), move |res| {
send.resolve(res);
});
}))
}
/// Get whether a #WebKitWebsiteDataManager is ephemeral.
///
/// See #WebKitWebsiteDataManager:is-ephemeral for more details.
///
/// # Returns
///
/// [`true`] if @self is ephemeral or [`false`] otherwise.
#[doc(alias = "webkit_website_data_manager_is_ephemeral")]
pub fn is_ephemeral(&self) -> bool {
unsafe {
from_glib(ffi::webkit_website_data_manager_is_ephemeral(
self.to_glib_none().0,
))
}
}
/// Set whether website icons are enabled. Website icons are disabled by default.
/// When website icons are disabled, the #WebKitFaviconDatabase of @self is closed and
/// its reference removed, so webkit_website_data_manager_get_favicon_database() will
/// return [`None`]. If website icons are enabled again, a new #WebKitFaviconDatabase will
/// be created.
/// ## `enabled`
/// value to set
#[doc(alias = "webkit_website_data_manager_set_favicons_enabled")]
pub fn set_favicons_enabled(&self, enabled: bool) {
unsafe {
ffi::webkit_website_data_manager_set_favicons_enabled(
self.to_glib_none().0,
enabled.into_glib(),
);
}
}
}
// rustdoc-stripper-ignore-next
/// A [builder-pattern] type to construct [`WebsiteDataManager`] objects.
///
/// [builder-pattern]: https://doc.rust-lang.org/1.0.0/style/ownership/builders.html
#[must_use = "The builder must be built to be used"]
pub struct WebsiteDataManagerBuilder {
builder: glib::object::ObjectBuilder<'static, WebsiteDataManager>,
}
impl WebsiteDataManagerBuilder {
fn new() -> Self {
Self {
builder: glib::object::Object::builder(),
}
}
/// The base directory for caches. If [`None`], a default location will be used.
pub fn base_cache_directory(self, base_cache_directory: impl Into<glib::GString>) -> Self {
Self {
builder: self
.builder
.property("base-cache-directory", base_cache_directory.into()),
}
}
/// The base directory for website data. If [`None`], a default location will be used.
pub fn base_data_directory(self, base_data_directory: impl Into<glib::GString>) -> Self {
Self {
builder: self
.builder
.property("base-data-directory", base_data_directory.into()),
}
}
/// Whether the #WebKitWebsiteDataManager is ephemeral. An ephemeral #WebKitWebsiteDataManager
/// handles all websites data as non-persistent, and nothing will be written to the client
/// storage. Note that if you create an ephemeral #WebKitWebsiteDataManager all other construction
/// parameters to configure data directories will be ignored.
pub fn is_ephemeral(self, is_ephemeral: bool) -> Self {
Self {
builder: self.builder.property("is-ephemeral", is_ephemeral),
}
}
/// The percentage of volume space that can be used for data storage for every domain.
/// If the maximum storage is reached the storage request will fail with a QuotaExceededError exception.
/// A value of 0.0 means that data storage is not allowed. A value of -1.0, which is the default,
/// means WebKit will use the default quota (1 GiB).
#[cfg(feature = "v2_42")]
#[cfg_attr(docsrs, doc(cfg(feature = "v2_42")))]
pub fn origin_storage_ratio(self, origin_storage_ratio: f64) -> Self {
Self {
builder: self
.builder
.property("origin-storage-ratio", origin_storage_ratio),
}
}
/// The percentage of volume space that can be used for data storage for all domains.
/// If the maximum storage is reached the eviction will happen.
/// A value of 0.0 means that data storage is not allowed. A value of -1.0, which is the default,
/// means there's no limit for the total storage.
#[cfg(feature = "v2_42")]
#[cfg_attr(docsrs, doc(cfg(feature = "v2_42")))]
pub fn total_storage_ratio(self, total_storage_ratio: f64) -> Self {
Self {
builder: self
.builder
.property("total-storage-ratio", total_storage_ratio),
}
}
// rustdoc-stripper-ignore-next
/// Build the [`WebsiteDataManager`].
#[must_use = "Building the object from the builder is usually expensive and is not expected to have side effects"]
pub fn build(self) -> WebsiteDataManager {
self.builder.build()
}
}