Struct BrowserPoolBuilder 

pub struct BrowserPoolBuilder { /* private fields */ }

Builder for constructing a BrowserPool with validation.

This is the recommended way to create a pool as it validates configuration and provides sensible defaults.

Example

use std::time::Duration;
use html2pdf_api::{BrowserPool, BrowserPoolConfigBuilder, ChromeBrowserFactory};

let pool = BrowserPool::builder()
    .config(
        BrowserPoolConfigBuilder::new()
            .max_pool_size(10)
            .warmup_count(5)
            .browser_ttl(Duration::from_secs(7200))
            .build()?
    )
    .factory(Box::new(ChromeBrowserFactory::with_defaults()))
    .enable_keep_alive(true)
    .build()?;

Implementations

impl BrowserPoolBuilder

pub fn new() -> Self

Create a new builder with defaults.

Example

let builder = BrowserPoolBuilder::new();

pub fn config(self, config: BrowserPoolConfig) -> Self

Set custom configuration.

If not called, uses BrowserPoolConfig::default().

Parameters

• config - Validated configuration from crate::BrowserPoolConfigBuilder.

Example

let config = BrowserPoolConfigBuilder::new()
    .max_pool_size(10)
    .build()?;

let pool = BrowserPool::builder()
    .config(config)
    .factory(Box::new(ChromeBrowserFactory::with_defaults()))
    .build()?;

pub fn factory(self, factory: Box<dyn BrowserFactory>) -> Self

Set browser factory (required).

The factory is responsible for creating browser instances. Use ChromeBrowserFactory for Chrome/Chromium browsers.

Parameters

• factory - A boxed BrowserFactory implementation.

Example

let pool = BrowserPool::builder()
    .factory(Box::new(ChromeBrowserFactory::with_defaults()))
    .build()?;

pub fn enable_keep_alive(self, enable: bool) -> Self

Enable or disable keep-alive thread.

Keep-alive should be disabled only for testing. Production use should always have it enabled.

Parameters

• enable - Whether to enable the keep-alive thread.

Example

// Disable for tests
let pool = BrowserPool::builder()
    .factory(Box::new(ChromeBrowserFactory::with_defaults()))
    .enable_keep_alive(false)
    .build()?;

pub fn build(self) -> Result<BrowserPool>

Build the browser pool.

Errors

Returns BrowserPoolError::Configuration if factory is not provided.

Panics

Panics if called outside a tokio runtime context.

Example

let pool = BrowserPool::builder()
    .factory(Box::new(ChromeBrowserFactory::with_defaults()))
    .build()?;

Trait Implementations

impl Default for BrowserPoolBuilder

fn default() -> Self

Returns the “default value” for a type.