Lorentz.ViewBase

Documentation

data ViewTyInfo

Type-level information about a view.

Constructors

ViewTyInfo Symbol Type Type

type family (name :: Symbol) ?:: (tys :: (Type, Type)) where ... infix 3

Neat constructor for ViewTyInfo.

type View = "view" ?:: Integer >-> Natural

Equations

name ?:: '(arg, ret) = 'ViewTyInfo name arg ret

type (>->) arg ret = '(arg, ret) infix 5

data ViewsList (vl :: [ViewTyInfo])

A views descriptor that directly carries the full list of views.

Instances

type RevealViews (ViewsList info)

Defined in Lorentz.ViewBase

type RevealViews (ViewsList info) = info

type family RevealViews (desc :: Type) :: [ViewTyInfo]

Get a list of views by a descriptor object.

The problem this type family solves: it is unpleasant to carry around a list of views because it may be large, and if we merely hide this list under a type alias, error messages will still mention the type alias expanded. We want e.g. Contract Parameter Storage Views to be carried as-is. Parameter and Storage are usually datatypes and they are fine, while for Views to be not automatically expanded we have to take special care.

You can still provide the list of ViewTyInfos to this type family using ViewsList, but generally prefer creating a dedicated datatype that would expand to a views list.

Instances

type RevealViews ()

Defined in Lorentz.ViewBase

type RevealViews () = '[] :: [ViewTyInfo]

type RevealViews (ViewsList info)

Defined in Lorentz.ViewBase

type RevealViews (ViewsList info) = info

type family LookupView (name :: Symbol) (views :: [ViewTyInfo]) :: (Type, Type) where ...

Find a view in a contract by name.

Equations

LookupView name '[] = TypeError (('Text "View " ':<>: 'ShowType name) ':<>: 'Text " is not found")

LookupView name ('ViewTyInfo name arg ret ': _) = '(arg, ret)

LookupView name ('ViewTyInfo _ _ _ ': vs) = LookupView name vs

type LookupRevealView name viewRef = LookupView name (RevealViews viewRef)

Reveal views and find a view there.

type HasView vd name arg ret = LookupRevealView name vd ~ '(arg, ret)

Constraint indicating that presence of the view with the specified parameters is implied by the views descriptor.

type family ViewsNames (vs :: [ViewTyInfo]) :: [Symbol] where ...

Map views to get their names.

Equations

ViewsNames '[] = '[]

ViewsNames ('ViewTyInfo name _ _ ': vs) = name ': ViewsNames vs

newtype ViewName

Constructors

UnsafeViewName

Fields

• unViewName :: Text

Bundled Patterns

pattern ViewName :: Text -> ViewName

Instances

FromJSON ViewName

Defined in Morley.Michelson.Internal.ViewName

Methods

parseJSON :: Value -> Parser ViewName

parseJSONList :: Value -> Parser [ViewName]

FromJSONKey ViewName

Defined in Morley.Michelson.Internal.ViewName

Methods

fromJSONKey :: FromJSONKeyFunction ViewName

fromJSONKeyList :: FromJSONKeyFunction [ViewName]

ToJSON ViewName

Defined in Morley.Michelson.Internal.ViewName

Methods

toJSON :: ViewName -> Value

toEncoding :: ViewName -> Encoding

toJSONList :: [ViewName] -> Value

toEncodingList :: [ViewName] -> Encoding

ToJSONKey ViewName

Defined in Morley.Michelson.Internal.ViewName

Methods

toJSONKey :: ToJSONKeyFunction ViewName

toJSONKeyList :: ToJSONKeyFunction [ViewName]

Data ViewName

Defined in Morley.Michelson.Internal.ViewName

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> ViewName -> c ViewName

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c ViewName

toConstr :: ViewName -> Constr

dataTypeOf :: ViewName -> DataType

dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c ViewName)

dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c ViewName)

gmapT :: (forall b. Data b => b -> b) -> ViewName -> ViewName

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> ViewName -> r

gmapQr :: forall r r'. (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> ViewName -> r

gmapQ :: (forall d. Data d => d -> u) -> ViewName -> [u]

gmapQi :: Int -> (forall d. Data d => d -> u) -> ViewName -> u

gmapM :: Monad m => (forall d. Data d => d -> m d) -> ViewName -> m ViewName

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> ViewName -> m ViewName

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> ViewName -> m ViewName

Generic ViewName

Defined in Morley.Michelson.Internal.ViewName

Associated Types

