Enum solana_sdk::program_error::ProgramError

source · [−]

pub enum ProgramError {
Show 20 variants
    Custom(u32),
    InvalidArgument,
    InvalidInstructionData,
    InvalidAccountData,
    AccountDataTooSmall,
    InsufficientFunds,
    IncorrectProgramId,
    MissingRequiredSignature,
    AccountAlreadyInitialized,
    UninitializedAccount,
    NotEnoughAccountKeys,
    AccountBorrowFailed,
    MaxSeedLengthExceeded,
    InvalidSeeds,
    BorshIoError(String),
    AccountNotRentExempt,
    UnsupportedSysvar,
    IllegalOwner,
    AccountsDataBudgetExceeded,
    ActiveVoteAccountClose,
}

Expand description

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

`AccountNotRentExempt`

`UnsupportedSysvar`

`IllegalOwner`

`AccountsDataBudgetExceeded`

`ActiveVoteAccountClose`

Trait Implementations

impl Clone for ProgramError

pub fn clone(&self) -> ProgramError

Returns a copy of the value. Read more

1.0.0 · source

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

Performs copy-assignment from source. Read more

impl Debug for ProgramError

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

Formats the value using the given formatter. Read more

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

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. Read more

impl Display for ProgramError

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

Formats the value using the given formatter. Read more

impl Error for ProgramError

1.30.0 · source

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

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

fn backtrace(&self) -> Option<&Backtrace>

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

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

1.0.0 · source

fn description(&self) -> &str

👎 Deprecated since 1.42.0:

use the Display impl or to_string()

1.0.0 · source

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

👎 Deprecated since 1.33.0:

replaced by Error::source, which can support downcasting

impl From<Error> for ProgramError

pub fn from(error: Error) -> ProgramError

Performs the conversion.

impl From<PubkeyError> for ProgramError

pub fn from(error: PubkeyError) -> ProgramError

Performs the conversion.

impl From<u64> for ProgramError

pub fn from(error: u64) -> ProgramError

Performs the conversion.

impl PartialEq<ProgramError> for ProgramError

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

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

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

This method tests for !=.

impl PrintProgramError for ProgramError

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

impl Serialize for ProgramError

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. Read more

impl TryFrom<InstructionError> for ProgramError

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.

impl Eq for ProgramError

impl StructuralEq for ProgramError

impl StructuralPartialEq for ProgramError

Auto Trait Implementations

impl RefUnwindSafe for ProgramError

impl Send for ProgramError

impl Sync for ProgramError

impl Unpin for ProgramError

impl UnwindSafe for ProgramError

Blanket Implementations

impl<T> AbiEnumVisitor for T where
T: Serialize + ?Sized,

pub default fn visit_for_abi(
&self,
_digester: &mut AbiDigester
) -> Result<AbiDigester, DigestError>

impl<T> AbiEnumVisitor for T where
T: Serialize + AbiExample + ?Sized,

pub default fn visit_for_abi(
&self,
digester: &mut AbiDigester
) -> Result<AbiDigester, DigestError>

impl<T> AbiExample for T

pub default fn example() -> T

impl<T> Any for T where
T: 'static + ?Sized,

pub fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more

impl<T> AsFail for T where
T: Fail,

pub fn as_fail(&self) -> &(dyn Fail + 'static)

Converts a reference to Self into a dynamic trait object of Fail.

impl<T> Borrow<T> for T where
T: ?Sized,

const: unstable · source

pub fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

impl<T> BorrowMut<T> for T where
T: ?Sized,

const: unstable · source

pub fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more

impl<E> Fail for E where
E: 'static + Error + Send + Sync,

fn name(&self) -> Option<&str>

Returns the “name” of the error. Read more

fn cause(&self) -> Option<&(dyn Fail + 'static)>

Returns a reference to the underlying cause of this failure, if it is an error that wraps other errors. Read more

fn backtrace(&self) -> Option<&Backtrace>

Returns a reference to the Backtrace carried by this failure, if it carries one. Read more

fn context<D>(self, context: D) -> Context<D> where
D: 'static + Display + Send + Sync,

Provides context for this failure. Read more

fn compat(self) -> Compat<Self>

Wraps this failure in a compatibility wrapper that implements std::error::Error. Read more

impl<T> From<T> for T

const: unstable · source

pub fn from(t: T) -> T

Returns the argument unchanged.

impl<T, U> Into<U> for T where
U: From<T>,

const: unstable · source

pub fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

impl<T> Same<T> for T

type Output = T

Should always be Self

impl<T> ToOwned for T where
T: Clone,

type Owned = T

The resulting type after obtaining ownership.

pub fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more

pub fn clone_into(&self, target: &mut T)

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

Uses borrowed data to replace owned data, usually by cloning. Read more

impl<T> ToString for T where
T: Display + ?Sized,

pub default fn to_string(&self) -> String

Converts the given value to a String. Read more

impl<T, U> TryFrom<U> for T where
U: Into<T>,

type Error = Infallible

The type returned in the event of a conversion error.

const: unstable · source

pub fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.

impl<T, U> TryInto<U> for T where
U: TryFrom<T>,

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.

const: unstable · source

pub fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.

impl<V, T> VZip<V> for T where
V: MultiLane<T>,

pub fn vzip(self) -> V

impl<T> DeserializeOwned for T where
T: for<'de> Deserialize<'de>,