Struct VoltClientConfig 

pub struct VoltClientConfig {
    pub client_name: String,
    pub volt: VoltConfig,
    pub credential: Option<CredentialCache>,
    pub auto_reconnect: bool,
    pub ping_interval: u64,
    pub reconnect_interval: u64,
    pub timeout_interval: u64,
    pub bind_request_ttl: Option<u64>,
    pub passphrase: Option<String>,
}

Full client configuration

Fields

client_name: String

Name of this client

volt: VoltConfig

Volt server configuration

credential: Option<CredentialCache>

Cached credentials

auto_reconnect: bool

Auto-reconnect on disconnection

ping_interval: u64

Ping interval in milliseconds

reconnect_interval: u64

Reconnect interval in milliseconds

timeout_interval: u64

Timeout interval in milliseconds

bind_request_ttl: Option<u64>

TTL for bind requests

passphrase: Option<String>

Passphrase for encrypted keys

Implementations

impl VoltClientConfig

pub async fn from_file<P: AsRef<Path>>(path: P) -> Result<Self>

Load configuration from a JSON file

pub fn from_str(s: &str) -> Result<Self>

Load configuration from a JSON string

pub fn from_value(value: Value) -> Result<Self>

Create configuration from a JSON object

pub async fn save_to_file<P: AsRef<Path>>(&self, path: P) -> Result<()>

Save configuration to a file

pub fn validate(&self) -> Result<()>

Validate the configuration

pub fn is_relayed(&self) -> bool

Check if this connection is through a relay

Trait Implementations

impl Clone for VoltClientConfig

fn clone(&self) -> VoltClientConfig

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for VoltClientConfig

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

Formats the value using the given formatter.

impl Default for VoltClientConfig

fn default() -> Self

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for VoltClientConfig

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl From<VoltClientConfig> for ConfigSource

fn from(c: VoltClientConfig) -> Self

Converts to this type from the input type.

impl Serialize for VoltClientConfig

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

where __S: Serializer,

Serialize this value into the given Serde serializer.