Struct koibumi_core::identity::Features

pub struct Features { /* fields omitted */ }

Public key bitfield features.

Implementations

impl Features

pub const ONION_ROUTER: Features

Node can be used to onion-route messages.

pub const FORWARD_SECRECY: Features

Receiving node supports a forward secrecy encryption extension.

pub const EXTENDED_ENCODING: Features

Receiving node supports extended encoding.

pub const INCLUDE_DESTINATION: Features

Supports simple recipient verification.

pub const DOES_ACK: Features

If true, the receiving node does send acknowledgements (rather than dropping them).

pub const fn empty() -> Features

Returns an empty set of flags

pub const fn all() -> Features

Returns the set containing all flags.

pub const fn bits(&self) -> u32

Returns the raw value of the flags currently stored.

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

Convert from underlying bit representation, unless that representation contains bits that do not correspond to a flag.

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

Convert from underlying bit representation, dropping any bits that do not correspond to flags.

pub const unsafe fn from_bits_unchecked(bits: u32) -> Features

Convert from underlying bit representation, preserving all bits (even those not corresponding to a defined flag).

pub const fn is_empty(&self) -> bool

Returns true if no flags are currently stored.

pub const fn is_all(&self) -> bool

Returns true if all flags are currently set.

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

Returns true if there are flags common to both self and other.

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

Returns true all of the flags in other are contained within self.

pub fn insert(&mut self, other: Features)

Inserts the specified flags in-place.

pub fn remove(&mut self, other: Features)

Removes the specified flags in-place.

pub fn toggle(&mut self, other: Features)

Toggles the specified flags in-place.

pub fn set(&mut self, other: Features, value: bool)

Inserts or removes the specified flags depending on the passed value.

impl Features

pub fn from_bits_direct(bits: u32) -> Self

Creates features from bits directly.

Trait Implementations

impl Binary for Features

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

Formats the value using the given formatter.

impl BitAnd<Features> for Features

type Output = Features

The resulting type after applying the & operator.

pub fn bitand(self, other: Features) -> Features

Returns the intersection between the two sets of flags.

impl BitAndAssign<Features> for Features

pub fn bitand_assign(&mut self, other: Features)

Disables all flags disabled in the set.

impl BitOr<Features> for Features

type Output = Features

The resulting type after applying the | operator.

pub fn bitor(self, other: Features) -> Features

Returns the union of the two sets of flags.

impl BitOrAssign<Features> for Features

pub fn bitor_assign(&mut self, other: Features)

Adds the set of flags.

impl BitXor<Features> for Features

type Output = Features

The resulting type after applying the ^ operator.

pub fn bitxor(self, other: Features) -> Features

Returns the left flags, but with all the right flags toggled.

impl BitXorAssign<Features> for Features

pub fn bitxor_assign(&mut self, other: Features)

Toggles the set of flags.

impl Clone for Features

pub fn clone(&self) -> Features

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Copy for Features

impl Debug for Features

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

Formats the value using the given formatter.

impl Eq for Features

impl Extend<Features> for Features

pub fn extend<T: IntoIterator<Item = Features>>(&mut self, iterator: T)

Extends a collection with the contents of an iterator.

pub fn extend_one(&mut self, item: A)

🔬 This is a nightly-only experimental API. (extend_one)

Extends a collection with exactly one element.

pub fn extend_reserve(&mut self, additional: usize)

🔬 This is a nightly-only experimental API. (extend_one)

Reserves capacity in a collection for the given number of additional elements.

impl FromIterator<Features> for Features

pub fn from_iter<T: IntoIterator<Item = Features>>(iterator: T) -> Features

Creates a value from an iterator.

impl Hash for Features

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

Feeds this value into the given Hasher.

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

Feeds a slice of this type into the given Hasher.

impl LowerHex for Features

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

Formats the value using the given formatter.

impl Not for Features

type Output = Features

The resulting type after applying the ! operator.

pub fn not(self) -> Features

Returns the complement of this set of flags.

impl Octal for Features

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

Formats the value using the given formatter.

impl Ord for Features

pub fn cmp(&self, other: &Features) -> Ordering

This method returns an Ordering between self and other.

#[must_use]pub fn max(self, other: Self) -> Self

Compares and returns the maximum of two values.

#[must_use]pub fn min(self, other: Self) -> Self

Compares and returns the minimum of two values.

#[must_use]pub fn clamp(self, min: Self, max: Self) -> Self

Restrict a value to a certain interval.

impl PartialEq<Features> for Features

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

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

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

This method tests for !=.

impl PartialOrd<Features> for Features

pub fn partial_cmp(&self, other: &Features) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

pub fn lt(&self, other: &Features) -> bool

This method tests less than (for self and other) and is used by the < operator.

pub fn le(&self, other: &Features) -> bool

This method tests less than or equal to (for self and other) and is used by the <= operator.

pub fn gt(&self, other: &Features) -> bool

This method tests greater than (for self and other) and is used by the > operator.

pub fn ge(&self, other: &Features) -> bool

This method tests greater than or equal to (for self and other) and is used by the >= operator.

impl ReadFrom for Features

pub fn read_from(r: &mut dyn Read) -> Result<Self> where
    Self: Sized, 

Reads this object as a Bitmessage entity from a reader.

impl StructuralEq for Features

impl StructuralPartialEq for Features

impl Sub<Features> for Features

type Output = Features

The resulting type after applying the - operator.

pub fn sub(self, other: Features) -> Features

Returns the set difference of the two sets of flags.

impl SubAssign<Features> for Features

pub fn sub_assign(&mut self, other: Features)

Disables all flags enabled in the set.

impl UpperHex for Features

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

Formats the value using the given formatter.

impl WriteTo for Features

pub fn write_to(&self, w: &mut dyn Write) -> Result<()>

Writes this object as a Bitmessage entity to a writer.