Struct fabruic::Builder

pub struct Builder { /* fields omitted */ }

Helper for constructing an Endpoint.

Examples

use fabruic::{Builder, Store};

let mut builder = Builder::new();
builder.set_protocols([b"test".to_vec()]);
builder.set_store(Store::Os);
let endpoint = builder.build()?;

Implementations

impl Builder

pub fn new() -> Self

Builds a new Builder. See Builder methods for defaults.

Examples

use fabruic::Builder;

let mut endpoint = Builder::new().build()?;

pub fn set_address(&mut self, address: SocketAddr)

Set’s the SocketAddr to bind to.

Default

[::\]:0.

Examples

use fabruic::Builder;

let mut builder = Builder::new();
builder.set_address("[::1]:0".parse()?);

pub const fn address(&self) -> &SocketAddr

Returns the SocketAddr to bind to.

See set_address.

Examples

use fabruic::Builder;

let mut builder = Builder::new();

let address = "[::1]:0".parse()?;
builder.set_address(address);
assert_eq!(builder.address(), &address);

pub fn set_server_key_pair(&mut self, key_pair: Option<KeyPair>)

Set a server certificate KeyPair, use None to remove any server certificate.

Default

None.

Notes

Endpoint won’t listen to any incoming Connections without a server certificate.

Examples

use fabruic::{Builder, KeyPair};

let mut builder = Builder::new();
builder.set_server_key_pair(Some(KeyPair::new_self_signed("test")));

pub const fn server_key_pair(&self) -> &Option<KeyPair>

Returns the server certificate KeyPair.

See set_server_key_pair.

Examples

use fabruic::{Builder, KeyPair};

let mut builder = Builder::new();

let key_pair = KeyPair::new_self_signed("test");
builder.set_server_key_pair(Some(key_pair.clone()));
assert_eq!(builder.server_key_pair(), &Some(key_pair))

pub fn set_client_key_pair(&mut self, key_pair: Option<KeyPair>)

Set a client certificate KeyPair, use None to remove any client certificate.

Default

None.

Examples

use fabruic::{Builder, KeyPair};

let mut builder = Builder::new();
builder.set_client_key_pair(Some(KeyPair::new_self_signed("test")));

pub const fn client_key_pair(&self) -> &Option<KeyPair>

Returns the client certificate KeyPair.

See set_client_key_pair.

Examples

use fabruic::{Builder, KeyPair};

let mut builder = Builder::new();

let key_pair = KeyPair::new_self_signed("test");
builder.set_client_key_pair(Some(key_pair.clone()));
assert_eq!(builder.client_key_pair(), &Some(key_pair))

pub fn set_protocols<P: Into<Vec<Vec<u8>>>>(&mut self, protocols: P)

Set the protocols to accept, in order of descending preference. When set, clients which don’t declare support for at least one of the supplied protocols will be rejected.

See Connection::protocol.

Default

No protocols.

Examples

use fabruic::Builder;

let mut builder = Builder::new();
builder.set_protocols([b"test".to_vec()]);

pub fn protocols(&self) -> &[Vec<u8>]

Returns the set protocols.

See set_protocols.

Examples

use fabruic::Builder;

let mut builder = Builder::new();

let protocols = [b"test".to_vec()];
builder.set_protocols(protocols.clone());
assert_eq!(builder.protocols(), protocols)

pub fn set_trust_dns(&mut self, enable: bool)

This is supported on crate feature trust-dns only.

Controls the use of trust-dns for Endpoint::connect.

Default

true if the crate feature trust-dns is enabled.

Examples

use fabruic::Builder;

let mut builder = Builder::new();
builder.set_trust_dns(false);

pub fn disable_trust_dns(&mut self)

Disables the use of trust-dns for Endpoint::connect despite the activated crate feature.

Default

Not disabled if the crate feature trust-dns is enabled.

Examples

use fabruic::Builder;

let mut builder = Builder::new();
builder.disable_trust_dns();

pub const fn trust_dns(&self) -> bool

Returns if trust-dns is enabled.

See set_trust_dns or disable_trust_dns.

Examples

use fabruic::Builder;

let mut builder = Builder::new();

builder.set_trust_dns(true);
assert_eq!(builder.trust_dns(), true);

builder.disable_trust_dns();
assert_eq!(builder.trust_dns(), false);

