Struct webkit6::FaviconDatabase

pub struct FaviconDatabase { /* private fields */ }

Provides access to the icons associated with web sites.

WebKit will automatically look for available icons in elements on opened pages as well as an existing favicon.ico and load the images found into a memory cache if possible. That cache is frozen to an on-disk database for persistence.

If #WebKitSettings:enable-private-browsing is true, new icons won’t be added to the on-disk database and no existing icons will be deleted from it. Nevertheless, WebKit will still store them in the in-memory cache during the current execution.

Signals

favicon-changed

This signal is emitted when the favicon URI of @page_uri has been changed to @favicon_uri in the database. You can connect to this signal and call webkit_favicon_database_get_favicon() to get the favicon. If you are interested in the favicon of a #WebKitWebView it’s easier to use the #WebKitWebView:favicon property. See webkit_web_view_get_favicon() for more details.

GLib type: GObject with reference counted clone semantics.

Implementations

impl FaviconDatabase

pub fn clear(&self)

Clears all icons from the database.

pub fn favicon<P: FnOnce(Result<Texture, Error>) + 'static>( &self, page_uri: &str, cancellable: Option<&impl IsA<Cancellable>>, callback: P, )

Asynchronously obtains a favicon image.

Asynchronously obtains an image of the favicon for the given page URI. It returns the cached icon if it’s in the database asynchronously waiting for the icon to be read from the database.

This is an asynchronous method. When the operation is finished, callback will be invoked. You can then call webkit_favicon_database_get_favicon_finish() to get the result of the operation.

page_uri

URI of the page for which we want to retrieve the favicon

cancellable

A #GCancellable or None.

callback

A #GAsyncReadyCallback to call when the request is satisfied or None if you don’t care about the result.

pub fn favicon_future( &self, page_uri: &str, ) -> Pin<Box_<dyn Future<Output = Result<Texture, Error>> + 'static>>

pub fn favicon_uri(&self, page_uri: &str) -> Option<GString>

Obtains the URI of the favicon for the given @page_uri.

page_uri

URI of the page containing the icon

Returns

a newly allocated URI for the favicon, or None if the database doesn’t have a favicon for @page_uri.

pub fn connect_favicon_changed<F: Fn(&Self, &str, &str) + 'static>( &self, f: F, ) -> SignalHandlerId

This signal is emitted when the favicon URI of @page_uri has been changed to @favicon_uri in the database. You can connect to this signal and call webkit_favicon_database_get_favicon() to get the favicon. If you are interested in the favicon of a #WebKitWebView it’s easier to use the #WebKitWebView:favicon property. See webkit_web_view_get_favicon() for more details.

page_uri

the URI of the Web page containing the icon

favicon_uri

the URI of the favicon

Trait Implementations

impl Clone for FaviconDatabase

fn clone(&self) -> Self

Makes a clone of this shared reference.

This increments the strong reference count of the object. Dropping the object will decrement it again.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for FaviconDatabase

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl HasParamSpec for FaviconDatabase

type ParamSpec = ParamSpecObject

type SetValue = FaviconDatabase

Preferred value to be used as setter for the associated ParamSpec.

type BuilderFn = fn(_: &str) -> ParamSpecObjectBuilder<'_, FaviconDatabase>

fn param_spec_builder() -> Self::BuilderFn

impl Hash for FaviconDatabase

fn hash<H>(&self, state: &mut H)

where H: Hasher,

Hashes the memory address of this object.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl Ord for FaviconDatabase

fn cmp(&self, other: &Self) -> Ordering

Comparison for two GObjects.

Compares the memory addresses of the provided objects.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized + PartialOrd,

Restrict a value to a certain interval.

impl ParentClassIs for FaviconDatabase

type Parent = Object

impl<OT: ObjectType> PartialEq<OT> for FaviconDatabase

fn eq(&self, other: &OT) -> bool

Equality for two GObjects.

Two GObjects are equal if their memory addresses are equal.

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl<OT: ObjectType> PartialOrd<OT> for FaviconDatabase

fn partial_cmp(&self, other: &OT) -> Option<Ordering>

Partial comparison for two GObjects.

Compares the memory addresses of the provided objects.

fn lt(&self, other: &Rhs) -> bool

This method tests less than (for self and other) and is used by the < operator.

fn le(&self, other: &Rhs) -> bool

This method tests less than or equal to (for self and other) and is used by the <= operator.

fn gt(&self, other: &Rhs) -> bool

This method tests greater than (for self and other) and is used by the > operator.

fn ge(&self, other: &Rhs) -> bool

This method tests greater than or equal to (for self and other) and is used by the >= operator.

impl StaticType for FaviconDatabase

fn static_type() -> Type

Returns the type identifier of Self.

impl Eq for FaviconDatabase