Struct webkit2gtk::NetworkProxySettings

#[repr(transparent)]
pub struct NetworkProxySettings { /* private fields */ }

Available on crate feature v2_16 only.

Configures network proxies.

WebKitNetworkProxySettings can be used to provide a custom proxy configuration to a WebContext. You need to call webkit_web_context_set_network_proxy_settings() with NetworkProxyMode::Custom and a WebKitNetworkProxySettings.

Implementations

impl NetworkProxySettings

pub fn as_ptr(&self) -> *mut WebKitNetworkProxySettings

impl NetworkProxySettings

pub fn new(
    default_proxy_uri: Option<&str>,
    ignore_hosts: &[&str]
) -> NetworkProxySettings

Create a new NetworkProxySettings with the given default_proxy_uri and ignore_hosts.

The default proxy URI will be used for any URI that doesn’t match ignore_hosts, and doesn’t match any of the schemes added with add_proxy_for_scheme(). If default_proxy_uri starts with “socks://”, it will be treated as referring to all three of the socks5, socks4a, and socks4 proxy types.

ignore_hosts is a list of hostnames and IP addresses that the resolver should allow direct connections to. Entries can be in one of 4 formats: <itemizedlist> <listitem>``<para> A hostname, such as “example.com”, “.example.com”, or “*.example.com”, any of which match “example.com” or any subdomain of it. </para>``</listitem> <listitem>``<para> An IPv4 or IPv6 address, such as “192.168.1.1”, which matches only that address. </para>``</listitem> <listitem>``<para> A hostname or IP address followed by a port, such as “example.com:80”, which matches whatever the hostname or IP address would match, but only for URLs with the (explicitly) indicated port. In the case of an IPv6 address, the address part must appear in brackets: “[::1]:443” </para>``</listitem> <listitem>``<para> An IP address range, given by a base address and prefix length, such as “fe80::/10”, which matches any address in that range. </para>``</listitem> </itemizedlist>

Note that when dealing with Unicode hostnames, the matching is done against the ASCII form of the name. Also note that hostname exclusions apply only to connections made to hosts identified by name, and IP address exclusions apply only to connections made to hosts identified by address. That is, if example.com has an address of 192.168.1.1, and ignore_hosts contains only “192.168.1.1”, then a connection to “example.com” will use the proxy, and a connection to 192.168.1.1“ will not.

default_proxy_uri

the default proxy URI to use, or None.

ignore_hosts

an optional list of hosts/IP addresses to not use a proxy for.

Returns

A new NetworkProxySettings.

pub fn add_proxy_for_scheme(&mut self, scheme: &str, proxy_uri: &str)

Adds a URI-scheme-specific proxy.

URIs whose scheme matches uri_scheme will be proxied via proxy_uri. As with the default proxy URI, if proxy_uri starts with “socks://”, it will be treated as referring to all three of the socks5, socks4a, and socks4 proxy types.

scheme

the URI scheme to add a proxy for

proxy_uri

the proxy URI to use for uri_scheme

Trait Implementations

impl Clone for NetworkProxySettings

fn clone(&self) -> Self

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for NetworkProxySettings

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

Formats the value using the given formatter.

impl Hash for NetworkProxySettings

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

Feeds this value into the given Hasher.

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

Feeds a slice of this type into the given Hasher.

impl Ord for NetworkProxySettings

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

This method returns an Ordering between self and other.

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

Compares and returns the maximum of two values.

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

Compares and returns the minimum of two values.

const fn clamp(self, min: Self, max: Self) -> Selfwhere
    Self: PartialOrd<Self>,

Restrict a value to a certain interval.

impl PartialEq<NetworkProxySettings> for NetworkProxySettings

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

This method tests for self and other values to be equal, and is used by ==.

const 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 PartialOrd<NetworkProxySettings> for NetworkProxySettings

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

This method returns an ordering between self and other values if one exists.

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

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

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

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

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

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

const 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 NetworkProxySettings

fn static_type() -> Type

Returns the type identifier of Self.

impl Eq for NetworkProxySettings

impl StructuralEq for NetworkProxySettings

impl StructuralPartialEq for NetworkProxySettings