Struct sc_service::Roles

pub struct Roles { /* fields omitted */ }

Bitmask of the roles that a node fulfills.

Methods

impl Roles

pub fn is_full(&self) -> bool

Does this role represents a client that holds full chain data locally?

pub fn is_authority(&self) -> bool

Does this role represents a client that does not participates in the consensus?

pub fn is_light(&self) -> bool

Does this role represents a client that does not hold full chain data locally?

impl Roles

pub const NONE: Roles

No network.

pub const FULL: Roles

Full node, does not participate in consensus.

pub const LIGHT: Roles

Light client node.

pub const AUTHORITY: Roles

Act as an authority

pub const fn empty() -> Roles

Returns an empty set of flags

pub const fn all() -> Roles

Returns the set containing all flags.

pub const fn bits(&self) -> u8

Returns the raw value of the flags currently stored.

pub fn from_bits(bits: u8) -> Option<Roles>

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

pub const fn from_bits_truncate(bits: u8) -> Roles

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

pub const unsafe fn from_bits_unchecked(bits: u8) -> Roles

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: Roles) -> bool

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

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

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

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

Inserts the specified flags in-place.

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

Removes the specified flags in-place.

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

Toggles the specified flags in-place.

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

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

Trait Implementations

impl Binary for Roles

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

Formats the value using the given formatter.

impl BitAnd<Roles> for Roles

type Output = Roles

The resulting type after applying the & operator.

fn bitand(self, other: Roles) -> Roles

Returns the intersection between the two sets of flags.

impl BitAndAssign<Roles> for Roles

fn bitand_assign(&mut self, other: Roles)

Disables all flags disabled in the set.

impl BitOr<Roles> for Roles

type Output = Roles

The resulting type after applying the | operator.

fn bitor(self, other: Roles) -> Roles

Returns the union of the two sets of flags.

impl BitOrAssign<Roles> for Roles

fn bitor_assign(&mut self, other: Roles)

Adds the set of flags.

impl BitXor<Roles> for Roles

type Output = Roles

The resulting type after applying the ^ operator.

fn bitxor(self, other: Roles) -> Roles

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

impl BitXorAssign<Roles> for Roles

fn bitxor_assign(&mut self, other: Roles)

Toggles the set of flags.

impl Clone for Roles

fn clone(&self) -> Roles

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Copy for Roles

impl Debug for Roles

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

Formats the value using the given formatter.

impl Decode for Roles

fn decode<I>(input: &mut I) -> Result<Roles, Error> where
    I: Input, 

Attempt to deserialise the value from input.

impl Display for Roles

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

Formats the value using the given formatter.

impl Encode for Roles

fn encode_to<T>(&self, dest: &mut T) where
    T: Output, 

Convert self to a slice and append it to the destination.

fn size_hint(&self) -> usize

If possible give a hint of expected size of the encoding.

fn encode(&self) -> Vec<u8>

Convert self to an owned vector.

fn using_encoded<R, F>(&self, f: F) -> R where
    F: FnOnce(&[u8]) -> R, 

Convert self to a slice and then invoke the given closure with it.

impl EncodeLike<Roles> for Roles

impl Eq for Roles

impl Extend<Roles> for Roles

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

Extends a collection with the contents of an iterator.

impl FromIterator<Roles> for Roles

fn from_iter<T>(iterator: T) -> Roles where
    T: IntoIterator<Item = Roles>, 

Creates a value from an iterator.

impl Hash for Roles

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

Feeds this value into the given [Hasher].

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 Roles

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

Formats the value using the given formatter.

impl Not for Roles

type Output = Roles

The resulting type after applying the ! operator.

fn not(self) -> Roles

Returns the complement of this set of flags.

impl Octal for Roles

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

Formats the value using the given formatter.

impl Ord for Roles

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

This method returns an [Ordering] between self and other.

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

Compares and returns the maximum of two values.

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

Compares and returns the minimum of two values.

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

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

Restrict a value to a certain interval.

impl PartialEq<Roles> for Roles

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

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

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

This method tests for !=.

impl PartialOrd<Roles> for Roles

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

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

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

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

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

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

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

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

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

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

impl StructuralEq for Roles

impl StructuralPartialEq for Roles

impl Sub<Roles> for Roles

type Output = Roles

The resulting type after applying the - operator.

fn sub(self, other: Roles) -> Roles

Returns the set difference of the two sets of flags.

impl SubAssign<Roles> for Roles

fn sub_assign(&mut self, other: Roles)

Disables all flags enabled in the set.

impl UpperHex for Roles

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

Formats the value using the given formatter.