Safe Haskell	Safe-Inferred
Language	Haskell2010

PlutusCore.Evaluation.Machine.Exception

Description

The exceptions that an abstract machine can throw.

Synopsis

newtype UnliftingError = MkUnliftingError {
- unUnliftingError ∷ Text
}
class AsUnliftingError r where
- _UnliftingError ∷ Prism' r UnliftingError
- _MkUnliftingError ∷ Prism' r Text
data BuiltinError
- = BuiltinUnliftingEvaluationError UnliftingEvaluationError
- | BuiltinEvaluationFailure
data MachineError fun
class AsMachineError r fun | r → fun where
- _MachineError ∷ Prism' r (MachineError fun)
- _NonPolymorphicInstantiationMachineError ∷ Prism' r ()
- _NonWrapUnwrappedMachineError ∷ Prism' r ()
- _NonFunctionalApplicationMachineError ∷ Prism' r ()
- _OpenTermEvaluatedMachineError ∷ Prism' r ()
- _UnliftingMachineError ∷ Prism' r UnliftingError
- _BuiltinTermArgumentExpectedMachineError ∷ Prism' r ()
- _UnexpectedBuiltinTermArgumentMachineError ∷ Prism' r ()
- _NonConstrScrutinized ∷ Prism' r ()
- _MissingCaseBranch ∷ Prism' r Word64
data EvaluationError structural operational
- = StructuralEvaluationError !structural
- | OperationalEvaluationError !operational
class AsEvaluationError r structural operational | r → structural operational where
- _EvaluationError ∷ Prism' r (EvaluationError structural operational)
- _StructuralEvaluationError ∷ Prism' r structural
- _OperationalEvaluationError ∷ Prism' r operational
data ErrorWithCause err cause = ErrorWithCause {
- _ewcError ∷ !err
- _ewcCause ∷ !(Maybe cause)
}
type EvaluationException structural operational = ErrorWithCause (EvaluationError structural operational)
throwNotAConstant ∷ MonadError BuiltinError m ⇒ m void
throwing ∷ MonadError e m ⇒ AReview e t → t → m x
throwing_ ∷ MonadError e m ⇒ AReview e () → m x
throwingWithCause ∷ ∀ exc e t term m x. (exc ~ ErrorWithCause e term, MonadError exc m) ⇒ AReview e t → t → Maybe term → m x
splitStructuralOperational ∷ Either (EvaluationException structural operational term) a → Either (ErrorWithCause structural term) (EvaluationResult a)
unsafeSplitStructuralOperational ∷ (PrettyPlc structural, PrettyPlc term, Typeable structural, Typeable term) ⇒ Either (EvaluationException structural operational term) a → EvaluationResult a

Documentation

newtype UnliftingError Source #

The error message part of an UnliftingEvaluationError.

Constructors

MkUnliftingError
Fields unUnliftingError ∷ Text

Instances

Instances details

IsString UnliftingError Source #
Instance details Defined in PlutusCore.Builtin.Result Methods fromString ∷ String → UnliftingError Source #
Monoid UnliftingError Source #
Instance details Defined in PlutusCore.Builtin.Result Methods mempty ∷ UnliftingError Source # mappend ∷ UnliftingError → UnliftingError → UnliftingError Source # mconcat ∷ [UnliftingError] → UnliftingError Source #
Semigroup UnliftingError Source #
Instance details Defined in PlutusCore.Builtin.Result Methods (<>) ∷ UnliftingError → UnliftingError → UnliftingError Source # sconcat ∷ NonEmpty UnliftingError → UnliftingError Source # stimes ∷ Integral b ⇒ b → UnliftingError → UnliftingError Source #
Show UnliftingError Source #
Instance details Defined in PlutusCore.Builtin.Result Methods showsPrec ∷ Int → UnliftingError → ShowS Source # show ∷ UnliftingError → String Source # showList ∷ [UnliftingError] → ShowS Source #
NFData UnliftingError Source #
Instance details Defined in PlutusCore.Builtin.Result Methods rnf ∷ UnliftingError → () Source #
Eq UnliftingError Source #
Instance details Defined in PlutusCore.Builtin.Result Methods (==) ∷ UnliftingError → UnliftingError → Bool Source # (/=) ∷ UnliftingError → UnliftingError → Bool Source #
AsUnliftingError UnliftingError Source #
Instance details Defined in PlutusCore.Builtin.Result Methods _UnliftingError ∷ Prism' UnliftingError UnliftingError Source # _MkUnliftingError ∷ Prism' UnliftingError Text Source #
Pretty UnliftingError Source #
Instance details Defined in PlutusCore.Builtin.Result Methods pretty ∷ UnliftingError → Doc ann Source # prettyList ∷ [UnliftingError] → Doc ann Source #
AsEvaluationError UnliftingEvaluationError UnliftingError UnliftingError Source #
Instance details Defined in PlutusCore.Builtin.Result Methods _EvaluationError ∷ Prism' UnliftingEvaluationError (EvaluationError UnliftingError UnliftingError) Source # _StructuralEvaluationError ∷ Prism' UnliftingEvaluationError UnliftingError Source # _OperationalEvaluationError ∷ Prism' UnliftingEvaluationError UnliftingError Source #

