Struct noble_contracts::chain_extension::ReturnFlags

pub struct ReturnFlags { /* fields omitted */ }

Flags used by a contract to customize exit behaviour.

Implementations

impl ReturnFlags

pub const REVERT: ReturnFlags

If this bit is set all changes made by the contract execution are rolled back.

pub const fn empty() -> ReturnFlags

Returns an empty set of flags

pub const fn all() -> ReturnFlags

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<ReturnFlags>

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) -> ReturnFlags

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

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

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

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

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

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

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

Inserts the specified flags in-place.

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

Removes the specified flags in-place.

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

Toggles the specified flags in-place.

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

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

Trait Implementations

impl Binary for ReturnFlags

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

Formats the value using the given formatter.

impl BitAnd<ReturnFlags> for ReturnFlags

type Output = ReturnFlags

The resulting type after applying the & operator.

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

Returns the intersection between the two sets of flags.

impl BitAndAssign<ReturnFlags> for ReturnFlags

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

Disables all flags disabled in the set.

impl BitOr<ReturnFlags> for ReturnFlags

type Output = ReturnFlags

The resulting type after applying the | operator.

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

Returns the union of the two sets of flags.

impl BitOrAssign<ReturnFlags> for ReturnFlags

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

Adds the set of flags.

impl BitXor<ReturnFlags> for ReturnFlags

type Output = ReturnFlags

The resulting type after applying the ^ operator.

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

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

impl BitXorAssign<ReturnFlags> for ReturnFlags

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

Toggles the set of flags.

impl Clone for ReturnFlags

pub fn clone(&self) -> ReturnFlags

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Copy for ReturnFlags

impl Debug for ReturnFlags

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

Formats the value using the given formatter.

impl Decode for ReturnFlags

pub fn decode<__CodecInputEdqy>(
    __codec_input_edqy: &mut __CodecInputEdqy
) -> Result<ReturnFlags, Error> where
    __CodecInputEdqy: Input, 

Attempt to deserialise the value from input.

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

Attempt to skip the encoded value from input.

pub fn encoded_fixed_size() -> Option<usize>

Returns the fixed encoded size of the type.

impl Encode for ReturnFlags

pub fn encode_to<__CodecOutputEdqy>(
    &self,
    __codec_dest_edqy: &mut __CodecOutputEdqy
) where
    __CodecOutputEdqy: Output + ?Sized, 

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

pub fn encode(&self) -> Vec<u8, Global>

Convert self to an owned vector.

pub 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.

pub fn size_hint(&self) -> usize

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

pub fn encoded_size(&self) -> usize

Calculates the encoded size.

impl EncodeLike<ReturnFlags> for ReturnFlags

impl Eq for ReturnFlags

impl Extend<ReturnFlags> for ReturnFlags

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

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<ReturnFlags> for ReturnFlags

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

Creates a value from an iterator.

impl Hash for ReturnFlags

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

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 ReturnFlags

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

Formats the value using the given formatter.

impl Not for ReturnFlags

type Output = ReturnFlags

The resulting type after applying the ! operator.

pub fn not(self) -> ReturnFlags

Returns the complement of this set of flags.

impl Octal for ReturnFlags

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

Formats the value using the given formatter.

impl Ord for ReturnFlags

pub fn cmp(&self, other: &ReturnFlags) -> 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<ReturnFlags> for ReturnFlags

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

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

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

This method tests for !=.

impl PartialOrd<ReturnFlags> for ReturnFlags

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

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

#[must_use]pub fn lt(&self, other: &Rhs) -> bool

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

#[must_use]pub fn le(&self, other: &Rhs) -> bool

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

#[must_use]pub fn gt(&self, other: &Rhs) -> bool

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

#[must_use]pub fn ge(&self, other: &Rhs) -> bool

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

impl StructuralEq for ReturnFlags

impl StructuralPartialEq for ReturnFlags

impl Sub<ReturnFlags> for ReturnFlags

type Output = ReturnFlags

The resulting type after applying the - operator.

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

Returns the set difference of the two sets of flags.

impl SubAssign<ReturnFlags> for ReturnFlags

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

Disables all flags enabled in the set.

impl UpperHex for ReturnFlags

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

Formats the value using the given formatter.