Struct vaas::builder::Builder

pub struct Builder<A: Authenticator> { /* private fields */ }

Builder struct to create a new Vaas instance with the expected default values.

// Create a new [Vaas] instance from the builder.
use vaas::Builder;
use vaas::auth::authenticators::ClientCredentials;

let authenticator = ClientCredentials::new("client_id".to_string(), "client_secret".to_string());

let vaas = Builder::new(authenticator).build()?;

Implementations

impl<A: Authenticator> Builder<A>

pub fn new(authenticator: A) -> Self

Create a new VaasBuilder to create a Vaas instance.

pub fn keep_alive_delay_ms(self, delay: u64) -> Self

Set the delay in which a Ping is sent to the server to keep the connection alive. Defaults to 10s.

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

Enable or disable periodic pings to the server to keep the connection alive. Defaults to enabled (true).

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

Enable or disable the Cache-Lookup on the server

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

Enable or disable the Hash-Lookup on the server

pub fn channel_capacity(self, capacity: usize) -> Self

Set the channel capacity of the internal results channel. Increase the value if a ResultChannelError("channel lagged by X") is received. Defaults to 100.

pub fn url(self, url: Url) -> Self

Change the URL of the VaaS API.

pub fn build(self) -> VResult<Vaas<A>>

Create a Vaas struct from the VaasBuilder.