Struct PacResolverBuilder 

pub struct PacResolverBuilder { /* private fields */ }

Available on crate features js and pac and std only.

Builds a PacResolver.

Implementations

impl PacResolverBuilder

pub fn with_env(self, env: PacEnv) -> PacResolverBuilder

Configure the javascript environment the script runs in.

pub fn set_env(&mut self, env: PacEnv) -> &mut PacResolverBuilder

Configure the javascript environment the script runs in.

pub fn with_runtime(self, runtime: JsRuntimeBuilder) -> PacResolverBuilder

Start from this runtime blueprint instead of the default one, e.g. to register extra globals or tighten the js limits.

The resolver owns the execution time limit, so one set here is overridden.

pub fn set_runtime( &mut self, runtime: JsRuntimeBuilder, ) -> &mut PacResolverBuilder

Start from this runtime blueprint instead of the default one, e.g. to register extra globals or tighten the js limits.

The resolver owns the execution time limit, so one set here is overridden.

pub fn with_sanitize(self, sanitize: PacUrlSanitize) -> PacResolverBuilder

How much of the request uri the script sees (defaults to PacUrlSanitize::HttpsOnly).

pub fn set_sanitize( &mut self, sanitize: PacUrlSanitize, ) -> &mut PacResolverBuilder

How much of the request uri the script sees (defaults to PacUrlSanitize::HttpsOnly).

pub fn maybe_with_execution_time_limit( self, execution_time_limit: Option<Duration>, ) -> PacResolverBuilder

Wall-clock limit for one script call (defaults to PacResolver::DEFAULT_EXECUTION_TIME_LIMIT).

Exceeding it poisons the runtime; the resolver rebuilds the worker on the next lookup. None removes the limit — and with it the derived lookup timeout — at the risk of a script wedging its worker forever.

pub fn maybe_set_execution_time_limit( &mut self, execution_time_limit: Option<Duration>, ) -> &mut PacResolverBuilder

Wall-clock limit for one script call (defaults to PacResolver::DEFAULT_EXECUTION_TIME_LIMIT).

Exceeding it poisons the runtime; the resolver rebuilds the worker on the next lookup. None removes the limit — and with it the derived lookup timeout — at the risk of a script wedging its worker forever.

pub fn with_execution_time_limit( self, execution_time_limit: Duration, ) -> PacResolverBuilder

Wall-clock limit for one script call (defaults to PacResolver::DEFAULT_EXECUTION_TIME_LIMIT).

Exceeding it poisons the runtime; the resolver rebuilds the worker on the next lookup. None removes the limit — and with it the derived lookup timeout — at the risk of a script wedging its worker forever.

pub fn set_execution_time_limit( &mut self, execution_time_limit: Duration, ) -> &mut PacResolverBuilder

Wall-clock limit for one script call (defaults to PacResolver::DEFAULT_EXECUTION_TIME_LIMIT).

Exceeding it poisons the runtime; the resolver rebuilds the worker on the next lookup. None removes the limit — and with it the derived lookup timeout — at the risk of a script wedging its worker forever.

pub fn without_execution_time_limit(self) -> PacResolverBuilder

Wall-clock limit for one script call (defaults to PacResolver::DEFAULT_EXECUTION_TIME_LIMIT).

Exceeding it poisons the runtime; the resolver rebuilds the worker on the next lookup. None removes the limit — and with it the derived lookup timeout — at the risk of a script wedging its worker forever.

pub fn unset_execution_time_limit(&mut self) -> &mut PacResolverBuilder

Wall-clock limit for one script call (defaults to PacResolver::DEFAULT_EXECUTION_TIME_LIMIT).

Exceeding it poisons the runtime; the resolver rebuilds the worker on the next lookup. None removes the limit — and with it the derived lookup timeout — at the risk of a script wedging its worker forever.

pub fn maybe_with_timeout(self, timeout: Option<Duration>) -> PacResolverBuilder

Fail a lookup that did not complete within this duration, queue time included.

None derives it from the execution time limit — see PacResolver::default_timeout_for — because a script can wedge its worker in native code that limit cannot interrupt, and no caller may wait on that forever. Callers only wait indefinitely when the execution time limit is removed too.

pub fn maybe_set_timeout( &mut self, timeout: Option<Duration>, ) -> &mut PacResolverBuilder

Fail a lookup that did not complete within this duration, queue time included.

None derives it from the execution time limit — see PacResolver::default_timeout_for — because a script can wedge its worker in native code that limit cannot interrupt, and no caller may wait on that forever. Callers only wait indefinitely when the execution time limit is removed too.

pub fn with_timeout(self, timeout: Duration) -> PacResolverBuilder

