// 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::{CacheType, SessionFeature};
use glib::{prelude::*, translate::*};

glib::wrapper! {
    /// File-based cache for HTTP resources.
    ///
    /// ## Properties
    ///
    ///
    /// #### `cache-dir`
    ///  The directory to store the cache files.
    ///
    /// Readable | Writeable | Construct Only
    ///
    ///
    /// #### `cache-type`
    ///  Whether the cache is private or shared.
    ///
    /// Readable | Writeable | Construct Only
    ///
    /// # Implements
    ///
    /// [`CacheExt`][trait@crate::prelude::CacheExt], [`trait@glib::ObjectExt`], [`SessionFeatureExt`][trait@crate::prelude::SessionFeatureExt]
    #[doc(alias = "SoupCache")]
    pub struct Cache(Object<ffi::SoupCache, ffi::SoupCacheClass>) @implements SessionFeature;

    match fn {
        type_ => || ffi::soup_cache_get_type(),
    }
}

impl Cache {
    pub const NONE: Option<&'static Cache> = None;

    /// Creates a new #SoupCache.
    /// ## `cache_dir`
    /// the directory to store the cached data, or [`None`]
    ///   to use the default one. Note that since the cache isn't safe to access for
    ///   multiple processes at once, and the default directory isn't namespaced by
    ///   process, clients are strongly discouraged from passing [`None`].
    /// ## `cache_type`
    /// the #SoupCacheType of the cache
    ///
    /// # Returns
    ///
    /// a new #SoupCache
    #[doc(alias = "soup_cache_new")]
    pub fn new(cache_dir: Option<&str>, cache_type: CacheType) -> Cache {
        assert_initialized_main_thread!();
        unsafe {
            from_glib_full(ffi::soup_cache_new(
                cache_dir.to_glib_none().0,
                cache_type.into_glib(),
            ))
        }
    }

    // rustdoc-stripper-ignore-next
    /// Creates a new builder-pattern struct instance to construct [`Cache`] objects.
    ///
    /// This method returns an instance of [`CacheBuilder`](crate::builders::CacheBuilder) which can be used to create [`Cache`] objects.
    pub fn builder() -> CacheBuilder {
        CacheBuilder::new()
    }
}

impl Default for Cache {
    fn default() -> Self {
        glib::object::Object::new::<Self>()
    }
}

// rustdoc-stripper-ignore-next
/// A [builder-pattern] type to construct [`Cache`] 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 CacheBuilder {
    builder: glib::object::ObjectBuilder<'static, Cache>,
}

impl CacheBuilder {
    fn new() -> Self {
        Self {
            builder: glib::object::Object::builder(),
        }
    }

    /// The directory to store the cache files.
    pub fn cache_dir(self, cache_dir: impl Into<glib::GString>) -> Self {
        Self {
            builder: self.builder.property("cache-dir", cache_dir.into()),
        }
    }

    /// Whether the cache is private or shared.
    pub fn cache_type(self, cache_type: CacheType) -> Self {
        Self {
            builder: self.builder.property("cache-type", cache_type),
        }
    }

    // rustdoc-stripper-ignore-next
    /// Build the [`Cache`].
    #[must_use = "Building the object from the builder is usually expensive and is not expected to have side effects"]
    pub fn build(self) -> Cache {
        self.builder.build()
    }
}

mod sealed {
    pub trait Sealed {}
    impl<T: super::IsA<super::Cache>> Sealed for T {}
}

/// Trait containing all [`struct@Cache`] methods.
///
/// # Implementors
///
/// [`Cache`][struct@crate::Cache]
pub trait CacheExt: IsA<Cache> + sealed::Sealed + 'static {
    /// Will remove all entries in the @self plus all the cache files.
    ///
    /// This is not thread safe and must be called only from the thread that created the #SoupCache
    #[doc(alias = "soup_cache_clear")]
    fn clear(&self) {
        unsafe {
            ffi::soup_cache_clear(self.as_ref().to_glib_none().0);
        }
    }

    /// Synchronously writes the cache index out to disk.
    ///
    /// Contrast with [`flush()`][Self::flush()], which writes pending cache *entries* to
    /// disk.
    ///
    /// You must call this before exiting if you want your cache data to
    /// persist between sessions.
    ///
    /// This is not thread safe and must be called only from the thread that created the #SoupCache
    #[doc(alias = "soup_cache_dump")]
    fn dump(&self) {
        unsafe {
            ffi::soup_cache_dump(self.as_ref().to_glib_none().0);
        }
    }

    /// Forces all pending writes in the @self to be
    /// committed to disk.
    ///
    /// For doing so it will iterate the [`glib::MainContext`][crate::glib::MainContext] associated with
    /// @self's session as long as needed.
    ///
    /// Contrast with [`dump()`][Self::dump()], which writes out the cache index file.
    #[doc(alias = "soup_cache_flush")]
    fn flush(&self) {
        unsafe {
            ffi::soup_cache_flush(self.as_ref().to_glib_none().0);
        }
    }

    /// Gets the maximum size of the cache.
    ///
    /// # Returns
    ///
    /// the maximum size of the cache, in bytes.
    #[doc(alias = "soup_cache_get_max_size")]
    #[doc(alias = "get_max_size")]
    fn max_size(&self) -> u32 {
        unsafe { ffi::soup_cache_get_max_size(self.as_ref().to_glib_none().0) }
    }

    /// Loads the contents of @self's index into memory.
    ///
    /// This is not thread safe and must be called only from the thread that created the #SoupCache
    #[doc(alias = "soup_cache_load")]
    fn load(&self) {
        unsafe {
            ffi::soup_cache_load(self.as_ref().to_glib_none().0);
        }
    }

    /// Sets the maximum size of the cache.
    /// ## `max_size`
    /// the maximum size of the cache, in bytes
    #[doc(alias = "soup_cache_set_max_size")]
    fn set_max_size(&self, max_size: u32) {
        unsafe {
            ffi::soup_cache_set_max_size(self.as_ref().to_glib_none().0, max_size);
        }
    }

    /// The directory to store the cache files.
    #[doc(alias = "cache-dir")]
    fn cache_dir(&self) -> Option<glib::GString> {
        ObjectExt::property(self.as_ref(), "cache-dir")
    }

    /// Whether the cache is private or shared.
    #[doc(alias = "cache-type")]
    fn cache_type(&self) -> CacheType {
        ObjectExt::property(self.as_ref(), "cache-type")
    }
}

impl<O: IsA<Cache>> CacheExt for O {}