Struct pubnub_hyper::Builder

pub struct Builder<TTransport = (), TRuntime = ()> { /* fields omitted */ }

PubNub Client Builder

Create a crate::PubNub client using the builder pattern. Optional items can be overridden using this.

Methods

impl<TTransport, TRuntime> Builder<TTransport, TRuntime> where
    TRuntime: Runtime,
    TTransport: Transport, 

#[must_use]pub fn build(self) -> PubNub<TTransport, TRuntime>

Build the PubNub client to begin streaming messages.

Example

use pubnub_core::mock::{runtime::MockRuntime, transport::MockTransport};
use pubnub_core::Builder;

let transport = MockTransport::new();
let runtime = MockRuntime::new();

let pubnub = Builder::with_components(transport, runtime).build();

impl<TTransport, TRuntime> Builder<TTransport, TRuntime>

#[must_use]pub fn with_components(
    transport: TTransport,
    runtime: TRuntime
) -> Builder<TTransport, TRuntime>

Create a new Builder that can configure a PubNub client with custom component implementations.

Example

use pubnub_core::mock::{runtime::MockRuntime, transport::MockTransport};
use pubnub_core::Builder;

let transport = MockTransport::new();
let runtime = MockRuntime::new();

let pubnub = Builder::with_components(transport, runtime).build();

#[must_use]pub fn subscribe_loop_exit_tx(
    self,
    tx: Sender<()>
) -> Builder<TTransport, TRuntime>

Set the subscribe loop exit tx.

If set, subscribe loop sends a message to it when it exits.

Example

use pubnub_core::Builder;

let (tx, _rx) = futures_channel::mpsc::channel(1);

let pubnub = Builder::with_components(transport, runtime)
    .subscribe_loop_exit_tx(tx)
    .build();

#[must_use]pub fn transport<U>(self, transport: U) -> Builder<U, TRuntime> where
    U: Transport, 

Set the transport to use.

This allows changing the [Transport] type on the builder and, therefore, on the resulting PubNub client.

#[must_use]pub fn runtime<U>(self, runtime: U) -> Builder<TTransport, U> where
    U: Runtime, 

Set the runtime to use.

This allows changing the [Runtime] type on the builder and, therefore, on the resulting PubNub client.

impl Builder<(), ()>

#[must_use]pub fn new() -> Builder<(), ()>

Create a new Builder that can configure a PubNub client.

Example

use pubnub_core::mock::{runtime::MockRuntime, transport::MockTransport};
use pubnub_core::Builder;

let transport = MockTransport::new();
let runtime = MockRuntime::new();

let pubnub = Builder::new().transport(transport).runtime(runtime).build();

Trait Implementations

impl<TTransport, TRuntime> Clone for Builder<TTransport, TRuntime> where
    TRuntime: Clone,
    TTransport: Clone, 

fn clone(&self) -> Builder<TTransport, TRuntime>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<TTransport, TRuntime> Debug for Builder<TTransport, TRuntime> where
    TRuntime: Debug,
    TTransport: Debug, 

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

Formats the value using the given formatter.

impl<TTransport, TRuntime> Default for Builder<TTransport, TRuntime> where
    TRuntime: Default,
    TTransport: Default, 

#[must_use]fn default() -> Builder<TTransport, TRuntime>

Create a new Builder that can configure a PubNub client with default components.