Struct FetchConfigBuilder 

pub struct FetchConfigBuilder { /* private fields */ }

A builder for a custom FetchConfig.

The builder starts from the built-in default policy. Each setter stores its value as given and returns the builder, so calls can be chained. FetchConfigBuilder::build checks every value at once and reports the first invalid one as a ConfigError.

Implementations

impl FetchConfigBuilder

pub fn allow_http(self, yes: bool) -> FetchConfigBuilder

Sets whether plain http:// URLs are permitted.

pub fn allow_ports( self, ports: impl IntoIterator<Item = u16>, ) -> FetchConfigBuilder

Replaces the set of ports a fetch may target.

pub fn allow_ip_literals(self, yes: bool) -> FetchConfigBuilder

Sets whether a URL may give its host as a bare IP address.

This lifts only the syntax rule. The address itself is still checked against the blocked ranges. A loopback, private, link-local, or other non-global address stays blocked unless an exact host-and-address exception allows it.

pub fn deny_cidr(self, cidr: impl Into<String>) -> FetchConfigBuilder

Adds a CIDR range to block, on top of the built-in blocked ranges.

build parses the text and reports a range that fails to parse.

pub fn allow_host_address( self, host: impl Into<String>, addr: IpAddr, ) -> FetchConfigBuilder

Adds an exception that lets one host reach one otherwise-blocked address.

The exception applies only when a fetch to host connects to addr. Another host that resolves to addr stays blocked. The host match ignores case and a trailing dot. build checks that host is a valid domain name or IP address. This is the only supported way to reach an otherwise-blocked address.

pub fn max_redirects(self, n: usize) -> FetchConfigBuilder

Sets the maximum number of redirect hops a single fetch may follow.

pub fn max_bytes(self, n: usize) -> FetchConfigBuilder

Sets the largest response body accepted, in decompressed bytes.

pub fn max_chars(self, n: usize) -> FetchConfigBuilder

Sets the ceiling on returned text length, in characters.

pub fn connect_timeout(self, d: Duration) -> FetchConfigBuilder

Sets the time allowed to open a TCP connection, on every redirect hop.

pub fn timeout(self, d: Duration) -> FetchConfigBuilder

Sets the cap on the total time a single request may take.

pub fn pool_idle_timeout(self, d: Duration) -> FetchConfigBuilder

Sets how long an idle pooled connection is kept before it is closed.

pub fn user_agent(self, ua: impl Into<String>) -> FetchConfigBuilder

Sets the User-Agent header sent on every request.

pub fn build(self) -> Result<FetchConfig, ConfigError>

Checks every value and returns the finished FetchConfig.

Errors

Returns ConfigError for the first invalid value it finds:

• a User-Agent that is not a legal HTTP header value;
• a max_bytes of zero or above 64 MiB;
• a max_chars of zero or above 10,000,000;
• a max_redirects above 20;
• a connect_timeout of zero or above 60 seconds;
• a timeout of zero or above 300 seconds;
• a pool_idle_timeout of zero or above 600 seconds;
• a denied CIDR range that fails to parse;
• an exception host that is not a valid domain name or IP address.

Trait Implementations

impl Clone for FetchConfigBuilder

fn clone(&self) -> FetchConfigBuilder

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for FetchConfigBuilder

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

Formats the value using the given formatter.

impl Default for FetchConfigBuilder

fn default() -> FetchConfigBuilder

Returns the “default value” for a type.