Enum ProgramError

pub enum ProgramError {
    Custom(u32),
    InvalidArgument,
    InvalidInstructionData,
    InvalidAccountData,
    AccountDataTooSmall,
    InsufficientFunds,
    IncorrectProgramId,
    MissingRequiredSignature,
    AccountAlreadyInitialized,
    UninitializedAccount,
    NotEnoughAccountKeys,
    AccountBorrowFailed,
    MaxSeedLengthExceeded,
    InvalidSeeds,
    BorshIoError,
    AccountNotRentExempt,
    UnsupportedSysvar,
    IllegalOwner,
    MaxAccountsDataAllocationsExceeded,
    InvalidRealloc,
    MaxInstructionTraceLengthExceeded,
    BuiltinProgramsMustConsumeComputeUnits,
    InvalidAccountOwner,
    ArithmeticOverflow,
    Immutable,
    IncorrectAuthority,
}

Reasons the program may fail

Variants

Custom(u32)

Allows on-chain programs to implement program-specific error types and see them returned by the Solana runtime. A program-specific error may be any type that is represented as or serialized to a u32 integer.

InvalidArgument

InvalidInstructionData

InvalidAccountData

AccountDataTooSmall

InsufficientFunds

IncorrectProgramId

MissingRequiredSignature

AccountAlreadyInitialized

UninitializedAccount

NotEnoughAccountKeys

AccountBorrowFailed

MaxSeedLengthExceeded

InvalidSeeds

BorshIoError

AccountNotRentExempt

UnsupportedSysvar

IllegalOwner

MaxAccountsDataAllocationsExceeded

InvalidRealloc

MaxInstructionTraceLengthExceeded

BuiltinProgramsMustConsumeComputeUnits

InvalidAccountOwner

ArithmeticOverflow

Immutable

IncorrectAuthority

Implementations

impl ProgramError

pub fn to_str<E>(&self) -> &'static str

where E: 'static + ToStr + TryFrom<u32>,

Get an appropriate error string given a program error and an expected error type, if the error implements TryFrom<u32> and ToStr.

Example

#[derive(num_enum::TryFromPrimitive)]
#[repr(u32)]
enum MyError {
    A,
    B,
}

impl solana_program_error::ToStr for MyError {
    fn to_str(&self) -> &'static str {
        match self {
            MyError::A => "Message for A",
            MyError::B => "Some other message for B",
        }
    }
}

let program_error = solana_program_error::ProgramError::Custom(1);
assert_eq!("Some other message for B", program_error.to_str::<MyError>());

Trait Implementations

impl Clone for ProgramError

fn clone(&self) -> ProgramError

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ProgramError

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for ProgramError

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for ProgramError

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

Formats the value using the given formatter.

impl Error for ProgramError

fn source(&self) -> Option<&(dyn Error + 'static)>

Returns the lower-level source of this error, if any.

fn description(&self) -> &str

👎Deprecated since 1.42.0: use the Display impl or to_string()

fn cause(&self) -> Option<&dyn Error>

👎Deprecated since 1.33.0: replaced by Error::source, which can support downcasting

fn provide<'a>(&'a self, request: &mut Request<'a>)

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

Provides type-based access to context intended for error reports.

impl From<Error> for ProgramError

Available on crate feature borsh only.

fn from(_error: BorshIoError) -> Self

Converts to this type from the input type.

impl From<ProgramError> for u64

fn from(error: ProgramError) -> Self

Converts to this type from the input type.

impl From<u64> for ProgramError

fn from(error: u64) -> Self

Converts to this type from the input type.

impl PartialEq for ProgramError

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

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Serialize for ProgramError

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl Eq for ProgramError

impl StructuralPartialEq for ProgramError