Struct casper_types::AccessRights
source · pub struct AccessRights { /* private fields */ }
Expand description
A struct which behaves like a set of bitflags to define access rights associated with a
URef
.
Implementations§
source§impl AccessRights
impl AccessRights
sourcepub const READ_WRITE: Self = _
pub const READ_WRITE: Self = _
Permission to read or write the value under the associated URef
.
sourcepub const ADD_WRITE: Self = _
pub const ADD_WRITE: Self = _
Permission to add to, or write the value under the associated URef
.
sourcepub const READ_ADD_WRITE: Self = _
pub const READ_ADD_WRITE: Self = _
Permission to read, add to, or write the value under the associated URef
.
sourcepub const fn from_bits(bits: u8) -> Option<Self>
pub const fn from_bits(bits: u8) -> Option<Self>
Convert from underlying bit representation, unless that representation contains bits that do not correspond to a flag.
sourcepub const fn from_bits_truncate(bits: u8) -> Self
pub const fn from_bits_truncate(bits: u8) -> Self
Convert from underlying bit representation, dropping any bits that do not correspond to flags.
sourcepub const unsafe fn from_bits_unchecked(bits: u8) -> Self
pub const unsafe fn from_bits_unchecked(bits: u8) -> Self
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.
sourcepub const fn intersects(&self, other: Self) -> bool
pub const fn intersects(&self, other: Self) -> bool
Returns true
if there are flags common to both self
and other
.
sourcepub const fn contains(&self, other: Self) -> bool
pub const fn contains(&self, other: Self) -> bool
Returns true
if all of the flags in other
are contained within self
.
sourcepub fn set(&mut self, other: Self, value: bool)
pub fn set(&mut self, other: Self, value: bool)
Inserts or removes the specified flags depending on the passed value.
sourcepub const fn intersection(self, other: Self) -> Self
pub const fn intersection(self, other: Self) -> Self
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
.
sourcepub const fn union(self, other: Self) -> Self
pub const fn union(self, other: Self) -> Self
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
.
sourcepub const fn difference(self, other: Self) -> Self
pub const fn difference(self, other: Self) -> Self
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
.
sourcepub const fn symmetric_difference(self, other: Self) -> Self
pub const fn symmetric_difference(self, other: Self) -> Self
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
.
sourcepub const fn complement(self) -> Self
pub const fn complement(self) -> Self
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
.
source§impl AccessRights
impl AccessRights
sourcepub fn is_readable(self) -> bool
pub fn is_readable(self) -> bool
Returns true
if the READ
flag is set.
sourcepub fn is_writeable(self) -> bool
pub fn is_writeable(self) -> bool
Returns true
if the WRITE
flag is set.
sourcepub fn is_addable(self) -> bool
pub fn is_addable(self) -> bool
Returns true
if the ADD
flag is set.
Trait Implementations§
source§impl Binary for AccessRights
impl Binary for AccessRights
source§impl BitAnd for AccessRights
impl BitAnd for AccessRights
source§impl BitAndAssign for AccessRights
impl BitAndAssign for AccessRights
source§fn bitand_assign(&mut self, other: Self)
fn bitand_assign(&mut self, other: Self)
Disables all flags disabled in the set.
source§impl BitOr for AccessRights
impl BitOr for AccessRights
source§fn bitor(self, other: AccessRights) -> Self
fn bitor(self, other: AccessRights) -> Self
Returns the union of the two sets of flags.
§type Output = AccessRights
type Output = AccessRights
|
operator.source§impl BitOrAssign for AccessRights
impl BitOrAssign for AccessRights
source§fn bitor_assign(&mut self, other: Self)
fn bitor_assign(&mut self, other: Self)
Adds the set of flags.
source§impl BitXor for AccessRights
impl BitXor for AccessRights
source§impl BitXorAssign for AccessRights
impl BitXorAssign for AccessRights
source§fn bitxor_assign(&mut self, other: Self)
fn bitxor_assign(&mut self, other: Self)
Toggles the set of flags.
source§impl Clone for AccessRights
impl Clone for AccessRights
source§fn clone(&self) -> AccessRights
fn clone(&self) -> AccessRights
1.0.0 · source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source
. Read moresource§impl Debug for AccessRights
impl Debug for AccessRights
source§impl Default for AccessRights
impl Default for AccessRights
source§impl<'de> Deserialize<'de> for AccessRights
impl<'de> Deserialize<'de> for AccessRights
source§fn deserialize<D: Deserializer<'de>>(deserializer: D) -> Result<Self, D::Error>
fn deserialize<D: Deserializer<'de>>(deserializer: D) -> Result<Self, D::Error>
source§impl Display for AccessRights
impl Display for AccessRights
source§impl Distribution<AccessRights> for Standard
impl Distribution<AccessRights> for Standard
source§fn sample<R: Rng + ?Sized>(&self, rng: &mut R) -> AccessRights
fn sample<R: Rng + ?Sized>(&self, rng: &mut R) -> AccessRights
T
, using rng
as the source of randomness.source§impl Extend<AccessRights> for AccessRights
impl Extend<AccessRights> for AccessRights
source§fn extend<T: IntoIterator<Item = Self>>(&mut self, iterator: T)
fn extend<T: IntoIterator<Item = Self>>(&mut self, iterator: T)
source§fn extend_one(&mut self, item: A)
fn extend_one(&mut self, item: A)
extend_one
)source§fn extend_reserve(&mut self, additional: usize)
fn extend_reserve(&mut self, additional: usize)
extend_one
)source§impl FromBytes for AccessRights
impl FromBytes for AccessRights
source§impl FromIterator<AccessRights> for AccessRights
impl FromIterator<AccessRights> for AccessRights
source§fn from_iter<T: IntoIterator<Item = Self>>(iterator: T) -> Self
fn from_iter<T: IntoIterator<Item = Self>>(iterator: T) -> Self
source§impl Hash for AccessRights
impl Hash for AccessRights
source§impl LowerHex for AccessRights
impl LowerHex for AccessRights
source§impl Not for AccessRights
impl Not for AccessRights
source§impl Octal for AccessRights
impl Octal for AccessRights
source§impl Ord for AccessRights
impl Ord for AccessRights
source§fn cmp(&self, other: &AccessRights) -> Ordering
fn cmp(&self, other: &AccessRights) -> Ordering
1.21.0 · source§fn max(self, other: Self) -> Selfwhere
Self: Sized,
fn max(self, other: Self) -> Selfwhere Self: Sized,
source§impl PartialEq for AccessRights
impl PartialEq for AccessRights
source§fn eq(&self, other: &AccessRights) -> bool
fn eq(&self, other: &AccessRights) -> bool
self
and other
values to be equal, and is used
by ==
.source§impl PartialOrd for AccessRights
impl PartialOrd for AccessRights
source§fn partial_cmp(&self, other: &AccessRights) -> Option<Ordering>
fn partial_cmp(&self, other: &AccessRights) -> Option<Ordering>
1.0.0 · source§fn le(&self, other: &Rhs) -> bool
fn le(&self, other: &Rhs) -> bool
self
and other
) and is used by the <=
operator. Read moresource§impl Serialize for AccessRights
impl Serialize for AccessRights
source§impl Sub for AccessRights
impl Sub for AccessRights
source§impl SubAssign for AccessRights
impl SubAssign for AccessRights
source§fn sub_assign(&mut self, other: Self)
fn sub_assign(&mut self, other: Self)
Disables all flags enabled in the set.
source§impl ToBytes for AccessRights
impl ToBytes for AccessRights
source§fn serialized_length(&self) -> usize
fn serialized_length(&self) -> usize
Vec<u8>
which would be returned from a successful call to
to_bytes()
or into_bytes()
. The data is not actually serialized, so this call is
relatively cheap.