Fail a lookup that did not complete within this duration, queue time included.

None derives it from the execution time limit — see PacResolver::default_timeout_for — because a script can wedge its worker in native code that limit cannot interrupt, and no caller may wait on that forever. Callers only wait indefinitely when the execution time limit is removed too.

pub fn set_timeout(&mut self, timeout: Duration) -> &mut PacResolverBuilder

Fail a lookup that did not complete within this duration, queue time included.

None derives it from the execution time limit — see PacResolver::default_timeout_for — because a script can wedge its worker in native code that limit cannot interrupt, and no caller may wait on that forever. Callers only wait indefinitely when the execution time limit is removed too.

pub fn without_timeout(self) -> PacResolverBuilder

Fail a lookup that did not complete within this duration, queue time included.

None derives it from the execution time limit — see PacResolver::default_timeout_for — because a script can wedge its worker in native code that limit cannot interrupt, and no caller may wait on that forever. Callers only wait indefinitely when the execution time limit is removed too.

pub fn unset_timeout(&mut self) -> &mut PacResolverBuilder

Fail a lookup that did not complete within this duration, queue time included.

None derives it from the execution time limit — see PacResolver::default_timeout_for — because a script can wedge its worker in native code that limit cannot interrupt, and no caller may wait on that forever. Callers only wait indefinitely when the execution time limit is removed too.

pub fn with_wedge_cooldown(self, wedge_cooldown: Duration) -> PacResolverBuilder

How long an unresolved worker charge counts against PacResolver::MAX_WORKER_SPAWNS_PER_WINDOW (defaults to PacResolver::DEFAULT_WEDGE_COOLDOWN).

Lookups fail once the window is full, so keep it long enough that a wedging script cannot leak a thread per lookup and short enough that a fixed script is picked up promptly.

pub fn set_wedge_cooldown( &mut self, wedge_cooldown: Duration, ) -> &mut PacResolverBuilder

How long an unresolved worker charge counts against PacResolver::MAX_WORKER_SPAWNS_PER_WINDOW (defaults to PacResolver::DEFAULT_WEDGE_COOLDOWN).

Lookups fail once the window is full, so keep it long enough that a wedging script cannot leak a thread per lookup and short enough that a fixed script is picked up promptly.

pub fn maybe_with_queue_capacity( self, queue_capacity: Option<usize>, ) -> PacResolverBuilder

Capacity of the worker’s job queue.

pub fn maybe_set_queue_capacity( &mut self, queue_capacity: Option<usize>, ) -> &mut PacResolverBuilder

Capacity of the worker’s job queue.

pub fn with_queue_capacity(self, queue_capacity: usize) -> PacResolverBuilder

Capacity of the worker’s job queue.

pub fn set_queue_capacity( &mut self, queue_capacity: usize, ) -> &mut PacResolverBuilder

Capacity of the worker’s job queue.

pub fn without_queue_capacity(self) -> PacResolverBuilder

Capacity of the worker’s job queue.

pub fn unset_queue_capacity(&mut self) -> &mut PacResolverBuilder

Capacity of the worker’s job queue.

pub fn maybe_with_graceful( self, graceful: Option<ShutdownGuard>, ) -> PacResolverBuilder

Tie the worker to a graceful shutdown guard.

pub fn maybe_set_graceful( &mut self, graceful: Option<ShutdownGuard>, ) -> &mut PacResolverBuilder

Tie the worker to a graceful shutdown guard.

pub fn with_graceful(self, graceful: ShutdownGuard) -> PacResolverBuilder

Tie the worker to a graceful shutdown guard.

pub fn set_graceful( &mut self, graceful: ShutdownGuard, ) -> &mut PacResolverBuilder

Tie the worker to a graceful shutdown guard.

pub fn without_graceful(self) -> PacResolverBuilder

Tie the worker to a graceful shutdown guard.

pub fn unset_graceful(&mut self) -> &mut PacResolverBuilder

Tie the worker to a graceful shutdown guard.

pub fn build<P>( self, provider: P, script_uri: Uri, ) -> Result<PacResolver, Box<dyn Error + Sync + Send>>

where P: Service<Uri, Output = PacScript>, <P as Service<Uri>>::Error: Error + Send + Sync + 'static,

Build a resolver serving the script the provider returns for script_uri.

pub fn build_static( self, script: impl Into<PacScript>, ) -> Result<PacResolver, Box<dyn Error + Sync + Send>>

Build a resolver serving a fixed script.

Trait Implementations

impl Debug for PacResolverBuilder

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

Formats the value using the given formatter.

impl Default for PacResolverBuilder

fn default() -> PacResolverBuilder

Returns the “default value” for a type.