Struct ClientOptions

pub struct ClientOptions {
    pub keypair: Option<Keypair>,
    pub server_public_key: Option<Vec<u8>>,
    pub pattern: Option<String>,
}

Options used to create a new websocket client.

Fields

keypair: Option<Keypair>

Client static keypair.

server_public_key: Option<Vec<u8>>

Public key for the server to connect to.

pattern: Option<String>

Noise parameters pattern.

If no pattern is specified the default noise parameters pattern is used.

Implementations

impl ClientOptions

pub fn is_encrypted(&self) -> bool

Determine if this client expects to use an encrypted channel.

pub fn url(&self, server: &str) -> String

Build a connection URL for the given server.

This method appends the public key query string parameter necessary for connecting to the server.

pub fn params(&self) -> Result<NoiseParams>

Parse noise parameters from the pattern.

Trait Implementations

impl Default for ClientOptions

fn default() -> ClientOptions

Returns the “default value” for a type.