Struct scrypto::api::LockFlags

pub struct LockFlags {
    bits: u32,
}

Fields

bits: u32

Implementations

impl LockFlags

pub const MUTABLE: LockFlags = _

Allows the locked substate to be mutated

pub const UNMODIFIED_BASE: LockFlags = _

Checks that the substate locked is unmodified from the beginning of the transaction. This is used mainly for locking fees in vaults which requires this in order to be able to support rollbacks

pub const FORCE_WRITE: LockFlags = _

Forces a write of a substate even on a transaction failure Currently used for vault fees.

pub const fn empty() -> LockFlags

Returns an empty set of flags.

pub const fn all() -> LockFlags

Returns the set containing all flags.

pub const fn bits(&self) -> u32

Returns the raw value of the flags currently stored.

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

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

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

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

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.

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

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

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

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

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

Inserts the specified flags in-place.

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

Removes the specified flags in-place.

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

Toggles the specified flags in-place.

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

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

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

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.

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

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.

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

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.

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

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.

pub const fn complement(self) -> LockFlags

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.

impl LockFlags

pub fn read_only() -> LockFlags

Trait Implementations

impl Binary for LockFlags

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

Formats the value using the given formatter.

impl BitAnd for LockFlags

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

Returns the intersection between the two sets of flags.

type Output = LockFlags

The resulting type after applying the & operator.

impl BitAndAssign for LockFlags

fn bitand_assign(&mut self, other: LockFlags)

Disables all flags disabled in the set.

impl BitOr for LockFlags

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

Returns the union of the two sets of flags.

type Output = LockFlags

The resulting type after applying the | operator.

impl BitOrAssign for LockFlags

fn bitor_assign(&mut self, other: LockFlags)

Adds the set of flags.

impl BitXor for LockFlags

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

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

type Output = LockFlags

The resulting type after applying the ^ operator.

impl BitXorAssign for LockFlags

fn bitxor_assign(&mut self, other: LockFlags)

Toggles the set of flags.

impl<X> Categorize<X> for LockFlags

where X: CustomValueKind,

fn value_kind() -> ValueKind<X>

impl Clone for LockFlags

fn clone(&self) -> LockFlags

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for LockFlags

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

Formats the value using the given formatter.

impl<D, X> Decode<X, D> for LockFlags

where D: Decoder<X>, X: CustomValueKind,

fn decode_body_with_value_kind( decoder: &mut D, value_kind: ValueKind<X> ) -> Result<LockFlags, DecodeError>

Decodes the type from the decoder, which should match a preloaded value kind.

impl<C> Describe<C> for LockFlags

where C: CustomTypeKind<RustTypeId>,

const TYPE_ID: RustTypeId = _

The TYPE_ID should give a unique identifier for its SBOR schema type. An SBOR schema type capture details about the SBOR payload, how it should be interpreted, validated and displayed.

fn type_data() -> TypeData<C, RustTypeId>

Returns the local schema for the given type.

fn add_all_dependencies(aggregator: &mut TypeAggregator<C>)

For each type referenced in get_local_type_data, we need to ensure that the type and all of its own references get added to the aggregator.

impl<E, X> Encode<X, E> for LockFlags

where E: Encoder<X>, X: CustomValueKind,

fn encode_value_kind(&self, encoder: &mut E) -> Result<(), EncodeError>

Encodes the SBOR value’s kind to the encoder

fn encode_body(&self, encoder: &mut E) -> Result<(), EncodeError>

Encodes the SBOR body of the type to the encoder.

impl Extend<LockFlags> for LockFlags

fn extend<T>(&mut self, iterator: T)

where T: IntoIterator<Item = LockFlags>,

Extends a collection with the contents of an iterator.

fn extend_one(&mut self, item: A)

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

Extends a collection with exactly one element.

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

fn from_iter<T>(iterator: T) -> LockFlags

where T: IntoIterator<Item = LockFlags>,

Creates a value from an iterator.

impl Hash for LockFlags

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, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl LowerHex for LockFlags

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

Formats the value using the given formatter.

impl Not for LockFlags

fn not(self) -> LockFlags

Returns the complement of this set of flags.

type Output = LockFlags

The resulting type after applying the ! operator.

impl Octal for LockFlags

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

Formats the value using the given formatter.

impl Ord for LockFlags

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

This method returns an Ordering between self and other.

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

where Self: Sized,

Compares and returns the maximum of two values.

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

where Self: Sized,

Compares and returns the minimum of two values.

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

where Self: Sized + PartialOrd,

Restrict a value to a certain interval.

impl PartialEq for LockFlags

fn eq(&self, other: &LockFlags) -> 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 PartialOrd for LockFlags

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

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

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

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

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

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

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

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

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<X> SborTuple<X> for LockFlags

where X: CustomValueKind,

fn get_length(&self) -> usize

impl Sub for LockFlags

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

Returns the set difference of the two sets of flags.

type Output = LockFlags

The resulting type after applying the - operator.

impl SubAssign for LockFlags

fn sub_assign(&mut self, other: LockFlags)

Disables all flags enabled in the set.

impl UpperHex for LockFlags

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

Formats the value using the given formatter.

impl Copy for LockFlags

impl Eq for LockFlags

impl StructuralPartialEq for LockFlags