Struct nostr_sdk::client::options::Options

pub struct Options {
    pub wait_for_connection: bool,
    pub timeout: Duration,
    pub send_timeout: Option<Duration>,
    pub nip46_timeout: Option<Duration>,
    pub shutdown_on_drop: bool,
    pub pool: RelayPoolOptions,
    /* private fields */
}

Options

Fields

wait_for_connection: bool

Wait for connection (default: false)

timeout: Duration

Timeout (default: 60)

Used in get_events_of, req_events_of and similar as default timeout.

send_timeout: Option<Duration>

Send timeout (default: 20 secs)

nip46_timeout: Option<Duration>

NIP46 timeout (default: 180 secs)

shutdown_on_drop: bool

Shutdown on Client drop

pool: RelayPoolOptions

Pool Options

Implementations

impl Options

pub fn new() -> Self

Create new (default) Options

pub fn wait_for_connection(self, wait: bool) -> Self

If set to true, Client wait that Relay try at least one time to enstablish a connection before continue.

pub fn wait_for_send(self, wait: bool) -> Self

If set to true, Client wait that a message is sent before continue.

pub fn wait_for_subscription(self, wait: bool) -> Self

If set to true, Client wait that a subscription msg is sent before continue (subscribe and unsubscribe methods)

pub fn difficulty(self, difficulty: u8) -> Self

Set default POW diffficulty for Event

pub fn req_filters_chunk_size(self, size: u8) -> Self

Set REQ filters chunk size

pub fn skip_disconnected_relays(self, skip: bool) -> Self

Skip disconnected relays during send methods (default: false)

If the relay made just 1 attempt, the relay will not be skipped

pub fn timeout(self, timeout: Duration) -> Self

Set default timeout

pub fn send_timeout(self, timeout: Option<Duration>) -> Self

Set default send timeout

pub fn nip46_timeout(self, timeout: Option<Duration>) -> Self

Set NIP46 timeout

pub fn shutdown_on_drop(self, value: bool) -> Self

Shutdown client on drop

pub fn pool(self, opts: RelayPoolOptions) -> Self

Set pool options

Trait Implementations

impl Clone for Options

fn clone(&self) -> Options

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Options

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

Formats the value using the given formatter.

impl Default for Options

fn default() -> Self

Returns the “default value” for a type.