Struct sp_runtime::offchain::Capabilities

source · [−]

pub struct Capabilities { /* private fields */ }

Expand description

Execution context extra capabilities.

Implementations

source

impl Capabilities

source

pub fn rich_offchain_call() -> Capabilities

Return capabilities for rich offchain calls.

Those calls should be allowed to sign and submit transactions and access offchain workers database (but read only!).

source

impl Capabilities

source

pub const TRANSACTION_POOL: Capabilities

Access to transaction pool.

source

pub const KEYSTORE: Capabilities

Keystore access.

source

pub const RANDOMNESS: Capabilities

Randomness source.

source

pub const NETWORK_STATE: Capabilities

Access to opaque network state.

source

pub const OFFCHAIN_DB_READ: Capabilities

Access to offchain worker DB (read only).

source

pub const OFFCHAIN_DB_WRITE: Capabilities

Access to offchain worker DB (writes).

source

pub const NODE_AUTHORIZATION: Capabilities

Manage the authorized nodes

source

pub const fn empty() -> Capabilities

Returns an empty set of flags.

source

pub const fn all() -> Capabilities

Returns the set containing all flags.

source

pub const fn bits(&self) -> u32

Returns the raw value of the flags currently stored.

source

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

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

source

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

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

source

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

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

Safety

The caller of the bitflags! macro can chose to allow or disallow extra bits for their bitflags type.

The caller of from_bits_unchecked() has to ensure that all bits correspond to a defined flag or that extra bits are valid for this bitflags type.

source

pub const fn is_empty(&self) -> bool

Returns true if no flags are currently stored.

source

pub const fn is_all(&self) -> bool

Returns true if all flags are currently set.

source

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

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

source

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

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

source

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

Inserts the specified flags in-place.

source

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

Removes the specified flags in-place.

source

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

Toggles the specified flags in-place.

source

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

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

source

pub const fn intersection(self, other: Capabilities) -> Capabilities

Returns the intersection between the flags in self and other.

Specifically, the returned set contains only the flags which are present in both self and other.

This is equivalent to using the & operator (e.g. ops::BitAnd), as in flags & other.

source

pub const fn union(self, other: Capabilities) -> Capabilities

Returns the union of between the flags in self and other.

Specifically, the returned set contains all flags which are present in either self or other, including any which are present in both (see Self::symmetric_difference if that is undesirable).

This is equivalent to using the | operator (e.g. ops::BitOr), as in flags | other.

source

pub const fn difference(self, other: Capabilities) -> Capabilities

Returns the difference between the flags in self and other.

Specifically, the returned set contains all flags present in self, except for the ones present in other.

It is also conceptually equivalent to the “bit-clear” operation: flags & !other (and this syntax is also supported).

This is equivalent to using the - operator (e.g. ops::Sub), as in flags - other.

source

pub const fn symmetric_difference(self, other: Capabilities) -> Capabilities

Returns the symmetric difference between the flags in self and other.

Specifically, the returned set contains the flags present which are present in self or other, but that are not present in both. Equivalently, it contains the flags present in exactly one of the sets self and other.

This is equivalent to using the ^ operator (e.g. ops::BitXor), as in flags ^ other.

source

pub const fn complement(self) -> Capabilities

Returns the complement of this set of flags.

Specifically, the returned set contains all the flags which are not set in self, but which are allowed for this type.

Alternatively, it can be thought of as the set difference between Self::all() and self (e.g. Self::all() - self)

This is equivalent to using the ! operator (e.g. ops::Not), as in !flags.

Trait Implementations

source

impl Binary for Capabilities

source

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

Formats the value using the given formatter.

source

impl BitAnd<Capabilities> for Capabilities

source

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

Returns the intersection between the two sets of flags.

type Output = Capabilities

The resulting type after applying the & operator.

source

impl BitAndAssign<Capabilities> for Capabilities

source

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

Disables all flags disabled in the set.

source

impl BitOr<Capabilities> for Capabilities

source

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

Returns the union of the two sets of flags.

type Output = Capabilities

The resulting type after applying the | operator.

source

impl BitOrAssign<Capabilities> for Capabilities

source

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

Adds the set of flags.

source

impl BitXor<Capabilities> for Capabilities

source

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

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

type Output = Capabilities

The resulting type after applying the ^ operator.

source

impl BitXorAssign<Capabilities> for Capabilities

source

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

Toggles the set of flags.

source

impl Clone for Capabilities

source

pub fn clone(&self) -> Capabilities

Returns a copy of the value. Read more

1.0.0 · source

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

Performs copy-assignment from source. Read more

source

impl Debug for Capabilities

source

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

Formats the value using the given formatter. Read more

source

impl Extend<Capabilities> for Capabilities

source

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

Extends a collection with the contents of an iterator. Read more

source

fn extend_one(&mut self, item: A)

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

