Struct SurfPoolBuilder 

pub struct SurfPoolBuilder { /* private fields */ }

The builder struct, used to create a SurfPool

Implementations

impl SurfPoolBuilder

pub fn new(size: usize) -> Result<Self>

This function is used to create a new builder The parameter size is checked if is a valid and reasonable number It cannot be 0 or bigger than 100

use surf_pool::SurfPoolBuilder;

SurfPoolBuilder::new(3).unwrap();

pub fn health_check(self, health_check: RequestBuilder) -> Self

The health_check is a URL used to manage the connection It’s used to check the connection health status, as keepalive and as pre-connect URL

use surf_pool::SurfPoolBuilder;

let builder = SurfPoolBuilder::new(3)
    .unwrap()
    .health_check(surf::get("https://httpbin.org"));

pub fn pre_connect(self, pre_connect: bool) -> Self

If true, the connections are established during the build phase, using the health_check. If the health_check is not defined, the pre-connection cannot be peformed, hence it will be ignored

use surf_pool::SurfPoolBuilder;

let builder = SurfPoolBuilder::new(3).
    unwrap()
    .health_check(surf::get("https://httpbin.org"))
    .pre_connect(true);

pub async fn build(self) -> SurfPool

The build function that creates the @SurfPool If a health_check is available and pre_connect is set to true the connections are established in this function

use surf_pool::SurfPoolBuilder;

let builder = SurfPoolBuilder::new(3).
    unwrap()
    .health_check(surf::get("https://httpbin.org"))
    .pre_connect(true);
let pool = builder.build();

Trait Implementations

impl Debug for SurfPoolBuilder

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

Formats the value using the given formatter.

impl Default for SurfPoolBuilder

fn default() -> SurfPoolBuilder

Returns the “default value” for a type.