pub fn set_dnssec(&mut self, enable: bool)

This is supported on crate feature trust-dns only.

Controls DNSSEC validation for trust-dns in Endpoint::connect. This doesn’t affect the ToSocketAddrs resolver.

Default

true.

Examples

use fabruic::Builder;

let mut builder = Builder::new();
builder.set_dnssec(false);

pub const fn dnssec(&self) -> bool

This is supported on crate feature trust-dns only.

Returns if DNSSEC is enabled for trust-dns.

See set_dnssec.

Examples

use fabruic::Builder;

let mut builder = Builder::new();

builder.set_dnssec(false);
assert_eq!(builder.dnssec(), false);

pub fn set_hosts_file(&mut self, enable: bool)

This is supported on crate feature trust-dns only.

Controls /etc/hosts file support for trust-dns in Endpoint::connect. This doesn’t affect the ToSocketAddrs resolver.

Default

false. Only affects UNIX like OS’s.

Examples

use fabruic::Builder;

let mut builder = Builder::new();
builder.set_hosts_file(false);

pub const fn hosts_file(&self) -> bool

This is supported on crate feature trust-dns only.

Returns if /etc/hosts file support is enabled for trust-dns.

See set_dnssec.

Examples

use fabruic::Builder;

let mut builder = Builder::new();

builder.set_hosts_file(true);
assert_eq!(builder.hosts_file(), true);

pub fn set_store(&mut self, store: Store)

Set’s the default root certificate store.

See Store for more details.

Default

Store::Embedded.

Examples

use fabruic::{Builder, Store};

let mut builder = Builder::new();
builder.set_store(Store::Os);

pub const fn store(&self) -> Store

Returns the set Store.

See set_store.

Examples

use fabruic::{Builder, Store};

let mut builder = Builder::new();

// default
assert_eq!(builder.store(), Store::Embedded);

builder.set_store(Store::Os);
assert_eq!(builder.store(), Store::Os);

builder.set_store(Store::Empty);
assert_eq!(builder.store(), Store::Empty);

pub fn set_max_idle_timeout(
    &mut self,
    time: Option<Duration>
) -> Result<(), Config>

Set’s the maximum idle timeout a client can have before getting automatically disconnected. Set None to disable automatic disconnecting completely.

Default

10s

Examples

use std::time::Duration;

use fabruic::{Builder, Store};

let mut builder = Builder::new();
builder.set_max_idle_timeout(Some(Duration::from_millis(1000)));

Errors

Config::MaxIdleTimeout if time exceeds 2^62 ms.

pub const fn max_idle_timeout(&self) -> Option<Duration>

Returns the set Duration specified for idle clients to automatically get disconnected. None means clients don’t get automatically disconnected.

See set_max_idle_timeout.

Examples

use std::time::Duration;

use fabruic::{Builder, Store};

let mut builder = Builder::new();

// default
assert_eq!(builder.max_idle_timeout(), Some(Duration::from_secs(10)));

builder.set_max_idle_timeout(None);
assert_eq!(builder.max_idle_timeout(), None);

builder.set_max_idle_timeout(Some(Duration::from_secs(30)));
assert_eq!(builder.max_idle_timeout(), Some(Duration::from_secs(30)));

pub fn build(self) -> Result<Endpoint, Builder>

Consumes Builder to build Endpoint. Must be called from inside a Tokio Runtime.

Errors

error::Builder if the socket couldn’t be bound to the given address.

Panics

• if the given KeyPairs or Certificates are invalid - can’t happen if they were properly validated through KeyPair::from_parts or Certificate::from_der
• if not called from inside a Tokio Runtime

Examples

use fabruic::Builder;

let endpoint = Builder::new().build()?;

Trait Implementations

impl Clone for Builder

fn clone(&self) -> Builder

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Dangerous for Builder

fn set_root_certificates<C: Into<Vec<Certificate>>>(
    builder: &mut Self,
    certificates: C
)

This is supported on crate feature dangerous only.

Set Certificates to be added into the root certificate store for connecting to a server. This is added additionally to the Store root certificates and does not replace them.

fn root_certificates(builder: &Self) -> &[Certificate]

This is supported on crate feature dangerous only.

Returns Certificates set to be added into the root certificate store.

impl Debug for Builder

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

Formats the value using the given formatter.

impl Default for Builder

fn default() -> Self

Returns the “default value” for a type.