class AsUnliftingError r where Source #

Minimal complete definition

_UnliftingError

Methods

_UnliftingError ∷ Prism' r UnliftingError Source #

_MkUnliftingError ∷ Prism' r Text Source #

Instances

Instances details

AsUnliftingError UnliftingError Source #
Instance details Defined in PlutusCore.Builtin.Result Methods _UnliftingError ∷ Prism' UnliftingError UnliftingError Source # _MkUnliftingError ∷ Prism' UnliftingError Text Source #
AsUnliftingError CekUserError Source #
Instance details Defined in UntypedPlutusCore.Evaluation.Machine.Cek.Internal Methods _UnliftingError ∷ Prism' CekUserError UnliftingError Source # _MkUnliftingError ∷ Prism' CekUserError Text Source #
AsUnliftingError (MachineError fun) Source #
Instance details Defined in PlutusCore.Evaluation.Machine.Exception Methods _UnliftingError ∷ Prism' (MachineError fun) UnliftingError Source # _MkUnliftingError ∷ Prism' (MachineError fun) Text Source #

data BuiltinError Source #

The type of errors that readKnown and makeKnown can return.

Constructors

BuiltinUnliftingEvaluationError UnliftingEvaluationError
BuiltinEvaluationFailure

Instances

Instances details

Show BuiltinError Source #
Instance details Defined in PlutusCore.Builtin.Result Methods showsPrec ∷ Int → BuiltinError → ShowS Source # show ∷ BuiltinError → String Source # showList ∷ [BuiltinError] → ShowS Source #
Eq BuiltinError Source #
Instance details Defined in PlutusCore.Builtin.Result Methods (==) ∷ BuiltinError → BuiltinError → Bool Source # (/=) ∷ BuiltinError → BuiltinError → Bool Source #
AsBuiltinError BuiltinError Source #
Instance details Defined in PlutusCore.Builtin.Result Methods _BuiltinError ∷ Prism' BuiltinError BuiltinError Source # _BuiltinUnliftingEvaluationError ∷ Prism' BuiltinError UnliftingEvaluationError Source # _BuiltinEvaluationFailure ∷ Prism' BuiltinError () Source #
AsUnliftingEvaluationError BuiltinError Source #
Instance details Defined in PlutusCore.Builtin.Result Methods _UnliftingEvaluationError ∷ Prism' BuiltinError UnliftingEvaluationError Source # _MkUnliftingEvaluationError ∷ Prism' BuiltinError (EvaluationError UnliftingError UnliftingError) Source #
AsEvaluationFailure BuiltinError Source #
Instance details Defined in PlutusCore.Builtin.Result Methods _EvaluationFailure ∷ Prism' BuiltinError () Source #
Pretty BuiltinError Source #
Instance details Defined in PlutusCore.Builtin.Result Methods pretty ∷ BuiltinError → Doc ann Source # prettyList ∷ [BuiltinError] → Doc ann Source #
MonadError BuiltinError BuiltinResult Source #	`throwError` puts every operational unlifting error into the `BuiltinFailure` logs. This is to compensate for the historical lack of error message content in operational errors (structural ones don't have this problem) in our evaluators (the CK and CEK machines). It would be better to fix the underlying issue and allow operational evaluation errors to carry some form of content, but for now we just fix the symptom in order for the end user to see the error message that they are supposed to see. The fix even makes some sense: what we do here is we emulate logging when the thrown unlifting error is an operational one, i.e. this is similar to what some builtins do manually (like when a crypto builtin fails and puts info about the failure into the logs).
Instance details Defined in PlutusCore.Builtin.Result Methods throwError ∷ BuiltinError → BuiltinResult a Source # catchError ∷ BuiltinResult a → (BuiltinError → BuiltinResult a) → BuiltinResult a Source #

