Struct soroban_env_common::BitSet

pub struct BitSet(_);

Wrapper for a RawVal that is tagged with Tag::BitSet, interpreting the RawVal’s body as a small bitset (60-bits or fewer).

Implementations

impl BitSet

pub const fn as_raw(&self) -> &RawVal

pub const fn to_raw(&self) -> RawVal

impl BitSet

pub const fn try_from_u64(u: u64) -> Result<BitSet, BitSetError>

Attempt to construct a BitSet from a u64, succeeding only if the most significant 4 bits of the u64 are clear. In other words, this function accepts only “small” bitsets of 60 or fewer bits.

pub const fn to_u64(&self) -> u64

Trait Implementations

impl AsMut<RawVal> for BitSet

fn as_mut(&mut self) -> &mut RawVal

Converts this type into a mutable reference of the (usually inferred) input type.

impl AsRef<RawVal> for BitSet

fn as_ref(&self) -> &RawVal

Converts this type into a shared reference of the (usually inferred) input type.

impl Clone for BitSet

fn clone(&self) -> BitSet

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for BitSet

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

Formats the value using the given formatter.

impl From<BitSet> for RawVal

fn from(b: BitSet) -> Self

Converts to this type from the input type.

impl From<BitSet> for Value

fn from(v: BitSet) -> Self

Converts to this type from the input type.

impl FromValue for BitSet

fn from_value(val: Value) -> Option<Self>

Create a value of type Self from a given Value.

impl Hash for BitSet

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

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<E: Env> IntoVal<E, RawVal> for &BitSet

fn into_val(self, _env: &E) -> RawVal

impl<E: Env> IntoVal<E, RawVal> for BitSet

fn into_val(self, _env: &E) -> RawVal

impl Ord for BitSet

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

This method returns an Ordering between self and other.

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

Compares and returns the maximum of two values.

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

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Selfwhere
    Self: Sized + PartialOrd<Self>,

Restrict a value to a certain interval.

impl PartialEq<BitSet> for BitSet

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

fn partial_cmp(&self, other: &Self) -> 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 RawValConvertible for BitSet

fn is_val_type(v: RawVal) -> bool

Returns true if v is in a union state compatible with Self.

unsafe fn unchecked_from_val(v: RawVal) -> Self

Converts the bits making up a RawVal into Self without checking that the RawVal is tagged correctly, assuming that such a check has been performed elsewhere. It is the caller’s responsibility to arrange that such checks have occurred before calling unchecked_from_val, which is why it is marked as unsafe (it does not represent a risk of memory-unsafety, merely “serious logic errors”).

fn try_convert(v: RawVal) -> Option<Self>

Attempt a conversion from RawVal to Self, returning None if the provided RawVal is not tagged correctly. By default this calls Self::is_val_type and Self::unchecked_from_val, but it can be customized on a type-by-type basis to avoid redundant tag tests and produce more efficient code, as it is done for Static values like bool.

impl TryFrom<&RawVal> for BitSet

type Error = ConversionError

The type returned in the event of a conversion error.

fn try_from(v: &RawVal) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<RawVal> for BitSet

type Error = ConversionError

The type returned in the event of a conversion error.

fn try_from(v: RawVal) -> Result<Self, Self::Error>

Performs the conversion.

impl<E: Env> TryFromVal<E, RawVal> for BitSet

type Error = ConversionError

fn try_from_val(_env: &E, val: RawVal) -> Result<Self, Self::Error>

impl<E: Env> TryIntoVal<E, BitSet> for RawVal

type Error = ConversionError

fn try_into_val(self, env: &E) -> Result<BitSet, Self::Error>

impl<E: Env> TryIntoVal<E, RawVal> for BitSet

type Error = ConversionError

fn try_into_val(self, _env: &E) -> Result<RawVal, Self::Error>

impl Copy for BitSet

impl Eq for BitSet

impl Val for BitSet