Struct ClientBuilder 

pub struct ClientBuilder { /* private fields */ }

ClientBuilder constructs and connects a NWEP Client.

Use new to start with defaults, configure the connection with builder methods, then call connect to establish the QUIC session.

Implementations

impl ClientBuilder

pub fn new() -> Self

new creates a ClientBuilder with default Settings and no notification handler.

Examples found in repository

examples/client.rs (line 29)

fn main() {
    let url = std::env::args().nth(1).unwrap_or_else(|| {
        eprintln!("usage: client <web://url/path>");
        process::exit(1);
    });

    nwep::init().unwrap_or_else(|e| {
        eprintln!("init: {e}");
        process::exit(1);
    });

    nwep::log::set_level(nwep::log::LogLevel::Warn);
    nwep::log::set_stderr(true);

    let parsed = Url::parse(&url).unwrap_or_else(|e| {
        eprintln!("parse url: {e}");
        process::exit(1);
    });
    let path = if parsed.path.is_empty() { "/".to_string() } else { parsed.path.clone() };

    let keypair = Keypair::generate().unwrap_or_else(|e| {
        eprintln!("keygen: {e}");
        process::exit(1);
    });

    let client = ClientBuilder::new()
        .connect(keypair, &url)
        .unwrap_or_else(|e| {
            eprintln!("connect: {e}");
            process::exit(1);
        });

    let resp = client.get(&path).unwrap_or_else(|e| {
        eprintln!("get: {e}");
        process::exit(1);
    });

    println!("{}", resp.status);
    println!("{}", String::from_utf8_lossy(&resp.body));

    client.close();
}

pub fn settings(self, s: Settings) -> Self

settings overrides the transport-level settings for this connection.

pub fn on_notify<F: Fn(Notification) + Send + 'static>(self, f: F) -> Self

on_notify registers a callback to receive server-push Notification messages.

The callback is invoked on the event loop thread; it must not block or panic.

pub fn connect(self, keypair: Keypair, url: &str) -> Result<Client, Error>

connect initiates a connection to the given web:// URL and blocks until the QUIC + NWEP mutual-authentication handshake completes.

On success returns a Client handle ready for requests. On failure the event loop and socket threads are torn down automatically.

Errors

Returns Err if the URL is invalid, the socket cannot be bound, the C layer fails to initialise, or the handshake is rejected by the remote server.

Examples found in repository

examples/client.rs (line 30)

fn main() {
    let url = std::env::args().nth(1).unwrap_or_else(|| {
        eprintln!("usage: client <web://url/path>");
        process::exit(1);
    });

    nwep::init().unwrap_or_else(|e| {
        eprintln!("init: {e}");
        process::exit(1);
    });

    nwep::log::set_level(nwep::log::LogLevel::Warn);
    nwep::log::set_stderr(true);

    let parsed = Url::parse(&url).unwrap_or_else(|e| {
        eprintln!("parse url: {e}");
        process::exit(1);
    });
    let path = if parsed.path.is_empty() { "/".to_string() } else { parsed.path.clone() };

    let keypair = Keypair::generate().unwrap_or_else(|e| {
        eprintln!("keygen: {e}");
        process::exit(1);
    });

    let client = ClientBuilder::new()
        .connect(keypair, &url)
        .unwrap_or_else(|e| {
            eprintln!("connect: {e}");
            process::exit(1);
        });

    let resp = client.get(&path).unwrap_or_else(|e| {
        eprintln!("get: {e}");
        process::exit(1);
    });

    println!("{}", resp.status);
    println!("{}", String::from_utf8_lossy(&resp.body));

    client.close();
}

Trait Implementations

impl Default for ClientBuilder

fn default() -> Self

Returns the “default value” for a type.