Struct webkit6::NetworkSession

pub struct NetworkSession { /* private fields */ }

Manages network configuration.

Properties

cache-directory

The base caches directory used to create the #WebKitWebsiteDataManager. If None, a default location will be used.

Writeable | Construct Only

data-directory

The base data directory used to create the #WebKitWebsiteDataManager. If None, a default location will be used.

Writeable | Construct Only

is-ephemeral

Whether to create an ephermeral #WebKitWebsiteDataManager for the session.

Readable | Writeable | Construct Only

Signals

download-started

This signal is emitted when a new download request is made.

GLib type: GObject with reference counted clone semantics.

Implementations

impl NetworkSession

pub fn new( data_directory: Option<&str>, cache_directory: Option<&str>, ) -> NetworkSession

Creates a new #WebKitNetworkSession with a persistent #WebKitWebsiteDataManager. The parameters @data_directory and @cache_directory will be used as construct properties of the #WebKitWebsiteDataManager of the network session. Note that if None is passed, the default directory will be passed to #WebKitWebsiteDataManager so that webkit_website_data_manager_get_base_data_directory() and webkit_website_data_manager_get_base_cache_directory() always return a value for non ephemeral sessions.

It must be passed as construct parameter of a #WebKitWebView.

data_directory

a base directory for data, or None

cache_directory

a base directory for caches, or None

Returns

the newly created #WebKitNetworkSession

pub fn new_ephemeral() -> NetworkSession

Creates a new #WebKitNetworkSession with an ephemeral #WebKitWebsiteDataManager.

Returns

a new ephemeral #WebKitNetworkSession.

pub fn builder() -> NetworkSessionBuilder

Creates a new builder-pattern struct instance to construct NetworkSession objects.

This method returns an instance of NetworkSessionBuilder which can be used to create NetworkSession objects.

pub fn allow_tls_certificate_for_host( &self, certificate: &impl IsA<TlsCertificate>, host: &str, )

Ignore further TLS errors on the @host for the certificate present in @info.

If @host is an IPv6 address, it should not be surrounded by brackets. This expectation matches g_uri_get_host().

certificate

a #GTlsCertificate

host

the host for which a certificate is to be allowed

pub fn download_uri(&self, uri: &str) -> Option<Download>

Requests downloading of the specified URI string.

The download operation will not be associated to any #WebKitWebView, if you are interested in starting a download from a particular #WebKitWebView use webkit_web_view_download_uri() instead.

uri

the URI to download

Returns

a new #WebKitDownload representing the download operation.

pub fn cookie_manager(&self) -> Option<CookieManager>

Get the #WebKitCookieManager of @self.

Returns

a #WebKitCookieManager

pub fn is_itp_enabled(&self) -> bool

Get whether Intelligent Tracking Prevention (ITP) is enabled or not.

Returns

true if ITP is enabled, or false otherwise.

pub fn itp_summary<P: FnOnce(Result<Vec<ITPThirdParty>, Error>) + 'static>( &self, cancellable: Option<&impl IsA<Cancellable>>, callback: P, )

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_network_session_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

pub fn itp_summary_future( &self, ) -> Pin<Box_<dyn Future<Output = Result<Vec<ITPThirdParty>, Error>> + 'static>>

pub fn is_persistent_credential_storage_enabled(&self) -> bool

Get whether persistent credential storage is enabled or not.

See also webkit_network_session_set_persistent_credential_storage_enabled().

Returns

true if persistent credential storage is enabled, or false otherwise.

pub fn tls_errors_policy(&self) -> TLSErrorsPolicy

Get the TLS errors policy of @self.

Returns

a #WebKitTLSErrorsPolicy

pub fn website_data_manager(&self) -> Option<WebsiteDataManager>

Get the #WebKitWebsiteDataManager of @self.

Returns

a #WebKitWebsiteDataManager

pub fn is_ephemeral(&self) -> bool

Get whether @self is ephemeral. A #WebKitNetworkSession is ephemeral when its #WebKitWebsiteDataManager is ephemeral. See #WebKitWebsiteDataManager:is-ephemeral for more details.

Returns

true if @self is pehmeral, or false otherwise

pub fn prefetch_dns(&self, hostname: &str)

Resolve the domain name of the given @hostname in advance, so that if a URI of @hostname is requested the load will be performed more quickly.

hostname

a hostname to be resolved

pub fn set_itp_enabled(&self, enabled: bool)

Enable or disable Intelligent Tracking Prevention (ITP).

When ITP is enabled resource load statistics are collected and used to decide whether to allow or block third-party cookies and prevent user tracking. Note that while ITP is enabled the accept policy CookieAcceptPolicy::NoThirdParty is ignored and CookieAcceptPolicy::Always is used instead. See also webkit_cookie_session_set_accept_policy().

enabled

value to set

pub fn set_persistent_credential_storage_enabled(&self, enabled: bool)

Enable or disable persistent credential storage.

When enabled, which is the default for non-ephemeral sessions, the network process will try to read and write HTTP authentiacation credentials from persistent storage.

enabled

value to set

pub fn set_proxy_settings( &self, proxy_mode: NetworkProxyMode, proxy_settings: Option<&NetworkProxySettings>, )

Set the network proxy settings to be used by connections started in @self session.

By default NetworkProxyMode::Default is used, which means that the system settings will be used (g_proxy_resolver_get_default()). If you want to override the system default settings, you can either use NetworkProxyMode::NoProxy to make sure no proxies are used at all, or NetworkProxyMode::Custom to provide your own proxy settings. When @proxy_mode is NetworkProxyMode::Custom @proxy_settings must be a valid #WebKitNetworkProxySettings; otherwise, @proxy_settings must be None.

proxy_mode

a #WebKitNetworkProxyMode

proxy_settings

a #WebKitNetworkProxySettings, or None

pub fn set_tls_errors_policy(&self, policy: TLSErrorsPolicy)

Set the TLS errors policy of @self as @policy.

policy

a #WebKitTLSErrorsPolicy

pub fn default() -> Option<NetworkSession>

Get the default network session. The default network session is created using webkit_network_session_new() and passing None as data and cache directories.

Returns

a #WebKitNetworkSession

pub fn set_memory_pressure_settings(settings: &mut MemoryPressureSettings)

Sets @settings as the #WebKitMemoryPressureSettings.

Sets @settings as the #WebKitMemoryPressureSettings to be used by the network process created by any instance of #WebKitNetworkSession after this function is called.

Be sure to call this function before creating any #WebKitNetworkSession.

The periodic check for used memory is disabled by default on network processes. This will be enabled only if custom settings have been set using this function. After that, in order to remove the custom settings and disable the periodic check, this function must be called passing None as the value of @settings.

settings

a WebKitMemoryPressureSettings.

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

This signal is emitted when a new download request is made.

download

the #WebKitDownload associated with this event

Trait Implementations

impl Clone for NetworkSession

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 NetworkSession

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

Formats the value using the given formatter.

impl Default for NetworkSession

fn default() -> Self

Returns the “default value” for a type.

impl HasParamSpec for NetworkSession

type ParamSpec = ParamSpecObject

type SetValue = NetworkSession

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

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

fn param_spec_builder() -> Self::BuilderFn

impl Hash for NetworkSession

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 NetworkSession

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 NetworkSession

type Parent = Object

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

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 NetworkSession

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 NetworkSession

fn static_type() -> Type

Returns the type identifier of Self.

impl Eq for NetworkSession