Struct ic_agent::agent::AgentBuilder

pub struct AgentBuilder { /* private fields */ }

A builder for an Agent.

Implementations

impl AgentBuilder

pub fn build(self) -> Result<Agent, AgentError>

Create an instance of Agent with the information from this builder.

pub fn with_url<S: Into<String>>(self, url: S) -> Self

Available on crate feature reqwest only.

Set the URL of the Agent.

pub fn with_transport<T: 'static + Transport>(self, transport: T) -> Self

Set a Replica transport to talk to serve as the replica interface.

pub fn with_arc_transport(self, transport: Arc<dyn Transport>) -> Self

Same as Self::with_transport, but provides a Arc boxed implementation instead of a direct type.

pub fn with_nonce_factory(self, nonce_factory: NonceFactory) -> AgentBuilder

Add a NonceFactory to this Agent. By default, no nonce is produced.

pub fn with_nonce_generator<N: 'static + NonceGenerator>( self, nonce_factory: N ) -> AgentBuilder

Same as Self::with_nonce_factory, but for any NonceGenerator type

pub fn with_arc_nonce_generator( self, nonce_factory: Arc<dyn NonceGenerator> ) -> AgentBuilder

Same as Self::with_nonce_generator, but provides a Arc boxed implementation instead of a direct type.

pub fn with_identity<I>(self, identity: I) -> Self

where I: 'static + Identity,

Add an identity provider for signing messages. This is required.

pub fn with_boxed_identity(self, identity: Box<dyn Identity>) -> Self

Same as Self::with_identity, but provides a boxed implementation instead of a direct type.

pub fn with_arc_identity(self, identity: Arc<dyn Identity>) -> Self

Same as Self::with_identity, but provides a Arc boxed implementation instead of a direct type.

pub fn with_ingress_expiry(self, ingress_expiry: Option<Duration>) -> Self

Provides a default ingress expiry. This is the delta that will be applied at the time an update or query is made. The default expiry cannot be a fixed system time.

The timestamp corresponding to this duration may be rounded in order to reduce cache misses. The current implementation rounds to the nearest minute if the expiry is more than a minute, but this is not guaranteed.

pub fn with_verify_query_signatures(self, verify_query_signatures: bool) -> Self

Allows disabling query signature verification. Query signatures improve resilience but require a separate read-state call to fetch node keys.

Trait Implementations

impl Default for AgentBuilder

fn default() -> AgentBuilder

Returns the “default value” for a type.