Enum switchboard_solana::attestation_program::types::BoolWithLock

#[repr(u8)]
pub enum BoolWithLock {
    FalseUnlocked = 0,
    TrueUnlocked = 1,
    FalseLocked = 2,
    TrueLocked = 3,
}

An enum representing a boolean flag which can be locked. Byte #0: 0 = Disabled, 1 = Enabled Byte #1: 0 = Unlocked, 1 = Locked

Variants

FalseUnlocked = 0

TrueUnlocked = 1

FalseLocked = 2

TrueLocked = 3

Implementations

impl BoolWithLock

pub fn to_bool(&self) -> bool

pub fn is_locked(&self) -> bool

pub fn assert_unlocked(&self) -> Result<()>

Asserts that the configuration parameter is unlocked.

pub fn update(&mut self, b: bool, is_locked: Option<bool>) -> Result<()>

Updates the value of the enum with a new value.

Arguments

• new_value - A reference to a BoolWithLock struct containing the new value.

Errors

Returns an error if the enum is locked and an update attempt is made.

Returns

Returns Ok(()) if the update is successful.

pub fn lock(&mut self) -> Result<()>

Locks the enum value for further updates. No action taken if the enum is already locked.

Trait Implementations

impl BorshDeserialize for BoolWithLock

fn deserialize_reader<R: Read>(reader: &mut R) -> Result<Self, Error>

fn deserialize(buf: &mut &[u8]) -> Result<Self, Error>

Deserializes this instance from a given slice of bytes. Updates the buffer to point at the remaining bytes.

fn try_from_slice(v: &[u8]) -> Result<Self, Error>

Deserialize this instance from a slice of bytes.

fn try_from_reader<R>(reader: &mut R) -> Result<Self, Error>

where R: Read,

impl BorshSerialize for BoolWithLock

fn serialize<W: Write>(&self, writer: &mut W) -> Result<(), Error>

fn try_to_vec(&self) -> Result<Vec<u8>, Error>

Serialize this instance into a vector of bytes.

impl Clone for BoolWithLock

fn clone(&self) -> BoolWithLock

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for BoolWithLock

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

Formats the value using the given formatter.

impl Default for BoolWithLock

fn default() -> BoolWithLock

Returns the “default value” for a type.

impl EnumExt for BoolWithLock

fn deserialize_variant<R: Read>( reader: &mut R, variant_idx: u8 ) -> Result<Self, Error>

Deserialises given variant of an enum from the reader.

impl From<BoolWithLock> for u8

fn from(value: BoolWithLock) -> Self

Converts to this type from the input type.

impl From<u8> for BoolWithLock

fn from(value: u8) -> Self

Converts to this type from the input type.

impl PartialEq for BoolWithLock

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

const INIT_SPACE: usize = 1usize

impl Copy for BoolWithLock

impl Eq for BoolWithLock

impl StructuralPartialEq for BoolWithLock