plutarch
Safe HaskellNone
LanguageGHC2021

Plutarch.Maybe

Synopsis

Type

data PMaybe (a :: S -> Type) (s :: S) Source #

Since: 1.10.0

Constructors

PJust (Term s a) 
PNothing 

Instances

Instances details
PEq a => PEq (PMaybe a) Source #

Since: 1.10.0

Instance details

Defined in Plutarch.Maybe

Methods

(#==) :: forall (s :: S). Term s (PMaybe a) -> Term s (PMaybe a) -> Term s PBool Source #

PLiftable a => PLiftable (PMaybe a) Source #

Since: 1.10.0

Instance details

Defined in Plutarch.Maybe

Associated Types

type AsHaskell (PMaybe a) 
Instance details

Defined in Plutarch.Maybe

type AsHaskell (PMaybe a) = Maybe (AsHaskell a)
type PlutusRepr (PMaybe a) 
Instance details

Defined in Plutarch.Maybe

type PlutusRepr (PMaybe a) = PLiftedClosed (PMaybe a)

Methods

haskToRepr :: AsHaskell (PMaybe a) -> PlutusRepr (PMaybe a) Source #

reprToHask :: PlutusRepr (PMaybe a) -> Either LiftError (AsHaskell (PMaybe a)) Source #

reprToPlut :: forall (s :: S). PlutusRepr (PMaybe a) -> PLifted s (PMaybe a) Source #

plutToRepr :: (forall (s :: S). PLifted s (PMaybe a)) -> Either LiftError (PlutusRepr (PMaybe a)) Source #

PlutusType (PMaybe a) Source # 
Instance details

Defined in Plutarch.Maybe

Associated Types

type PInner (PMaybe a)

Since: plutarch-1.10.0

Instance details

Defined in Plutarch.Maybe

type PInner (PMaybe a) = PInner (DeriveAsSOPStruct (PMaybe a))

Methods

pcon' :: forall (s :: S). PMaybe a s -> Term s (PInner (PMaybe a)) Source #

pmatch' :: forall (s :: S) (b :: S -> Type). Term s (PInner (PMaybe a)) -> (PMaybe a s -> Term s b) -> Term s b Source #

PShow a => PShow (PMaybe a) Source #

Since: 1.10.0

Instance details

Defined in Plutarch.Internal.Show

Methods

pshow' :: forall (s :: S). Bool -> Term s (PMaybe a) -> Term s PString Source #

Generic (PMaybe a s) Source # 
Instance details

Defined in Plutarch.Maybe

Associated Types

type Rep (PMaybe a s)

Since: plutarch-1.10.0

Instance details

Defined in Plutarch.Maybe

type Rep (PMaybe a s) = D1 ('MetaData "PMaybe" "Plutarch.Maybe" "plutarch-1.14.0-6fw3gqGsL7f3TFINWPu1lG" 'False) (C1 ('MetaCons "PJust" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Term s a))) :+: C1 ('MetaCons "PNothing" 'PrefixI 'False) (U1 :: Type -> Type))

Methods

from :: PMaybe a s -> Rep (PMaybe a s) x Source #

to :: Rep (PMaybe a s) x -> PMaybe a s Source #

Generic (PMaybe a s) Source # 
Instance details

Defined in Plutarch.Maybe

Associated Types

type Code (PMaybe a s)

Since: plutarch-1.10.0

Instance details

Defined in Plutarch.Maybe

type Code (PMaybe a s) = GCode (PMaybe a s)

Methods

from :: PMaybe a s -> Rep (PMaybe a s)

to :: Rep (PMaybe a s) -> PMaybe a s

type AsHaskell (PMaybe a) Source # 
Instance details

Defined in Plutarch.Maybe

type AsHaskell (PMaybe a) = Maybe (AsHaskell a)
type PlutusRepr (PMaybe a) Source # 
Instance details

Defined in Plutarch.Maybe

type PlutusRepr (PMaybe a) = PLiftedClosed (PMaybe a)
type PInner (PMaybe a) Source #

Since: 1.10.0

Instance details

Defined in Plutarch.Maybe

type PInner (PMaybe a) = PInner (DeriveAsSOPStruct (PMaybe a))
type Rep (PMaybe a s) Source #

Since: 1.10.0

Instance details

Defined in Plutarch.Maybe

type Rep (PMaybe a s) = D1 ('MetaData "PMaybe" "Plutarch.Maybe" "plutarch-1.14.0-6fw3gqGsL7f3TFINWPu1lG" 'False) (C1 ('MetaCons "PJust" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Term s a))) :+: C1 ('MetaCons "PNothing" 'PrefixI 'False) (U1 :: Type -> Type))
type Code (PMaybe a s) Source #

Since: 1.10.0

Instance details

Defined in Plutarch.Maybe

type Code (PMaybe a s) = GCode (PMaybe a s)

Functions

Constructors

pjust :: forall (a :: S -> Type) (s :: S). Term s (a :--> PMaybe a) Source #

Construct a PJust value.

Since: 1.10.0

pnothing :: forall (a :: S -> Type) (s :: S). Term s (PMaybe a) Source #

Construct a PNothing value.

Since: 1.10.0

Predicates

pisJust :: forall (a :: S -> Type) (s :: S). Term s (PMaybe a :--> PBool) Source #

Yields true if the given PMaybe value is of form PJust _.

Since: 1.10.0

Eliminators

pfromJust :: forall (a :: S -> Type) (s :: S). Term s (PMaybe a :--> a) Source #

Extracts the element out of a PJust and throws an error if its argument is PNothing.

ptraceIfNothing Source #

Arguments

:: forall (a :: S -> Type) (s :: S). Term s PString

The custom error message.

-> Term s (PMaybe a) 
-> Term s a 

Extracts the element out of a PJust and throws a custom error if it's given a PNothing.

Since: 1.10.0

pfromMaybe :: forall (a :: S -> Type) (s :: S). Term s (a :--> (PMaybe a :--> a)) Source #

Extract a PMaybe by providing a default value in case of PJust.

Since: 1.10.0

pmaybe :: forall (b :: S -> Type) (a :: S -> Type) (s :: S). Term s (b :--> ((a :--> b) :--> (PMaybe a :--> b))) Source #

Given a default value, a function and a PMaybe value, yields the default value if the PMaybe value is PNothing and applies the function to the value stored in the PJust otherwise.

Since: 1.10.0

passertPJust :: forall (a :: S -> Type) (s :: S). Term s (PString :--> (PMaybe a :--> a)) Source #

Extract the value stored in a PMaybe container. If there's no value, throw an error with the given message.

Since: 1.10.0

Misc

pmapDropNothing :: forall (b :: S -> Type) (a :: S -> Type) (list :: (S -> Type) -> S -> Type) (s :: S). (PListLike list, PElemConstraint list a, PElemConstraint list b) => Term s ((a :--> PMaybe b) :--> (list a :--> list b)) Source #

O(n) . Map a function returning PMaybe over a list of elements, discarding all PNothing results.

Since: 1.12.0

pmapMaybe :: forall (a :: S -> Type) (b :: S -> Type) (s :: S). Term s ((a :--> b) :--> (PMaybe a :--> PMaybe b)) Source #

Map underlying value if PMaybe is PJust, do nothing if it is PNothing

Since: 1.10.0