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
// This file was generated by gir (https://github.com/gtk-rs/gir)
// from
// from gir-files (https://github.com/gtk-rs/gir-files)
// DO NOT EDIT
use crate::{CookieJar, CookieJarAcceptPolicy, SessionFeature};
use glib::{prelude::*, translate::*};
glib::wrapper! {
/// Database-based Cookie Jar.
///
/// #SoupCookieJarDB is a [`CookieJar`][crate::CookieJar] that reads cookies from and writes
/// them to a sqlite database in the new Mozilla format.
///
/// (This is identical to `SoupCookieJarSqlite` in
/// libsoup-gnome; it has just been moved into libsoup proper, and
/// renamed to avoid conflicting.)
///
/// ## Properties
///
///
/// #### `filename`
/// Cookie-storage filename.
///
/// Readable | Writeable | Construct Only
/// <details><summary><h4>CookieJar</h4></summary>
///
///
/// #### `accept-policy`
/// The policy the jar should follow to accept or reject cookies.
///
/// Readable | Writeable
///
///
/// #### `read-only`
/// Whether or not the cookie jar is read-only.
///
/// Readable | Writeable | Construct Only
/// </details>
///
/// # Implements
///
/// [`CookieJarExt`][trait@crate::prelude::CookieJarExt], [`trait@glib::ObjectExt`], [`SessionFeatureExt`][trait@crate::prelude::SessionFeatureExt], [`CookieJarExtManual`][trait@crate::prelude::CookieJarExtManual]
#[doc(alias = "SoupCookieJarDB")]
pub struct CookieJarDB(Object<ffi::SoupCookieJarDB, ffi::SoupCookieJarDBClass>) @extends CookieJar, @implements SessionFeature;
match fn {
type_ => || ffi::soup_cookie_jar_db_get_type(),
}
}
impl CookieJarDB {
/// Creates a #SoupCookieJarDB.
///
/// @filename will be read in at startup to create an initial set of cookies. If
/// @read_only is [`false`], then the non-session cookies will be written to
/// @filename when the [`changed`][struct@crate::CookieJar#changed] signal is emitted from the
/// jar. (If @read_only is [`true`], then the cookie jar will only be used for this
/// session, and changes made to it will be lost when the jar is destroyed.)
/// ## `filename`
/// the filename to read to/write from, or [`None`]
/// ## `read_only`
/// [`true`] if @filename is read-only
///
/// # Returns
///
/// the new #SoupCookieJar
#[doc(alias = "soup_cookie_jar_db_new")]
pub fn new(filename: &str, read_only: bool) -> CookieJarDB {
assert_initialized_main_thread!();
unsafe {
CookieJar::from_glib_full(ffi::soup_cookie_jar_db_new(
filename.to_glib_none().0,
read_only.into_glib(),
))
.unsafe_cast()
}
}
// rustdoc-stripper-ignore-next
/// Creates a new builder-pattern struct instance to construct [`CookieJarDB`] objects.
///
/// This method returns an instance of [`CookieJarDBBuilder`](crate::builders::CookieJarDBBuilder) which can be used to create [`CookieJarDB`] objects.
pub fn builder() -> CookieJarDBBuilder {
CookieJarDBBuilder::new()
}
/// Cookie-storage filename.
pub fn filename(&self) -> Option<glib::GString> {
ObjectExt::property(self, "filename")
}
}
impl Default for CookieJarDB {
fn default() -> Self {
glib::object::Object::new::<Self>()
}
}
// rustdoc-stripper-ignore-next
/// A [builder-pattern] type to construct [`CookieJarDB`] 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 CookieJarDBBuilder {
builder: glib::object::ObjectBuilder<'static, CookieJarDB>,
}
impl CookieJarDBBuilder {
fn new() -> Self {
Self {
builder: glib::object::Object::builder(),
}
}
/// Cookie-storage filename.
pub fn filename(self, filename: impl Into<glib::GString>) -> Self {
Self {
builder: self.builder.property("filename", filename.into()),
}
}
/// The policy the jar should follow to accept or reject cookies.
pub fn accept_policy(self, accept_policy: CookieJarAcceptPolicy) -> Self {
Self {
builder: self.builder.property("accept-policy", accept_policy),
}
}
/// Whether or not the cookie jar is read-only.
pub fn read_only(self, read_only: bool) -> Self {
Self {
builder: self.builder.property("read-only", read_only),
}
}
// rustdoc-stripper-ignore-next
/// Build the [`CookieJarDB`].
#[must_use = "Building the object from the builder is usually expensive and is not expected to have side effects"]
pub fn build(self) -> CookieJarDB {
self.builder.build()
}
}