Struct ClientOptions

pub struct ClientOptions { /* private fields */ }

Options

Implementations

impl ClientOptions

pub fn new() -> Self

Create new default options

pub fn autoconnect(self, val: bool) -> Self

Automatically start connection with relays (default: false)

When set to true, there isn’t the need of calling the connect methods.

pub fn min_pow(self, _difficulty: u8) -> Self

👎Deprecated since 0.40.0: This no longer works, please use AdmitPolicy instead.

Minimum POW difficulty for received events (default: 0)

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

👎Deprecated since 0.39.0

REQ filters chunk size (default: 10)

pub fn automatic_authentication(self, enabled: bool) -> Self

Auto authenticate to relays (default: true)

https://github.com/nostr-protocol/nips/blob/master/42.md

pub fn gossip(self, enable: bool) -> Self

Enable gossip model (default: false)

pub fn connection(self, connection: Connection) -> Self

Available on non-WebAssembly only.

Connection mode and target

pub fn relay_limits(self, limits: RelayLimits) -> Self

Set relay limits

pub fn max_avg_latency(self, max: Duration) -> Self

Set max latency (default: None)

Relays with an avg. latency greater that this value will be skipped.

pub fn sleep_when_idle(self, config: SleepWhenIdle) -> Self

Set sleep when idle config

pub fn notification_channel_size(self, size: usize) -> Self

👎Deprecated since 0.42.0: Use Options::pool instead.

Notification channel size (default: DEFAULT_NOTIFICATION_CHANNEL_SIZE)

pub fn verify_subscriptions(self, enable: bool) -> Self

Verify that received events belong to a subscription and match the filter.

pub fn ban_relay_on_mismatch(self, ban_relay: bool) -> Self

If true, ban a relay when it sends an event that doesn’t match the subscription filter.

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

Set relay pool options

Trait Implementations

impl Clone for ClientOptions

fn clone(&self) -> ClientOptions

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ClientOptions

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

Formats the value using the given formatter.

impl Default for ClientOptions

fn default() -> ClientOptions

Returns the “default value” for a type.