Struct ClientBuilder

pub struct ClientBuilder {
    pub node_manager_builder: NodeManagerBuilder,
    pub broker_options: BrokerOptions,
    pub network_info: NetworkInfo,
    pub api_timeout: Duration,
    pub remote_pow_timeout: Duration,
    pub pow_worker_count: Option<usize>,
    pub max_parallel_api_requests: usize,
}

Available on crate feature client only.

Builder to construct client instance with sensible default values

Fields

node_manager_builder: NodeManagerBuilder

Node manager builder

broker_options: BrokerOptions

Available on crate feature mqtt only.

Options for the MQTT broker

network_info: NetworkInfo

Data related to the used network

api_timeout: Duration

Timeout for API requests

remote_pow_timeout: Duration

Timeout when sending a block that requires remote proof of work

pow_worker_count: Option<usize>

The amount of threads to be used for proof of work

max_parallel_api_requests: usize

The maximum parallel API requests

Implementations

impl ClientBuilder

pub fn new() -> Self

Creates an IOTA client builder.

pub fn from_json(self, client_config: &str) -> Result<Self>

Set the fields from a client JSON config

pub fn with_node(self, url: &str) -> Result<Self>

Adds an IOTA node by its URL.

pub fn with_primary_node( self, url: &str, auth: Option<NodeAuth>, ) -> Result<Self>

Adds an IOTA node by its URL to be used as primary node, with optional jwt and or basic authentication

pub fn with_primary_pow_node( self, url: &str, auth: Option<NodeAuth>, ) -> Result<Self>

Adds an IOTA node by its URL to be used as primary PoW node (for remote Pow), with optional jwt and or basic authentication

pub fn with_permanode(self, url: &str, auth: Option<NodeAuth>) -> Result<Self>

Adds a permanode by its URL, with optional jwt and or basic authentication

pub fn with_node_auth( self, url: &str, auth: impl Into<Option<NodeAuth>>, ) -> Result<Self>

Adds an IOTA node by its URL with optional jwt and or basic authentication

pub fn with_nodes(self, urls: &[&str]) -> Result<Self>

Adds a list of IOTA nodes by their URLs.

pub fn with_node_sync_interval(self, node_sync_interval: Duration) -> Self

Set the node sync interval

pub fn with_ignore_node_health(self) -> Self

Ignores the node health status. Every node will be considered healthy and ready to use.

pub fn with_quorum(self, quorum: bool) -> Self

Set if quorum should be used or not

pub fn with_min_quorum_size(self, min_quorum_size: usize) -> Self

Set amount of nodes which should be used for quorum

pub fn with_quorum_threshold(self, threshold: usize) -> Self

Set quorum_threshold

pub fn with_mqtt_broker_options(self, options: BrokerOptions) -> Self

Available on crate feature mqtt only.

Sets the MQTT broker options.

pub fn with_local_pow(self, local: bool) -> Self

Sets whether the PoW should be done locally or remotely.

pub fn with_pow_worker_count( self, worker_count: impl Into<Option<usize>>, ) -> Self

Sets the amount of workers that should be used for PoW, default is num_cpus::get().

pub fn with_fallback_to_local_pow(self, fallback_to_local_pow: bool) -> Self

Sets whether the PoW should be done locally in case a node doesn’t support remote PoW.

pub fn with_tips_interval(self, tips_interval: u64) -> Self

Sets after how many seconds new tips will be requested during PoW

pub fn with_api_timeout(self, timeout: Duration) -> Self

Sets the default request timeout.

pub fn with_remote_pow_timeout(self, timeout: Duration) -> Self

Sets the request timeout for API usage.

pub fn with_user_agent(self, user_agent: String) -> Self

Set User-Agent header for requests Default is “iota-client/{version}”

pub fn with_max_parallel_api_requests( self, max_parallel_api_requests: usize, ) -> Self

Set maximum parallel API requests.

pub async fn finish(self) -> Result<Client>

Build the Client instance.

pub async fn from_client(client: &Client) -> Self

Trait Implementations

impl Clone for ClientBuilder

fn clone(&self) -> ClientBuilder

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for ClientBuilder

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

Formats the value using the given formatter.

impl Default for ClientBuilder

fn default() -> Self

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for ClientBuilder

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for ClientBuilder

fn eq(&self, other: &ClientBuilder) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Serialize for ClientBuilder

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl Eq for ClientBuilder

impl StructuralPartialEq for ClientBuilder