Safe Haskell	Safe-Inferred
Language	Haskell2010

Morley.Michelson.Internal.ViewName

Description

Michelson view name.

Synopsis

newtype ViewName = UnsafeViewName {
- unViewName :: Text
}
data BadViewNameError
- = BadViewTooLong Int
- | BadViewIllegalChars Text
pattern ViewName :: Text -> ViewName
mkViewName :: Text -> Either BadViewNameError ViewName
viewNameToMText :: ViewName -> MText
isValidViewNameChar :: Char -> Bool
viewNameMaxLength :: Int
renderViewName :: ViewName -> Doc

Documentation

newtype ViewName Source #

Name of the view.

It must not exceed 31 chars length;
Must use [a-zA-Z0-9_.%@] charset.

Constructors

UnsafeViewName
Fields unViewName :: Text

Instances

Instances details

FromJSON ViewName Source #
Instance details Defined in Morley.Michelson.Internal.ViewName Methods parseJSON :: Value -> Parser ViewName # parseJSONList :: Value -> Parser [ViewName] #
FromJSONKey ViewName Source #
Instance details Defined in Morley.Michelson.Internal.ViewName Methods fromJSONKey :: FromJSONKeyFunction ViewName # fromJSONKeyList :: FromJSONKeyFunction [ViewName] #
ToJSON ViewName Source #
Instance details Defined in Morley.Michelson.Internal.ViewName Methods toJSON :: ViewName -> Value # toEncoding :: ViewName -> Encoding # toJSONList :: [ViewName] -> Value # toEncodingList :: [ViewName] -> Encoding #
ToJSONKey ViewName Source #
Instance details Defined in Morley.Michelson.Internal.ViewName Methods toJSONKey :: ToJSONKeyFunction ViewName # toJSONKeyList :: ToJSONKeyFunction [ViewName] #
Data ViewName Source #
Instance details 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 Source #
Instance details 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 Source #
Instance details Defined in Morley.Michelson.Internal.ViewName Methods showsPrec :: Int -> ViewName -> ShowS # show :: ViewName -> String # showList :: [ViewName] -> ShowS #
NFData ViewName Source #
Instance details Defined in Morley.Michelson.Internal.ViewName Methods rnf :: ViewName -> () #
Eq ViewName Source #
Instance details Defined in Morley.Michelson.Internal.ViewName Methods (==) :: ViewName -> ViewName -> Bool # (/=) :: ViewName -> ViewName -> Bool #
Ord ViewName Source #
Instance details 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 Source #
Instance details Defined in Morley.Micheline.Class Methods toExpression :: ViewName -> Expression Source #
RenderDoc ViewName Source #
Instance details Defined in Morley.Michelson.Internal.ViewName Methods renderDoc :: RenderContext -> ViewName -> Doc Source # isRenderable :: ViewName -> Bool Source #
HasCLReader ViewName Source #
Instance details Defined in Morley.Michelson.Internal.ViewName Methods getReader :: ReadM ViewName Source # getMetavar :: String Source #
Buildable ViewName Source #
Instance details Defined in Morley.Michelson.Internal.ViewName Methods build :: ViewName -> Doc buildList :: [ViewName] -> Doc
FromExp x ViewName Source #
Instance details Defined in Morley.Micheline.Class Methods fromExp :: Exp x -> Either (FromExpError x) ViewName Source #
type Rep ViewName Source #
Instance details 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 BadViewNameError Source #

Constructors

BadViewTooLong Int
BadViewIllegalChars Text

Instances

Instances details

Data BadViewNameError Source #
Instance details Defined in Morley.Michelson.Internal.ViewName Methods gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> BadViewNameError -> c BadViewNameError # gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c BadViewNameError # toConstr :: BadViewNameError -> Constr # dataTypeOf :: BadViewNameError -> DataType # dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c BadViewNameError) # dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c BadViewNameError) # gmapT :: (forall b. Data b => b -> b) -> BadViewNameError -> BadViewNameError # gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> BadViewNameError -> r # gmapQr :: forall r r'. (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> BadViewNameError -> r # gmapQ :: (forall d. Data d => d -> u) -> BadViewNameError -> [u] # gmapQi :: Int -> (forall d. Data d => d -> u) -> BadViewNameError -> u # gmapM :: Monad m => (forall d. Data d => d -> m d) -> BadViewNameError -> m BadViewNameError # gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> BadViewNameError -> m BadViewNameError # gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> BadViewNameError -> m BadViewNameError #
Generic BadViewNameError Source #
Instance details Defined in Morley.Michelson.Internal.ViewName Associated Types type Rep BadViewNameError :: Type -> Type # Methods from :: BadViewNameError -> Rep BadViewNameError x # to :: Rep BadViewNameError x -> BadViewNameError #
Show BadViewNameError Source #
Instance details Defined in Morley.Michelson.Internal.ViewName Methods showsPrec :: Int -> BadViewNameError -> ShowS # show :: BadViewNameError -> String # showList :: [BadViewNameError] -> ShowS #
NFData BadViewNameError Source #
Instance details Defined in Morley.Michelson.Internal.ViewName Methods rnf :: BadViewNameError -> () #
Eq BadViewNameError Source #
Instance details Defined in Morley.Michelson.Internal.ViewName Methods (==) :: BadViewNameError -> BadViewNameError -> Bool # (/=) :: BadViewNameError -> BadViewNameError -> Bool #
Ord BadViewNameError Source #
Instance details Defined in Morley.Michelson.Internal.ViewName Methods compare :: BadViewNameError -> BadViewNameError -> Ordering # (<) :: BadViewNameError -> BadViewNameError -> Bool # (<=) :: BadViewNameError -> BadViewNameError -> Bool # (>) :: BadViewNameError -> BadViewNameError -> Bool # (>=) :: BadViewNameError -> BadViewNameError -> Bool # max :: BadViewNameError -> BadViewNameError -> BadViewNameError # min :: BadViewNameError -> BadViewNameError -> BadViewNameError #
Buildable BadViewNameError Source #
Instance details Defined in Morley.Michelson.Internal.ViewName Methods build :: BadViewNameError -> Doc buildList :: [BadViewNameError] -> Doc
type Rep BadViewNameError Source #
Instance details Defined in Morley.Michelson.Internal.ViewName type Rep BadViewNameError = D1 ('MetaData "BadViewNameError" "Morley.Michelson.Internal.ViewName" "morley-1.20.0-inplace" 'False) (C1 ('MetaCons "BadViewTooLong" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int)) :+: C1 ('MetaCons "BadViewIllegalChars" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))

pattern ViewName :: Text -> ViewName Source #

mkViewName :: Text -> Either BadViewNameError ViewName Source #

Construct ViewName performing all the checks.

viewNameToMText :: ViewName -> MText Source #

Valid view names form a subset of valid Michelson texts.

isValidViewNameChar :: Char -> Bool Source #

Whether the given character is valid for a view.

viewNameMaxLength :: Int Source #

Maximum allowed name length for a view.

renderViewName :: ViewName -> Doc Source #