Extends a collection with exactly one element.

source

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. Read more

source

impl FromIterator<Capabilities> for Capabilities

source

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

Creates a value from an iterator. Read more

source

impl Hash for Capabilities

source

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

Feeds this value into the given Hasher. Read more

1.3.0 · source

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

Feeds a slice of this type into the given Hasher. Read more

source

impl LowerHex for Capabilities

source

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

Formats the value using the given formatter.

source

impl Not for Capabilities

source

pub fn not(self) -> Capabilities

Returns the complement of this set of flags.

type Output = Capabilities

The resulting type after applying the ! operator.

source

impl Octal for Capabilities

source

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

Formats the value using the given formatter.

source

impl Ord for Capabilities

source

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

This method returns an Ordering between self and other. Read more

1.21.0 · source

fn max(self, other: Self) -> Self

Compares and returns the maximum of two values. Read more

1.21.0 · source

fn min(self, other: Self) -> Self

Compares and returns the minimum of two values. Read more

1.50.0 · source

fn clamp(self, min: Self, max: Self) -> Self

Restrict a value to a certain interval. Read more

source

impl PartialEq<Capabilities> for Capabilities

source

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

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

source

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

This method tests for !=.

source

impl PartialOrd<Capabilities> for Capabilities

source

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

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

1.0.0 · source

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

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

1.0.0 · source

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

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

1.0.0 · source

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

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

1.0.0 · source

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

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

source

impl Sub<Capabilities> for Capabilities

source

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

Returns the set difference of the two sets of flags.

type Output = Capabilities

The resulting type after applying the - operator.

source

impl SubAssign<Capabilities> for Capabilities

source

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

Disables all flags enabled in the set.

source

impl UpperHex for Capabilities

source

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

Formats the value using the given formatter.

source

impl StructuralPartialEq for Capabilities

Auto Trait Implementations

impl RefUnwindSafe for Capabilities

impl Send for Capabilities

impl Sync for Capabilities

impl Unpin for Capabilities

impl UnwindSafe for Capabilities

Blanket Implementations

source

impl<T> Any for T where
T: 'static + ?Sized,

source

pub fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more

source

impl<T> Borrow<T> for T where
T: ?Sized,

const: unstable · source

pub fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

source

impl<T> BorrowMut<T> for T where
T: ?Sized,

const: unstable · source

pub fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more

source

impl<T> CallHasher for T where
T: Hash + ?Sized,

source

pub default fn get_hash<H, B>(value: &H, build_hasher: &B) -> u64 where
H: Hash + ?Sized,
B: BuildHasher,

source

impl<T> CheckedConversion for T

source

fn checked_from<T>(t: T) -> Option<Self> where
Self: TryFrom<T>,

Convert from a value of T into an equivalent instance of Option<Self>. Read more

source

fn checked_into<T>(self) -> Option<T> where
Self: TryInto<T>,

Consume self to return Some equivalent value of Option<T>. Read more

source

impl<T> Downcast for T where
T: Any,

source

pub fn into_any(self: Box<T, Global>) -> Box<dyn Any + 'static, Global>ⓘ
Notable traits for Box<W, Global>
`impl<W> Write for Box<W, Global> where W: Write + ?Sized, impl<R> Read for Box<R, Global> where R: Read + ?Sized, impl<I, A> Iterator for Box<I, A> where I: Iterator + ?Sized, A: Allocator, type Item = ::Item;impl<F, A> Future for Box<F, A> where F: Future + Unpin + ?Sized, A: Allocator + 'static, type Output = <F as Future>::Output;`

Convert Box<dyn Trait> (where Trait: Downcast) to Box<dyn Any>. Box<dyn Any> can then be further downcast into Box<ConcreteType> where ConcreteType implements Trait. Read more

source

pub fn into_any_rc(self: Rc<T>) -> Rc<dyn Any + 'static>

Convert Rc<Trait> (where Trait: Downcast) to Rc<Any>. Rc<Any> can then be further downcast into Rc<ConcreteType> where ConcreteType implements Trait. Read more

source

pub fn as_any(&self) -> &(dyn Any + 'static)

Convert &Trait (where Trait: Downcast) to &Any. This is needed since Rust cannot generate &Any’s vtable from &Trait’s. Read more

source

pub fn as_any_mut(&mut self) -> &mut (dyn Any + 'static)

Convert &mut Trait (where Trait: Downcast) to &Any. This is needed since Rust cannot generate &mut Any’s vtable from &mut Trait’s. Read more

source

impl<T> DowncastSync for T where
T: Any + Send + Sync,

source

pub fn into_any_arc(self: Arc<T>) -> Arc<dyn Any + Sync + Send + 'static>

Convert Arc<Trait> (where Trait: Downcast) to Arc<Any>. Arc<Any> can then be further downcast into Arc<ConcreteType> where ConcreteType implements Trait. Read more

source