data MachineError fun Source #

Errors which can occur during a run of an abstract machine.

Constructors

NonPolymorphicInstantiationMachineError	An attempt to reduce a not immediately reducible type instantiation.
NonWrapUnwrappedMachineError	An attempt to unwrap a not wrapped term.
NonFunctionalApplicationMachineError	An attempt to reduce a not immediately reducible application.
OpenTermEvaluatedMachineError	An attempt to evaluate an open term.
UnliftingMachineError UnliftingError	An attempt to compute a constant application resulted in `UnliftingError`.
BuiltinTermArgumentExpectedMachineError	A builtin expected a term argument, but something else was received.
UnexpectedBuiltinTermArgumentMachineError	A builtin received a term argument when something else was expected
NonConstrScrutinized
MissingCaseBranch Word64

Instances

Instances details

Functor MachineError Source #
Instance details Defined in PlutusCore.Evaluation.Machine.Exception Methods fmap ∷ (a → b) → MachineError a → MachineError b Source # (<$) ∷ a → MachineError b → MachineError a Source #
(HasPrettyDefaults config ~ 'True, Pretty fun) ⇒ PrettyBy config (MachineError fun) Source #
Instance details Defined in PlutusCore.Evaluation.Machine.Exception Methods prettyBy ∷ config → MachineError fun → Doc ann Source # prettyListBy ∷ config → [MachineError fun] → Doc ann Source #
Generic (MachineError fun) Source #
Instance details Defined in PlutusCore.Evaluation.Machine.Exception Associated Types type Rep (MachineError fun) ∷ Type → Type Source # Methods from ∷ MachineError fun → Rep (MachineError fun) x Source # to ∷ Rep (MachineError fun) x → MachineError fun Source #
Show (MachineError fun) Source #
Instance details Defined in PlutusCore.Evaluation.Machine.Exception Methods showsPrec ∷ Int → MachineError fun → ShowS Source # show ∷ MachineError fun → String Source # showList ∷ [MachineError fun] → ShowS Source #
NFData (MachineError fun) Source #
Instance details Defined in PlutusCore.Evaluation.Machine.Exception Methods rnf ∷ MachineError fun → () Source #
Eq (MachineError fun) Source #
Instance details Defined in PlutusCore.Evaluation.Machine.Exception Methods (==) ∷ MachineError fun → MachineError fun → Bool Source # (/=) ∷ MachineError fun → MachineError fun → Bool Source #
AsUnliftingError (MachineError fun) Source #
Instance details Defined in PlutusCore.Evaluation.Machine.Exception Methods _UnliftingError ∷ Prism' (MachineError fun) UnliftingError Source # _MkUnliftingError ∷ Prism' (MachineError fun) Text Source #
AsMachineError (MachineError fun) fun Source #
Instance details Defined in PlutusCore.Evaluation.Machine.Exception Methods _MachineError ∷ Prism' (MachineError fun) (MachineError fun) Source # _NonPolymorphicInstantiationMachineError ∷ Prism' (MachineError fun) () Source # _NonWrapUnwrappedMachineError ∷ Prism' (MachineError fun) () Source # _NonFunctionalApplicationMachineError ∷ Prism' (MachineError fun) () Source # _OpenTermEvaluatedMachineError ∷ Prism' (MachineError fun) () Source # _UnliftingMachineError ∷ Prism' (MachineError fun) UnliftingError Source # _BuiltinTermArgumentExpectedMachineError ∷ Prism' (MachineError fun) () Source # _UnexpectedBuiltinTermArgumentMachineError ∷ Prism' (MachineError fun) () Source # _NonConstrScrutinized ∷ Prism' (MachineError fun) () Source # _MissingCaseBranch ∷ Prism' (MachineError fun) Word64 Source #
ThrowableBuiltins uni fun ⇒ MonadError (CekEvaluationException NamedDeBruijn uni fun) (CekM uni fun s) Source #
Instance details Defined in UntypedPlutusCore.Evaluation.Machine.Cek.Internal Methods throwError ∷ CekEvaluationException NamedDeBruijn uni fun → CekM uni fun s a Source # catchError ∷ CekM uni fun s a → (CekEvaluationException NamedDeBruijn uni fun → CekM uni fun s a) → CekM uni fun s a Source #
type Rep (MachineError fun) Source #
Instance details Defined in PlutusCore.Evaluation.Machine.Exception type Rep (MachineError fun) = D1 ('MetaData "MachineError" "PlutusCore.Evaluation.Machine.Exception" "plutus-core-1.36.0.0-inplace" 'False) (((C1 ('MetaCons "NonPolymorphicInstantiationMachineError" 'PrefixI 'False) (U1 ∷ Type → Type) :+: C1 ('MetaCons "NonWrapUnwrappedMachineError" 'PrefixI 'False) (U1 ∷ Type → Type)) :+: (C1 ('MetaCons "NonFunctionalApplicationMachineError" 'PrefixI 'False) (U1 ∷ Type → Type) :+: C1 ('MetaCons "OpenTermEvaluatedMachineError" 'PrefixI 'False) (U1 ∷ Type → Type))) :+: ((C1 ('MetaCons "UnliftingMachineError" 'PrefixI 'False) (S1 ('MetaSel ('Nothing ∷ Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 UnliftingError)) :+: C1 ('MetaCons "BuiltinTermArgumentExpectedMachineError" 'PrefixI 'False) (U1 ∷ Type → Type)) :+: (C1 ('MetaCons "UnexpectedBuiltinTermArgumentMachineError" 'PrefixI 'False) (U1 ∷ Type → Type) :+: (C1 ('MetaCons "NonConstrScrutinized" 'PrefixI 'False) (U1 ∷ Type → Type) :+: C1 ('MetaCons "MissingCaseBranch" 'PrefixI 'False) (S1 ('MetaSel ('Nothing ∷ Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Word64))))))

class AsMachineError r fun | r → fun where Source #

Minimal complete definition

_MachineError

Methods

_MachineError ∷ Prism' r (MachineError fun) Source #

_NonPolymorphicInstantiationMachineError ∷ Prism' r () Source #

_NonWrapUnwrappedMachineError ∷ Prism' r () Source #

_NonFunctionalApplicationMachineError ∷ Prism' r () Source #

_OpenTermEvaluatedMachineError ∷ Prism' r () Source #

_UnliftingMachineError ∷ Prism' r UnliftingError Source #

_BuiltinTermArgumentExpectedMachineError ∷ Prism' r () Source #

_UnexpectedBuiltinTermArgumentMachineError ∷ Prism' r () Source #

_NonConstrScrutinized ∷ Prism' r () Source #

_MissingCaseBranch ∷ Prism' r Word64 Source #

Instances

Instances details

AsMachineError (MachineError fun) fun Source #
Instance details Defined in PlutusCore.Evaluation.Machine.Exception Methods _MachineError ∷ Prism' (MachineError fun) (MachineError fun) Source # _NonPolymorphicInstantiationMachineError ∷ Prism' (MachineError fun) () Source # _NonWrapUnwrappedMachineError ∷ Prism' (MachineError fun) () Source # _NonFunctionalApplicationMachineError ∷ Prism' (MachineError fun) () Source # _OpenTermEvaluatedMachineError ∷ Prism' (MachineError fun) () Source # _UnliftingMachineError ∷ Prism' (MachineError fun) UnliftingError Source # _BuiltinTermArgumentExpectedMachineError ∷ Prism' (MachineError fun) () Source # _UnexpectedBuiltinTermArgumentMachineError ∷ Prism' (MachineError fun) () Source # _NonConstrScrutinized ∷ Prism' (MachineError fun) () Source # _MissingCaseBranch ∷ Prism' (MachineError fun) Word64 Source #
structural ~ MachineError fun ⇒ AsMachineError (EvaluationError structural operational) fun Source #
Instance details Defined in PlutusCore.Evaluation.Machine.Exception Methods _MachineError ∷ Prism' (EvaluationError structural operational) (MachineError fun) Source # _NonPolymorphicInstantiationMachineError ∷ Prism' (EvaluationError structural operational) () Source # _NonWrapUnwrappedMachineError ∷ Prism' (EvaluationError structural operational) () Source # _NonFunctionalApplicationMachineError ∷ Prism' (EvaluationError structural operational) () Source # _OpenTermEvaluatedMachineError ∷ Prism' (EvaluationError structural operational) () Source # _UnliftingMachineError ∷ Prism' (EvaluationError structural operational) UnliftingError Source # _BuiltinTermArgumentExpectedMachineError ∷ Prism' (EvaluationError structural operational) () Source # _UnexpectedBuiltinTermArgumentMachineError ∷ Prism' (EvaluationError structural operational) () Source # _NonConstrScrutinized ∷ Prism' (EvaluationError structural operational) () Source # _MissingCaseBranch ∷ Prism' (EvaluationError structural operational) Word64 Source #

data EvaluationError structural operational Source #

The type of errors that can occur during evaluation. There are two kinds of errors:

Structural ones -- these are errors that are indicative of the _structure_ of the program being wrong. For example, a free variable was encountered during evaluation, a non-function was applied to an argument or tailList was applied to a non-list.
Operational ones -- these are errors that are indicative of the _logic_ of the program being wrong. For example, error was executed, tailList was applied to an empty list or evaluation ran out of gas.

On the chain both of these are just regular failures and we don't distinguish between them there: if a script fails, it fails, it doesn't matter what the reason was. However in the tests it does matter why the failure occurred: a structural error may indicate that the test was written incorrectly while an operational error may be entirely expected.

In other words, structural errors are "runtime type errors" and operational errors are regular runtime errors. Which means that evaluating an (erased) well-typed program should never produce a structural error, only an operational one. This creates a sort of "runtime type system" for UPLC and it would be great to stick to it and enforce in tests etc, but we currently don't.

Constructors

StructuralEvaluationError !structural
OperationalEvaluationError !operational

Instances

Instances details

Bifoldable EvaluationError Source #
Instance details Defined in PlutusCore.Evaluation.Error Methods bifold ∷ Monoid m ⇒ EvaluationError m m → m Source # bifoldMap ∷ Monoid m ⇒ (a → m) → (b → m) → EvaluationError a b → m Source # bifoldr ∷ (a → c → c) → (b → c → c) → c → EvaluationError a b → c Source # bifoldl ∷ (c → a → c) → (c → b → c) → c → EvaluationError a b → c Source #
Bifunctor EvaluationError Source #
Instance details Defined in PlutusCore.Evaluation.Error Methods bimap ∷ (a → b) → (c → d) → EvaluationError a c → EvaluationError b d Source # first ∷ (a → b) → EvaluationError a c → EvaluationError b c Source # second ∷ (b → c) → EvaluationError a b → EvaluationError a c Source #
Bitraversable EvaluationError Source #
Instance details Defined in PlutusCore.Evaluation.Error Methods bitraverse ∷ Applicative f ⇒ (a → f c) → (b → f d) → EvaluationError a b → f (EvaluationError c d) Source #
(HasPrettyDefaults config ~ 'True, PrettyBy config structural, Pretty operational) ⇒ PrettyBy config (EvaluationError structural operational) Source #
Instance details Defined in PlutusCore.Evaluation.Error Methods prettyBy ∷ config → EvaluationError structural operational → Doc ann Source # prettyListBy ∷ config → [EvaluationError structural operational] → Doc ann Source #
Functor (EvaluationError structural) Source #
Instance details Defined in PlutusCore.Evaluation.Error Methods fmap ∷ (a → b) → EvaluationError structural a → EvaluationError structural b Source # (<$) ∷ a → EvaluationError structural b → EvaluationError structural a Source #
Generic (EvaluationError structural operational) Source #
Instance details Defined in PlutusCore.Evaluation.Error Associated Types type Rep (EvaluationError structural operational) ∷ Type → Type Source # Methods from ∷ EvaluationError structural operational → Rep (EvaluationError structural operational) x Source # to ∷ Rep (EvaluationError structural operational) x → EvaluationError structural operational Source #
(Show structural, Show operational) ⇒ Show (EvaluationError structural operational) Source #
Instance details Defined in PlutusCore.Evaluation.Error Methods showsPrec ∷ Int → EvaluationError structural operational → ShowS Source # show ∷ EvaluationError structural operational → String Source # showList ∷ [EvaluationError structural operational] → ShowS Source #
(NFData structural, NFData operational) ⇒ NFData (EvaluationError structural operational) Source #
Instance details Defined in PlutusCore.Evaluation.Error Methods rnf ∷ EvaluationError structural operational → () Source #
(Eq structural, Eq operational) ⇒ Eq (EvaluationError structural operational) Source #
Instance details Defined in PlutusCore.Evaluation.Error Methods (==) ∷ EvaluationError structural operational → EvaluationError structural operational → Bool Source # (/=) ∷ EvaluationError structural operational → EvaluationError structural operational → Bool Source #
(AsUnliftingError structural, AsUnliftingError operational) ⇒ AsUnliftingEvaluationError (EvaluationError structural operational) Source #	An `UnliftingEvaluationError` is an `EvaluationError`, hence for this instance we only require both `structural` and `operational` to have `_UnliftingError` prisms, so that we can handle both the cases pointwisely.
Instance details Defined in PlutusCore.Builtin.Result Methods _UnliftingEvaluationError ∷ Prism' (EvaluationError structural operational) UnliftingEvaluationError Source # _MkUnliftingEvaluationError ∷ Prism' (EvaluationError structural operational) (EvaluationError UnliftingError UnliftingError) Source #
AsEvaluationFailure operational ⇒ AsEvaluationFailure (EvaluationError structural operational) Source #	A raw evaluation failure is always an operational error.
Instance details Defined in PlutusCore.Evaluation.Error Methods _EvaluationFailure ∷ Prism' (EvaluationError structural operational) () Source #
(Pretty structural, Pretty operational) ⇒ Pretty (EvaluationError structural operational) Source #
Instance details Defined in PlutusCore.Evaluation.Error Methods pretty ∷ EvaluationError structural operational → Doc ann Source # prettyList ∷ [EvaluationError structural operational] → Doc ann Source #
structural ~ MachineError fun ⇒ AsMachineError (EvaluationError structural operational) fun Source #
Instance details Defined in PlutusCore.Evaluation.Machine.Exception Methods _MachineError ∷ Prism' (EvaluationError structural operational) (MachineError fun) Source # _NonPolymorphicInstantiationMachineError ∷ Prism' (EvaluationError structural operational) () Source # _NonWrapUnwrappedMachineError ∷ Prism' (EvaluationError structural operational) () Source # _NonFunctionalApplicationMachineError ∷ Prism' (EvaluationError structural operational) () Source # _OpenTermEvaluatedMachineError ∷ Prism' (EvaluationError structural operational) () Source # _UnliftingMachineError ∷ Prism' (EvaluationError structural operational) UnliftingError Source # _BuiltinTermArgumentExpectedMachineError ∷ Prism' (EvaluationError structural operational) () Source # _UnexpectedBuiltinTermArgumentMachineError ∷ Prism' (EvaluationError structural operational) () Source # _NonConstrScrutinized ∷ Prism' (EvaluationError structural operational) () Source # _MissingCaseBranch ∷ Prism' (EvaluationError structural operational) Word64 Source #
AsEvaluationError (EvaluationError structural operational) structural operational Source #
Instance details Defined in PlutusCore.Evaluation.Error Methods _EvaluationError ∷ Prism' (EvaluationError structural operational) (EvaluationError structural operational) Source # _StructuralEvaluationError ∷ Prism' (EvaluationError structural operational) structural Source # _OperationalEvaluationError ∷ Prism' (EvaluationError structural operational) operational Source #
ThrowableBuiltins uni fun ⇒ MonadError (CekEvaluationException NamedDeBruijn uni fun) (CekM uni fun s) Source #
Instance details Defined in UntypedPlutusCore.Evaluation.Machine.Cek.Internal Methods throwError ∷ CekEvaluationException NamedDeBruijn uni fun → CekM uni fun s a Source # catchError ∷ CekM uni fun s a → (CekEvaluationException NamedDeBruijn uni fun → CekM uni fun s a) → CekM uni fun s a Source #
type Rep (EvaluationError structural operational) Source #
Instance details Defined in PlutusCore.Evaluation.Error type Rep (EvaluationError structural operational) = D1 ('MetaData "EvaluationError" "PlutusCore.Evaluation.Error" "plutus-core-1.36.0.0-inplace" 'False) (C1 ('MetaCons "StructuralEvaluationError" 'PrefixI 'False) (S1 ('MetaSel ('Nothing ∷ Maybe Symbol) 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 structural)) :+: C1 ('MetaCons "OperationalEvaluationError" 'PrefixI 'False) (S1 ('MetaSel ('Nothing ∷ Maybe Symbol) 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 operational)))

class AsEvaluationError r structural operational | r → structural operational where Source #

Minimal complete definition

_EvaluationError

Methods

_EvaluationError ∷ Prism' r (EvaluationError structural operational) Source #

_StructuralEvaluationError ∷ Prism' r structural Source #

_OperationalEvaluationError ∷ Prism' r operational Source #

Instances

Instances details

AsEvaluationError UnliftingEvaluationError UnliftingError UnliftingError Source #
Instance details Defined in PlutusCore.Builtin.Result Methods _EvaluationError ∷ Prism' UnliftingEvaluationError (EvaluationError UnliftingError UnliftingError) Source # _StructuralEvaluationError ∷ Prism' UnliftingEvaluationError UnliftingError Source # _OperationalEvaluationError ∷ Prism' UnliftingEvaluationError UnliftingError Source #
AsEvaluationError (EvaluationError structural operational) structural operational Source #
Instance details Defined in PlutusCore.Evaluation.Error Methods _EvaluationError ∷ Prism' (EvaluationError structural operational) (EvaluationError structural operational) Source # _StructuralEvaluationError ∷ Prism' (EvaluationError structural operational) structural Source # _OperationalEvaluationError ∷ Prism' (EvaluationError structural operational) operational Source #

data ErrorWithCause err cause Source #

An error and (optionally) what caused it.

Constructors

ErrorWithCause
Fields _ewcError ∷ !err _ewcCause ∷ !(Maybe cause)

Instances

Instances details

Bifunctor ErrorWithCause Source #
Instance details Defined in PlutusCore.Evaluation.ErrorWithCause Methods bimap ∷ (a → b) → (c → d) → ErrorWithCause a c → ErrorWithCause b d Source # first ∷ (a → b) → ErrorWithCause a c → ErrorWithCause b c Source # second ∷ (b → c) → ErrorWithCause a b → ErrorWithCause a c Source #
(PrettyBy config cause, PrettyBy config err) ⇒ PrettyBy config (ErrorWithCause err cause) Source #
Instance details Defined in PlutusCore.Evaluation.ErrorWithCause Methods prettyBy ∷ config → ErrorWithCause err cause → Doc ann Source # prettyListBy ∷ config → [ErrorWithCause err cause] → Doc ann Source #
Foldable (ErrorWithCause err) Source #
Instance details Defined in PlutusCore.Evaluation.ErrorWithCause Methods fold ∷ Monoid m ⇒ ErrorWithCause err m → m Source # foldMap ∷ Monoid m ⇒ (a → m) → ErrorWithCause err a → m Source # foldMap' ∷ Monoid m ⇒ (a → m) → ErrorWithCause err a → m Source # foldr ∷ (a → b → b) → b → ErrorWithCause err a → b Source # foldr' ∷ (a → b → b) → b → ErrorWithCause err a → b Source # foldl ∷ (b → a → b) → b → ErrorWithCause err a → b Source # foldl' ∷ (b → a → b) → b → ErrorWithCause err a → b Source # foldr1 ∷ (a → a → a) → ErrorWithCause err a → a Source # foldl1 ∷ (a → a → a) → ErrorWithCause err a → a Source # toList ∷ ErrorWithCause err a → [a] Source # null ∷ ErrorWithCause err a → Bool Source # length ∷ ErrorWithCause err a → Int Source # elem ∷ Eq a ⇒ a → ErrorWithCause err a → Bool Source # maximum ∷ Ord a ⇒ ErrorWithCause err a → a Source # minimum ∷ Ord a ⇒ ErrorWithCause err a → a Source # sum ∷ Num a ⇒ ErrorWithCause err a → a Source # product ∷ Num a ⇒ ErrorWithCause err a → a Source #
Traversable (ErrorWithCause err) Source #
Instance details Defined in PlutusCore.Evaluation.ErrorWithCause Methods traverse ∷ Applicative f ⇒ (a → f b) → ErrorWithCause err a → f (ErrorWithCause err b) Source # sequenceA ∷ Applicative f ⇒ ErrorWithCause err (f a) → f (ErrorWithCause err a) Source # mapM ∷ Monad m ⇒ (a → m b) → ErrorWithCause err a → m (ErrorWithCause err b) Source # sequence ∷ Monad m ⇒ ErrorWithCause err (m a) → m (ErrorWithCause err a) Source #
Functor (ErrorWithCause err) Source #
Instance details Defined in PlutusCore.Evaluation.ErrorWithCause Methods fmap ∷ (a → b) → ErrorWithCause err a → ErrorWithCause err b Source # (<$) ∷ a → ErrorWithCause err b → ErrorWithCause err a Source #
(PrettyPlc cause, PrettyPlc err, Typeable cause, Typeable err) ⇒ Exception (ErrorWithCause err cause) Source #
Instance details Defined in PlutusCore.Evaluation.ErrorWithCause Methods toException ∷ ErrorWithCause err cause → SomeException Source # fromException ∷ SomeException → Maybe (ErrorWithCause err cause) Source # displayException ∷ ErrorWithCause err cause → String Source #
Generic (ErrorWithCause err cause) Source #
Instance details Defined in PlutusCore.Evaluation.ErrorWithCause Associated Types type Rep (ErrorWithCause err cause) ∷ Type → Type Source # Methods from ∷ ErrorWithCause err cause → Rep (ErrorWithCause err cause) x Source # to ∷ Rep (ErrorWithCause err cause) x → ErrorWithCause err cause Source #
(PrettyPlc cause, PrettyPlc err) ⇒ Show (ErrorWithCause err cause) Source #
Instance details Defined in PlutusCore.Evaluation.ErrorWithCause Methods showsPrec ∷ Int → ErrorWithCause err cause → ShowS Source # show ∷ ErrorWithCause err cause → String Source # showList ∷ [ErrorWithCause err cause] → ShowS Source #
(NFData err, NFData cause) ⇒ NFData (ErrorWithCause err cause) Source #
Instance details Defined in PlutusCore.Evaluation.ErrorWithCause Methods rnf ∷ ErrorWithCause err cause → () Source #
(Eq err, Eq cause) ⇒ Eq (ErrorWithCause err cause) Source #
Instance details Defined in PlutusCore.Evaluation.ErrorWithCause Methods (==) ∷ ErrorWithCause err cause → ErrorWithCause err cause → Bool Source # (/=) ∷ ErrorWithCause err cause → ErrorWithCause err cause → Bool Source #
AsEvaluationFailure err ⇒ AsEvaluationFailure (ErrorWithCause err cause) Source #
Instance details Defined in PlutusCore.Evaluation.ErrorWithCause Methods _EvaluationFailure ∷ Prism' (ErrorWithCause err cause) () Source #
(Pretty err, Pretty cause) ⇒ Pretty (ErrorWithCause err cause) Source #
Instance details Defined in PlutusCore.Evaluation.ErrorWithCause Methods pretty ∷ ErrorWithCause err cause → Doc ann Source # prettyList ∷ [ErrorWithCause err cause] → Doc ann Source #
ThrowableBuiltins uni fun ⇒ MonadError (CekEvaluationException NamedDeBruijn uni fun) (CekM uni fun s) Source #
Instance details Defined in UntypedPlutusCore.Evaluation.Machine.Cek.Internal Methods throwError ∷ CekEvaluationException NamedDeBruijn uni fun → CekM uni fun s a Source # catchError ∷ CekM uni fun s a → (CekEvaluationException NamedDeBruijn uni fun → CekM uni fun s a) → CekM uni fun s a Source #
type Rep (ErrorWithCause err cause) Source #
Instance details Defined in PlutusCore.Evaluation.ErrorWithCause type Rep (ErrorWithCause err cause) = D1 ('MetaData "ErrorWithCause" "PlutusCore.Evaluation.ErrorWithCause" "plutus-core-1.36.0.0-inplace" 'False) (C1 ('MetaCons "ErrorWithCause" 'PrefixI 'True) (S1 ('MetaSel ('Just "_ewcError") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 err) :*: S1 ('MetaSel ('Just "_ewcCause") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 (Maybe cause))))

type EvaluationException structural operational = ErrorWithCause (EvaluationError structural operational) Source #

throwNotAConstant ∷ MonadError BuiltinError m ⇒ m void Source #

throwing ∷ MonadError e m ⇒ AReview e t → t → m x #

throwing_ ∷ MonadError e m ⇒ AReview e () → m x #

throwingWithCause ∷ ∀ exc e t term m x. (exc ~ ErrorWithCause e term, MonadError exc m) ⇒ AReview e t → t → Maybe term → m x Source #

Prismatically throw an error and its (optional) cause.

splitStructuralOperational ∷ Either (EvaluationException structural operational term) a → Either (ErrorWithCause structural term) (EvaluationResult a) Source #

Preserve the contents of an StructuralEvaluationError as a Left and turn an OperationalEvaluationError into a Right EvaluationFailure (thus erasing the content of the error in the latter case).

unsafeSplitStructuralOperational ∷ (PrettyPlc structural, PrettyPlc term, Typeable structural, Typeable term) ⇒ Either (EvaluationException structural operational term) a → EvaluationResult a Source #

Throw on a StructuralEvaluationError and turn an OperationalEvaluationError into an EvaluationFailure (thus erasing the content of the error in the latter case).