type Rep ViewName :: Type -> Type

Methods

from :: ViewName -> Rep ViewName x

to :: Rep ViewName x -> ViewName

Show ViewName

Defined in Morley.Michelson.Internal.ViewName

Methods

showsPrec :: Int -> ViewName -> ShowS

show :: ViewName -> String

showList :: [ViewName] -> ShowS

NFData ViewName

Defined in Morley.Michelson.Internal.ViewName

Methods

rnf :: ViewName -> ()

Eq ViewName

Defined in Morley.Michelson.Internal.ViewName

Methods

(==) :: ViewName -> ViewName -> Bool

(/=) :: ViewName -> ViewName -> Bool

Ord ViewName

Defined in Morley.Michelson.Internal.ViewName

Methods

compare :: ViewName -> ViewName -> Ordering

(<) :: ViewName -> ViewName -> Bool

(<=) :: ViewName -> ViewName -> Bool

(>) :: ViewName -> ViewName -> Bool

(>=) :: ViewName -> ViewName -> Bool

max :: ViewName -> ViewName -> ViewName

min :: ViewName -> ViewName -> ViewName

ToExpression ViewName

Defined in Morley.Micheline.Class

Methods

toExpression :: ViewName -> Expression

RenderDoc ViewName

Defined in Morley.Michelson.Internal.ViewName

Methods

renderDoc :: RenderContext -> ViewName -> Doc

isRenderable :: ViewName -> Bool

HasCLReader ViewName

Defined in Morley.Michelson.Internal.ViewName

Methods

getReader :: ReadM ViewName

getMetavar :: String

Buildable ViewName

Defined in Morley.Michelson.Internal.ViewName

Methods

build :: ViewName -> Doc

buildList :: [ViewName] -> Doc

FromExp x ViewName

Defined in Morley.Micheline.Class

Methods

fromExp :: Exp x -> Either (FromExpError x) ViewName

type Rep ViewName

Defined in Morley.Michelson.Internal.ViewName

type Rep ViewName = D1 ('MetaData "ViewName" "Morley.Michelson.Internal.ViewName" "morley-1.20.0-inplace" 'True) (C1 ('MetaCons "UnsafeViewName" 'PrefixI 'True) (S1 ('MetaSel ('Just "unViewName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text)))

data ViewInterface

Interface of a single view at term-level.

Constructors

ViewInterface

Fields

• viName :: ViewName
• viArg :: T
• viRet :: T

demoteViewName :: forall name. (KnownSymbol name, HasCallStack) => ViewName

Demote view name from type level to term level.

demoteViewTyInfos :: forall (vs :: [ViewTyInfo]). DemoteViewTyInfo vs => [ViewInterface]

Demote ViewTyInfos to ViewInterfaces.

type DemoteViewsDescriptor vd = DemoteViewTyInfo (RevealViews vd)

demoteViewsDescriptor :: forall (vd :: Type). DemoteViewTyInfo (RevealViews vd) => [ViewInterface]

Demote views descriptor to ViewInterfaces.

data ViewInterfaceMatchError

Constructors

VIMViewNotFound ViewName

VIMViewArgMismatch (MismatchError T)

VIMViewRetMismatch (MismatchError T)

Instances

Exception ViewInterfaceMatchError

Defined in Lorentz.ViewBase

Methods

toException :: ViewInterfaceMatchError -> SomeException

fromException :: SomeException -> Maybe ViewInterfaceMatchError

displayException :: ViewInterfaceMatchError -> String

Show ViewInterfaceMatchError

Defined in Lorentz.ViewBase

Methods

showsPrec :: Int -> ViewInterfaceMatchError -> ShowS

show :: ViewInterfaceMatchError -> String

showList :: [ViewInterfaceMatchError] -> ShowS

Eq ViewInterfaceMatchError

Defined in Lorentz.ViewBase

Methods

(==) :: ViewInterfaceMatchError -> ViewInterfaceMatchError -> Bool

(/=) :: ViewInterfaceMatchError -> ViewInterfaceMatchError -> Bool

Buildable ViewInterfaceMatchError

Defined in Lorentz.ViewBase

Methods

build :: ViewInterfaceMatchError -> Doc

buildList :: [ViewInterfaceMatchError] -> Doc

checkViewsCoverInterface :: forall st. [ViewInterface] -> ViewsSet st -> Either ViewInterfaceMatchError ()

Check that the given set of views covers the given view interfaces. Extra views in the set, that do not appear in the interface, are fine.