Struct psk_client::builder::PskClientBuilder

pub struct PskClientBuilder<'a, H: ToSocketAddrs> { /* fields omitted */ }

The builder for a PSK client, somewhat simplifies creating a new PSK client and makes it more ergonomic.

Methods

impl<'a, H: ToSocketAddrs> PskClientBuilder<'a, H>

pub fn new(host: H) -> Self

Create a new PskClientBuilder with the default cipher list, a None identity and an empty key.

pub fn build(self) -> Result<PskClient, PskClientError>

Returns a new PskClient which can be used to

use psk_client::PskClient;
use std::io::Write;

if let Ok(client) = PskClient::builder("127.0.0.1:4433")
    .identity("some-client")
    .key("1A2B3C4D")
    .build()
{
    if let Ok(mut connection) = client.connect() {
        connection.write_all(b"oing").unwrap();
    }
}

#[must_use]

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

Sets the identity to use for this session. This is required.

use psk_client::PskClient;
let builder = PskClient::builder("127.0.0.1:4433")
    .identity("some-client");

#[must_use]

pub fn key<K: AsRef<[u8]>>(self, key: K) -> Self

Sets the key to use for this session. Must be valid hex, if not this function will panic. This is required.

use psk_client::PskClient;
let builder = PskClient::builder("127.0.0.1:4433")
    .key("1A2B3C4D");

pub fn cipher(self, cipher: &'a str) -> Self

Adds a given cipher to the list of ciphers to send to the server

use psk_client::PskClient;
let builder = PskClient::builder("127.0.0.1:4433")
    .cipher("PSK-AES256-CBC-SHA");

pub fn reset_ciphers(self) -> Self

Clears the current list of ciphers, which are initialised with a default PSK set.

use psk_client::PskClient;
let builder = PskClient::builder("127.0.0.1:4433")
    .reset_ciphers();

Trait Implementations

impl<'a, H: PartialEq + ToSocketAddrs> PartialEq<PskClientBuilder<'a, H>> for PskClientBuilder<'a, H>

fn eq(&self, other: &PskClientBuilder<'a, H>) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &PskClientBuilder<'a, H>) -> bool

This method tests for !=.

impl<'a, H: Clone + ToSocketAddrs> Clone for PskClientBuilder<'a, H>

fn clone(&self) -> PskClientBuilder<'a, H>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<'a, H: Debug + ToSocketAddrs> Debug for PskClientBuilder<'a, H>

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

Formats the value using the given formatter.