Enum solana_sdk::program_error::ProgramError

[−] Show declaration

pub enum ProgramError {
    Custom(u32),
    InvalidArgument,
    InvalidInstructionData,
    InvalidAccountData,
    AccountDataTooSmall,
    InsufficientFunds,
    IncorrectProgramId,
    MissingRequiredSignature,
    AccountAlreadyInitialized,
    UninitializedAccount,
    NotEnoughAccountKeys,
    AccountBorrowFailed,
    MaxSeedLengthExceeded,
    InvalidSeeds,
    BorshIoError(String),
    AccountNotRentExempt,
}

[−] Expand description

Reasons the program may fail

Variants

Custom(u32)

[−] Expand description

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(String)

AccountNotRentExempt

Trait Implementations

impl Clone for ProgramError[+]

[+] Show hidden undocumented items

pub fn clone(&self) -> ProgramError[−]

Returns a copy of the value.

pub fn clone_from(&mut self, source: &Self)[−]

Performs copy-assignment from source.

impl Debug for ProgramError[+]

[+] Show hidden undocumented items

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for ProgramError[+]

[+] Show hidden undocumented items

pub fn deserialize<__D>(
    __deserializer: __D
) -> Result<ProgramError, <__D as Deserializer<'de>>::Error> where
    __D: Deserializer<'de>, [−]

Deserialize this value from the given Serde deserializer.

impl Display for ProgramError[+]

[+] Show hidden undocumented items

pub fn fmt(&self, __formatter: &mut Formatter<'_>) -> Result<(), Error>[−]

Formats the value using the given formatter.

impl Eq for ProgramError

impl Error for ProgramError[+]

[+] Show hidden undocumented items

pub fn source(&self) -> Option<&(dyn Error + 'static)>[−]

The lower-level source of this error, if any.

pub fn backtrace(&self) -> Option<&Backtrace>[−]

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

Returns a stack backtrace, if available, of where this error occurred.

pub fn description(&self) -> &str[−]

👎 Deprecated since 1.42.0:

use the Display impl or to_string()

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

👎 Deprecated since 1.33.0:

replaced by Error::source, which can support downcasting

impl From<Error> for ProgramError[+]

[+] Show hidden undocumented items

pub fn from(error: Error) -> ProgramError[−]

Performs the conversion.

impl From<PubkeyError> for ProgramError[+]

[+] Show hidden undocumented items

pub fn from(error: PubkeyError) -> ProgramError[−]

Performs the conversion.

impl From<u64> for ProgramError[+]

[+] Show hidden undocumented items

pub fn from(error: u64) -> ProgramError[−]

Performs the conversion.

impl PartialEq<ProgramError> for ProgramError[+]

[+] Show hidden undocumented items

pub fn eq(&self, other: &ProgramError) -> bool[−]

This method tests for self and other values to be equal, and is used by ==.

pub fn ne(&self, other: &ProgramError) -> bool[−]

This method tests for !=.

impl PrintProgramError for ProgramError[+]

[+] Show hidden undocumented items

pub fn print<E>(&self) where
    E: 'static + Error + DecodeError<E> + PrintProgramError + FromPrimitive, 

impl Serialize for ProgramError[+]

[+] Show hidden undocumented items

pub fn serialize<__S>(
    &self,
    __serializer: __S
) -> Result<<__S as Serializer>::Ok, <__S as Serializer>::Error> where
    __S: Serializer, [−]

Serialize this value into the given Serde serializer.

impl StructuralEq for ProgramError

impl StructuralPartialEq for ProgramError

impl TryFrom<InstructionError> for ProgramError[+]

[+] Show hidden undocumented items

type Error = InstructionError

The type returned in the event of a conversion error.

pub fn try_from(
    error: InstructionError
) -> Result<ProgramError, <ProgramError as TryFrom<InstructionError>>::Error>[−]

Performs the conversion.