Struct nostr_types::RelayUsageSet

pub struct RelayUsageSet(/* private fields */);

The ways that a user uses a Relay

Implementations

impl RelayUsageSet

pub const fn new_empty() -> Self

Create a new empty RelayUsageSet

pub const fn new_all() -> Self

Create a new RelayUsageSet with all usages

pub const fn bits(&self) -> u32

Get the u32 bitflag representation

pub const fn from_bits(bits: u32) -> Option<RelayUsageSet>

Set from a u32 bitflag representation. If any unknown bits are set, this will return None

pub const fn from_bits_truncate(bits: u32) -> RelayUsageSet

Set from a u32 bitflag representation. If any unknown bits are set, they will be cleared

pub const fn is_empty(&self) -> bool

Whether all bits are unset

pub const fn is_all(&self) -> bool

Whether all defined bits are set

pub const fn intersects(&self, other: Self) -> bool

Whether any usage in other is also in Self

pub const fn contains(&self, other: Self) -> bool

Whether all usages in other are in Self

pub fn has_usage(&mut self, ru: RelayUsage) -> bool

Has a RelayUsage set

pub fn add_usage(&mut self, ru: RelayUsage)

Add a RelayUsage to Self

pub fn remove_usage(&mut self, ru: RelayUsage)

Remove a RelayUsage to Self

Trait Implementations

impl Clone for RelayUsageSet

fn clone(&self) -> RelayUsageSet

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for RelayUsageSet

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

Formats the value using the given formatter.

impl Default for RelayUsageSet

fn default() -> RelayUsageSet

Returns the “default value” for a type.

impl Hash for RelayUsageSet

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl PartialEq for RelayUsageSet

fn eq(&self, other: &RelayUsageSet) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Copy for RelayUsageSet

impl Eq for RelayUsageSet

impl StructuralPartialEq for RelayUsageSet