Symantic.CLI.API

Class App

class App repr where

Minimal complete definition

Nothing

Methods

(<.>) :: repr a b -> repr b c -> repr a c infixr 4

(<.>) :: Trans repr => App (UnTrans repr) => repr a b -> repr b c -> repr a c infixr 4

Instances

Ord e => App (Router (Parser e d))

Defined in Symantic.CLI.Parser

Methods

(<.>) :: Router (Parser e d) a b -> Router (Parser e d) b c -> Router (Parser e d) a c

SchemaDoc d => App (Schema d)

Defined in Symantic.CLI.Schema

Methods

(<.>) :: Schema d a b -> Schema d b c -> Schema d a c

LayoutDoc d => App (Layout d)

Defined in Symantic.CLI.Layout

Methods

(<.>) :: Layout d a b -> Layout d b c -> Layout d a c

SchemaDoc d => App (Help d)

Defined in Symantic.CLI.Help

Methods

(<.>) :: Help d a b -> Help d b c -> Help d a c

App (Parser e d)

Defined in Symantic.CLI.Parser

Methods

(<.>) :: Parser e d a b -> Parser e d b c -> Parser e d a c

Class Alt

class Alt repr where

Minimal complete definition

Nothing

Methods

(<!>) :: repr a k -> repr b k -> repr (a :!: b) k infixr 3

alt :: repr a k -> repr a k -> repr a k infixr 3

opt :: repr (a -> k) k -> repr (Maybe a -> k) k

(<!>) :: Trans repr => Alt (UnTrans repr) => repr a k -> repr b k -> repr (a :!: b) k infixr 3

alt :: Trans repr => Alt (UnTrans repr) => repr a k -> repr a k -> repr a k infixr 3

opt :: Trans repr => Alt (UnTrans repr) => repr (a -> k) k -> repr (Maybe a -> k) k

Instances

Ord e => Alt (Router (Parser e d))

Defined in Symantic.CLI.Parser

Methods

(<!>) :: Router (Parser e d) a k -> Router (Parser e d) b k -> Router (Parser e d) (a :!: b) k

alt :: Router (Parser e d) a k -> Router (Parser e d) a k -> Router (Parser e d) a k

opt :: Router (Parser e d) (a -> k) k -> Router (Parser e d) (Maybe a -> k) k

SchemaDoc d => Alt (Schema d)

Defined in Symantic.CLI.Schema

Methods

(<!>) :: Schema d a k -> Schema d b k -> Schema d (a :!: b) k

alt :: Schema d a k -> Schema d a k -> Schema d a k

opt :: Schema d (a -> k) k -> Schema d (Maybe a -> k) k

LayoutDoc d => Alt (Layout d)

Defined in Symantic.CLI.Layout

Methods

(<!>) :: Layout d a k -> Layout d b k -> Layout d (a :!: b) k

alt :: Layout d a k -> Layout d a k -> Layout d a k

opt :: Layout d (a -> k) k -> Layout d (Maybe a -> k) k

SchemaDoc d => Alt (Help d)

Defined in Symantic.CLI.Help

Methods

(<!>) :: Help d a k -> Help d b k -> Help d (a :!: b) k

alt :: Help d a k -> Help d a k -> Help d a k

opt :: Help d (a -> k) k -> Help d (Maybe a -> k) k

Ord e => Alt (Parser e d)

Defined in Symantic.CLI.Parser

Methods

(<!>) :: Parser e d a k -> Parser e d b k -> Parser e d (a :!: b) k

alt :: Parser e d a k -> Parser e d a k -> Parser e d a k

opt :: Parser e d (a -> k) k -> Parser e d (Maybe a -> k) k

Type (:!:)

data a :!: b infixr 3

Like (,) but infixr.

Constructors

a :!: b infixr 3

Class Pro

class Pro repr where

Minimal complete definition

Nothing

Methods

dimap :: (a -> b) -> (b -> a) -> repr (a -> k) k -> repr (b -> k) k

dimap :: Trans repr => Pro (UnTrans repr) => (a -> b) -> (b -> a) -> repr (a -> k) k -> repr (b -> k) k

Instances

Ord e => Pro (Router (Parser e d))

Defined in Symantic.CLI.Parser

Methods

dimap :: (a -> b) -> (b -> a) -> Router (Parser e d) (a -> k) k -> Router (Parser e d) (b -> k) k

Pro (Schema d)

Defined in Symantic.CLI.Schema

Methods

dimap :: (a -> b) -> (b -> a) -> Schema d (a -> k) k -> Schema d (b -> k) k

Pro (Layout d)

Defined in Symantic.CLI.Layout

Methods

dimap :: (a -> b) -> (b -> a) -> Layout d (a -> k) k -> Layout d (b -> k) k

Pro (Help d)

Defined in Symantic.CLI.Help

Methods

dimap :: (a -> b) -> (b -> a) -> Help d (a -> k) k -> Help d (b -> k) k

Pro (Parser e d)

Defined in Symantic.CLI.Parser

Methods

dimap :: (a -> b) -> (b -> a) -> Parser e d (a -> k) k -> Parser e d (b -> k) k

Class AltApp

class AltApp repr where

Minimal complete definition

Nothing

Methods

many0 :: repr (a -> k) k -> repr ([a] -> k) k

many1 :: repr (a -> k) k -> repr ([a] -> k) k

many0 :: Trans repr => AltApp (UnTrans repr) => repr (a -> k) k -> repr ([a] -> k) k

many1 :: Trans repr => AltApp (UnTrans repr) => repr (a -> k) k -> repr ([a] -> k) k

Instances

Ord e => AltApp (Router (Parser e d))

Defined in Symantic.CLI.Parser

Methods

many0 :: Router (Parser e d) (a -> k) k -> Router (Parser e d) ([a] -> k) k

many1 :: Router (Parser e d) (a -> k) k -> Router (Parser e d) ([a] -> k) k

SchemaDoc d => AltApp (Schema d)

Defined in Symantic.CLI.Schema

Methods

many0 :: Schema d (a -> k) k -> Schema d ([a] -> k) k

many1 :: Schema d (a -> k) k -> Schema d ([a] -> k) k

LayoutDoc d => AltApp (Layout d)

Defined in Symantic.CLI.Layout

Methods

many0 :: Layout d (a -> k) k -> Layout d ([a] -> k) k

many1 :: Layout d (a -> k) k -> Layout d ([a] -> k) k

SchemaDoc d => AltApp (Help d)

Defined in Symantic.CLI.Help

Methods

many0 :: Help d (a -> k) k -> Help d ([a] -> k) k

many1 :: Help d (a -> k) k -> Help d ([a] -> k) k

Ord e => AltApp (Parser e d)

Defined in Symantic.CLI.Parser

Methods

many0 :: Parser e d (a -> k) k -> Parser e d ([a] -> k) k

many1 :: Parser e d (a -> k) k -> Parser e d ([a] -> k) k

Class Permutable

class Permutable repr where

Associated Types

type Permutation (repr :: * -> * -> *) = (r :: * -> * -> *) | r -> repr

Methods

runPermutation :: Permutation repr k a -> repr (a -> k) k

toPermutation :: repr (a -> k) k -> Permutation repr k a

toPermDefault :: a -> repr (a -> k) k -> Permutation repr k a

Instances

Ord e => Permutable (Router (Parser e d))

Defined in Symantic.CLI.Parser

Associated Types

type Permutation (Router (Parser e d)) = (r :: Type -> Type -> Type)

Methods

runPermutation :: Permutation (Router (Parser e d)) k a -> Router (Parser e d) (a -> k) k

toPermutation :: Router (Parser e d) (a -> k) k -> Permutation (Router (Parser e d)) k a

toPermDefault :: a -> Router (Parser e d) (a -> k) k -> Permutation (Router (Parser e d)) k a

SchemaDoc d => Permutable (Schema d)

Defined in Symantic.CLI.Schema

Associated Types

type Permutation (Schema d) = (r :: Type -> Type -> Type)

Methods

runPermutation :: Permutation (Schema d) k a -> Schema d (a -> k) k

toPermutation :: Schema d (a -> k) k -> Permutation (Schema d) k a

toPermDefault :: a -> Schema d (a -> k) k -> Permutation (Schema d) k a

(LayoutDoc d, Justifiable d) => Permutable (Layout d)

Defined in Symantic.CLI.Layout

Associated Types

type Permutation (Layout d) = (r :: Type -> Type -> Type)

Methods

runPermutation :: Permutation (Layout d) k a -> Layout d (a -> k) k

toPermutation :: Layout d (a -> k) k -> Permutation (Layout d) k a

toPermDefault :: a -> Layout d (a -> k) k -> Permutation (Layout d) k a

SchemaDoc d => Permutable (Help d)

Defined in Symantic.CLI.Help

Associated Types

type Permutation (Help d) = (r :: Type -> Type -> Type)

Methods

runPermutation :: Permutation (Help d) k a -> Help d (a -> k) k

toPermutation :: Help d (a -> k) k -> Permutation (Help d) k a

toPermDefault :: a -> Help d (a -> k) k -> Permutation (Help d) k a

Ord e => Permutable (Parser e d)

Defined in Symantic.CLI.Parser

Associated Types

type Permutation (Parser e d) = (r :: Type -> Type -> Type)

Methods

runPermutation :: Permutation (Parser e d) k a -> Parser e d (a -> k) k

toPermutation :: Parser e d (a -> k) k -> Permutation (Parser e d) k a

toPermDefault :: a -> Parser e d (a -> k) k -> Permutation (Parser e d) k a

(<?>) :: App repr => Permutable repr => Permutation repr b a -> repr b c -> repr (a -> b) c infixr 4

Convenient wrapper to omit a runPermutation.

opts <?> next = runPermutation opts <.> next

Class Sequenceable

class Sequenceable repr where

Associated Types

type Sequence (repr :: * -> * -> *) = (r :: * -> * -> *) | r -> repr

Methods

runSequence :: Sequence repr k a -> repr (a -> k) k

toSequence :: repr (a -> k) k -> Sequence repr k a

Instances

Ord e => Sequenceable (Router (Parser e d))

Defined in Symantic.CLI.Parser

Associated Types

type Sequence (Router (Parser e d)) = (r :: Type -> Type -> Type)

Methods

runSequence :: Sequence (Router (Parser e d)) k a -> Router (Parser e d) (a -> k) k

toSequence :: Router (Parser e d) (a -> k) k -> Sequence (Router (Parser e d)) k a

SchemaDoc d => Sequenceable (Schema d)

Defined in Symantic.CLI.Schema

Associated Types

type Sequence (Schema d) = (r :: Type -> Type -> Type)

Methods

runSequence :: Sequence (Schema d) k a -> Schema d (a -> k) k

toSequence :: Schema d (a -> k) k -> Sequence (Schema d) k a

(LayoutDoc d, Justifiable d) => Sequenceable (Layout d)

Defined in Symantic.CLI.Layout

Associated Types

type Sequence (Layout d) = (r :: Type -> Type -> Type)

Methods

runSequence :: Sequence (Layout d) k a -> Layout d (a -> k) k

toSequence :: Layout d (a -> k) k -> Sequence (Layout d) k a

Ord e => Sequenceable (Parser e d)

Defined in Symantic.CLI.Parser

Associated Types

type Sequence (Parser e d) = (r :: Type -> Type -> Type)

Methods

runSequence :: Sequence (Parser e d) k a -> Parser e d (a -> k) k

toSequence :: Parser e d (a -> k) k -> Sequence (Parser e d) k a

Type Name

type Name = String

Type Segment

type Segment = String

Class CLI_Command

class CLI_Command repr where

Methods

command :: Name -> repr a k -> repr a k

Instances

repr ~ Parser e d => CLI_Command (Router repr)

Defined in Symantic.CLI.Parser

Methods

command :: Name -> Router repr a k -> Router repr a k

SchemaDoc d => CLI_Command (Schema d)

Defined in Symantic.CLI.Schema

Methods

command :: Name -> Schema d a k -> Schema d a k

(LayoutDoc d, From Name d) => CLI_Command (Layout d)

Defined in Symantic.CLI.Layout

Methods

command :: Name -> Layout d a k -> Layout d a k

SchemaDoc d => CLI_Command (Help d)

Defined in Symantic.CLI.Help

Methods

command :: Name -> Help d a k -> Help d a k

Ord e => CLI_Command (Parser e d)

Defined in Symantic.CLI.Parser

Methods

command :: Name -> Parser e d a k -> Parser e d a k

Class CLI_Var

class CLI_Var repr where

Minimal complete definition

Nothing

Associated Types

type VarConstraint repr a :: Constraint

Methods

var' :: VarConstraint repr a => Name -> repr (a -> k) k

just :: a -> repr (a -> k) k

nothing :: repr k k

var' :: Trans repr => CLI_Var (UnTrans repr) => VarConstraint (UnTrans repr) a => Name -> repr (a -> k) k

just :: Trans repr => CLI_Var (UnTrans repr) => a -> repr (a -> k) k

nothing :: Trans repr => CLI_Var (UnTrans repr) => repr k k

Instances

Ord e => CLI_Var (Router (Parser e d))

Defined in Symantic.CLI.Parser

Associated Types

type VarConstraint (Router (Parser e d)) a :: Constraint

Methods

var' :: VarConstraint (Router (Parser e d)) a => Name -> Router (Parser e d) (a -> k) k

just :: a -> Router (Parser e d) (a -> k) k

nothing :: Router (Parser e d) k k

SchemaDoc d => CLI_Var (Schema d)

Defined in Symantic.CLI.Schema

Associated Types

type VarConstraint (Schema d) a :: Constraint

Methods

var' :: VarConstraint (Schema d) a => Name -> Schema d (a -> k) k

just :: a -> Schema d (a -> k) k

nothing :: Schema d k k

LayoutDoc d => CLI_Var (Layout d)

Defined in Symantic.CLI.Layout

Associated Types

type VarConstraint (Layout d) a :: Constraint

Methods

var' :: VarConstraint (Layout d) a => Name -> Layout d (a -> k) k

just :: a -> Layout d (a -> k) k

nothing :: Layout d k k

SchemaDoc d => CLI_Var (Help d)

Defined in Symantic.CLI.Help

Associated Types

type VarConstraint (Help d) a :: Constraint

Methods

var' :: VarConstraint (Help d) a => Name -> Help d (a -> k) k

just :: a -> Help d (a -> k) k

nothing :: Help d k k

Ord e => CLI_Var (Parser e d)

Defined in Symantic.CLI.Parser

Associated Types

type VarConstraint (Parser e d) a :: Constraint

Methods

var' :: VarConstraint (Parser e d) a => Name -> Parser e d (a -> k) k

just :: a -> Parser e d (a -> k) k

nothing :: Parser e d k k

var :: forall a k repr. CLI_Var repr => VarConstraint repr a => Name -> repr (a -> k) k

Like var' but with the type variable (a) first instead or (repr) so it can be passed using TypeApplications without adding a |@_| for (repr).

Class CLI_Env

class CLI_Env repr where

Minimal complete definition

Nothing

Associated Types

type EnvConstraint repr a :: Constraint

Methods

env' :: EnvConstraint repr a => Name -> repr (a -> k) k

env' :: Trans repr => CLI_Env (UnTrans repr) => EnvConstraint (UnTrans repr) a => Name -> repr (a -> k) k

Instances

Ord e => CLI_Env (Router (Parser e d))

Defined in Symantic.CLI.Parser

Associated Types

type EnvConstraint (Router (Parser e d)) a :: Constraint

Methods

env' :: EnvConstraint (Router (Parser e d)) a => Name -> Router (Parser e d) (a -> k) k

SchemaDoc d => CLI_Env (Schema d)

Defined in Symantic.CLI.Schema

Associated Types

type EnvConstraint (Schema d) a :: Constraint

Methods

env' :: EnvConstraint (Schema d) a => Name -> Schema d (a -> k) k

LayoutDoc d => CLI_Env (Layout d)

Defined in Symantic.CLI.Layout

Associated Types

type EnvConstraint (Layout d) a :: Constraint

Methods

env' :: EnvConstraint (Layout d) a => Name -> Layout d (a -> k) k

SchemaDoc d => CLI_Env (Help d)

Defined in Symantic.CLI.Help

Associated Types

type EnvConstraint (Help d) a :: Constraint

Methods

env' :: EnvConstraint (Help d) a => Name -> Help d (a -> k) k

Ord e => CLI_Env (Parser e d)

Defined in Symantic.CLI.Parser

Associated Types

type EnvConstraint (Parser e d) a :: Constraint

Methods

env' :: EnvConstraint (Parser e d) a => Name -> Parser e d (a -> k) k

env :: forall a k repr. CLI_Env repr => EnvConstraint repr a => Name -> repr (a -> k) k

Like env' but with the type enviable (a) first instead or (repr) so it can be passed using TypeApplications without adding a |@_| for (repr).

Type Tag

data Tag

Constructors

Tag Char Name

TagLong Name

TagShort Char

Instances

Eq Tag

Defined in Symantic.CLI.API

Methods

(==) :: Tag -> Tag -> Bool

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

Show Tag

Defined in Symantic.CLI.API

Methods

showsPrec :: Int -> Tag -> ShowS

show :: Tag -> String

showList :: [Tag] -> ShowS

IsString Tag

Defined in Symantic.CLI.API

Methods

fromString :: String -> Tag

Class CLI_Tag

class (App repr, Permutable repr, CLI_Var repr) => CLI_Tag repr where

Minimal complete definition

Nothing

Associated Types

type TagConstraint repr a :: Constraint

Methods

tag :: Tag -> repr f k -> repr f k

endOpts :: repr k k

flag :: TagConstraint repr Bool => Tag -> Permutation repr k Bool

optionalTag :: TagConstraint repr a => AltApp repr => Alt repr => Pro repr => Tag -> repr (a -> k) k -> Permutation repr k (Maybe a)

defaultTag :: TagConstraint repr a => Tag -> a -> repr (a -> k) k -> Permutation repr k a

requiredTag :: TagConstraint repr a => Tag -> repr (a -> k) k -> Permutation repr k a

many0Tag :: TagConstraint repr a => AltApp repr => Tag -> repr (a -> k) k -> Permutation repr k [a]

many1Tag :: TagConstraint repr a => AltApp repr => Tag -> repr (a -> k) k -> Permutation repr k [a]

tag :: Trans repr => CLI_Tag (UnTrans repr) => Tag -> repr f k -> repr f k

endOpts :: Trans repr => CLI_Tag (UnTrans repr) => repr k k

Instances

Ord e => CLI_Tag (Router (Parser e d))

Defined in Symantic.CLI.Parser

Associated Types

type TagConstraint (Router (Parser e d)) a :: Constraint

Methods

tag :: Tag -> Router (Parser e d) f k -> Router (Parser e d) f k

endOpts :: Router (Parser e d) k k

flag :: TagConstraint (Router (Parser e d)) Bool => Tag -> Permutation (Router (Parser e d)) k Bool

optionalTag :: (TagConstraint (Router (Parser e d)) a, AltApp (Router (Parser e d)), Alt (Router (Parser e d)), Pro (Router (Parser e d))) => Tag -> Router (Parser e d) (a -> k) k -> Permutation (Router (Parser e d)) k (Maybe a)

defaultTag :: TagConstraint (Router (Parser e d)) a => Tag -> a -> Router (Parser e d) (a -> k) k -> Permutation (Router (Parser e d)) k a

requiredTag :: TagConstraint (Router (Parser e d)) a => Tag -> Router (Parser e d) (a -> k) k -> Permutation (Router (Parser e d)) k a

many0Tag :: (TagConstraint (Router (Parser e d)) a, AltApp (Router (Parser e d))) => Tag -> Router (Parser e d) (a -> k) k -> Permutation (Router (Parser e d)) k [a]

many1Tag :: (TagConstraint (Router (Parser e d)) a, AltApp (Router (Parser e d))) => Tag -> Router (Parser e d) (a -> k) k -> Permutation (Router (Parser e d)) k [a]

SchemaDoc d => CLI_Tag (Schema d)

Defined in Symantic.CLI.Schema

Associated Types

type TagConstraint (Schema d) a :: Constraint

Methods

tag :: Tag -> Schema d f k -> Schema d f k

endOpts :: Schema d k k

flag :: TagConstraint (Schema d) Bool => Tag -> Permutation (Schema d) k Bool

optionalTag :: (TagConstraint (Schema d) a, AltApp (Schema d), Alt (Schema d), Pro (Schema d)) => Tag -> Schema d (a -> k) k -> Permutation (Schema d) k (Maybe a)

defaultTag :: TagConstraint (Schema d) a => Tag -> a -> Schema d (a -> k) k -> Permutation (Schema d) k a

requiredTag :: TagConstraint (Schema d) a => Tag -> Schema d (a -> k) k -> Permutation (Schema d) k a

many0Tag :: (TagConstraint (Schema d) a, AltApp (Schema d)) => Tag -> Schema d (a -> k) k -> Permutation (Schema d) k [a]

many1Tag :: (TagConstraint (Schema d) a, AltApp (Schema d)) => Tag -> Schema d (a -> k) k -> Permutation (Schema d) k [a]

(LayoutDoc d, Justifiable d) => CLI_Tag (Layout d)

Defined in Symantic.CLI.Layout

Associated Types

type TagConstraint (Layout d) a :: Constraint

Methods

tag :: Tag -> Layout d f k -> Layout d f k

endOpts :: Layout d k k

flag :: TagConstraint (Layout d) Bool => Tag -> Permutation (Layout d) k Bool

optionalTag :: (TagConstraint (Layout d) a, AltApp (Layout d), Alt (Layout d), Pro (Layout d)) => Tag -> Layout d (a -> k) k -> Permutation (Layout d) k (Maybe a)

defaultTag :: TagConstraint (Layout d) a => Tag -> a -> Layout d (a -> k) k -> Permutation (Layout d) k a

requiredTag :: TagConstraint (Layout d) a => Tag -> Layout d (a -> k) k -> Permutation (Layout d) k a

many0Tag :: (TagConstraint (Layout d) a, AltApp (Layout d)) => Tag -> Layout d (a -> k) k -> Permutation (Layout d) k [a]

many1Tag :: (TagConstraint (Layout d) a, AltApp (Layout d)) => Tag -> Layout d (a -> k) k -> Permutation (Layout d) k [a]

SchemaDoc d => CLI_Tag (Help d)

Defined in Symantic.CLI.Help

Associated Types

type TagConstraint (Help d) a :: Constraint

Methods

tag :: Tag -> Help d f k -> Help d f k

endOpts :: Help d k k

flag :: TagConstraint (Help d) Bool => Tag -> Permutation (Help d) k Bool

optionalTag :: (TagConstraint (Help d) a, AltApp (Help d), Alt (Help d), Pro (Help d)) => Tag -> Help d (a -> k) k -> Permutation (Help d) k (Maybe a)

defaultTag :: TagConstraint (Help d) a => Tag -> a -> Help d (a -> k) k -> Permutation (Help d) k a

requiredTag :: TagConstraint (Help d) a => Tag -> Help d (a -> k) k -> Permutation (Help d) k a

many0Tag :: (TagConstraint (Help d) a, AltApp (Help d)) => Tag -> Help d (a -> k) k -> Permutation (Help d) k [a]

many1Tag :: (TagConstraint (Help d) a, AltApp (Help d)) => Tag -> Help d (a -> k) k -> Permutation (Help d) k [a]

Ord e => CLI_Tag (Parser e d)

Defined in Symantic.CLI.Parser

Associated Types

type TagConstraint (Parser e d) a :: Constraint

Methods

tag :: Tag -> Parser e d f k -> Parser e d f k

endOpts :: Parser e d k k

flag :: TagConstraint (Parser e d) Bool => Tag -> Permutation (Parser e d) k Bool

optionalTag :: (TagConstraint (Parser e d) a, AltApp (Parser e d), Alt (Parser e d), Pro (Parser e d)) => Tag -> Parser e d (a -> k) k -> Permutation (Parser e d) k (Maybe a)

defaultTag :: TagConstraint (Parser e d) a => Tag -> a -> Parser e d (a -> k) k -> Permutation (Parser e d) k a

requiredTag :: TagConstraint (Parser e d) a => Tag -> Parser e d (a -> k) k -> Permutation (Parser e d) k a

many0Tag :: (TagConstraint (Parser e d) a, AltApp (Parser e d)) => Tag -> Parser e d (a -> k) k -> Permutation (Parser e d) k [a]

many1Tag :: (TagConstraint (Parser e d) a, AltApp (Parser e d)) => Tag -> Parser e d (a -> k) k -> Permutation (Parser e d) k [a]

Class CLI_Response

class CLI_Response repr where

Minimal complete definition

Nothing

Associated Types

type ResponseConstraint repr a :: Constraint

type ResponseArgs repr a :: *

type Response repr :: *

Methods

response' :: ResponseConstraint repr a => repr (ResponseArgs repr a) (Response repr)

response' :: forall a. Trans repr => CLI_Response (UnTrans repr) => ResponseConstraint (UnTrans repr) a => ResponseArgs repr a ~ ResponseArgs (UnTrans repr) a => Response repr ~ Response (UnTrans repr) => repr (ResponseArgs repr a) (Response repr)

Instances

Ord e => CLI_Response (Router (Parser e d))

Defined in Symantic.CLI.Parser

Associated Types

type ResponseConstraint (Router (Parser e d)) a :: Constraint

type ResponseArgs (Router (Parser e d)) a :: Type

type Response (Router (Parser e d)) :: Type

Methods

response' :: ResponseConstraint (Router (Parser e d)) a => Router (Parser e d) (ResponseArgs (Router (Parser e d)) a) (Response (Router (Parser e d)))

SchemaDoc d => CLI_Response (Schema d)

Defined in Symantic.CLI.Schema

Associated Types

type ResponseConstraint (Schema d) a :: Constraint

type ResponseArgs (Schema d) a :: Type

type Response (Schema d) :: Type

Methods

response' :: ResponseConstraint (Schema d) a => Schema d (ResponseArgs (Schema d) a) (Response (Schema d))

LayoutDoc d => CLI_Response (Layout d)

Defined in Symantic.CLI.Layout

Associated Types

type ResponseConstraint (Layout d) a :: Constraint

type ResponseArgs (Layout d) a :: Type

type Response (Layout d) :: Type

Methods

response' :: ResponseConstraint (Layout d) a => Layout d (ResponseArgs (Layout d) a) (Response (Layout d))

SchemaDoc d => CLI_Response (Help d)

Defined in Symantic.CLI.Help

Associated Types

type ResponseConstraint (Help d) a :: Constraint

type ResponseArgs (Help d) a :: Type

type Response (Help d) :: Type

Methods

response' :: ResponseConstraint (Help d) a => Help d (ResponseArgs (Help d) a) (Response (Help d))

Ord e => CLI_Response (Parser e d)

Defined in Symantic.CLI.Parser

Associated Types

type ResponseConstraint (Parser e d) a :: Constraint

type ResponseArgs (Parser e d) a :: Type

type Response (Parser e d) :: Type

Methods

response' :: ResponseConstraint (Parser e d) a => Parser e d (ResponseArgs (Parser e d) a) (Response (Parser e d))

response :: forall a repr. CLI_Response repr => ResponseConstraint repr a => repr (ResponseArgs repr a) (Response repr)

Class CLI_Help

class CLI_Help repr where

Minimal complete definition

Nothing

Associated Types

type HelpConstraint repr d :: Constraint

Methods

help :: HelpConstraint repr d => d -> repr f k -> repr f k infixr 0

program :: Name -> repr f k -> repr f k

rule :: Name -> repr f k -> repr f k

program :: Trans repr => CLI_Help (UnTrans repr) => Name -> repr f k -> repr f k

rule :: Trans repr => CLI_Help (UnTrans repr) => Name -> repr f k -> repr f k

Instances

CLI_Help (Router (Parser e d))

Defined in Symantic.CLI.Parser

Associated Types

type HelpConstraint (Router (Parser e d)) d :: Constraint

Methods

help :: HelpConstraint (Router (Parser e d)) d0 => d0 -> Router (Parser e d) f k -> Router (Parser e d) f k

program :: Name -> Router (Parser e d) f k -> Router (Parser e d) f k

rule :: Name -> Router (Parser e d) f k -> Router (Parser e d) f k

SchemaDoc d => CLI_Help (SchemaPerm d)

Defined in Symantic.CLI.Schema

Associated Types

type HelpConstraint (SchemaPerm d) d :: Constraint

Methods

help :: HelpConstraint (SchemaPerm d) d0 => d0 -> SchemaPerm d f k -> SchemaPerm d f k

program :: Name -> SchemaPerm d f k -> SchemaPerm d f k

rule :: Name -> SchemaPerm d f k -> SchemaPerm d f k

SchemaDoc d => CLI_Help (SchemaSeq d)

Defined in Symantic.CLI.Schema

Associated Types

type HelpConstraint (SchemaSeq d) d :: Constraint

Methods

help :: HelpConstraint (SchemaSeq d) d0 => d0 -> SchemaSeq d f k -> SchemaSeq d f k

program :: Name -> SchemaSeq d f k -> SchemaSeq d f k

rule :: Name -> SchemaSeq d f k -> SchemaSeq d f k

SchemaDoc d => CLI_Help (Schema d)

Defined in Symantic.CLI.Schema

Associated Types

type HelpConstraint (Schema d) d :: Constraint

Methods

help :: HelpConstraint (Schema d) d0 => d0 -> Schema d f k -> Schema d f k

program :: Name -> Schema d f k -> Schema d f k

rule :: Name -> Schema d f k -> Schema d f k

LayoutDoc d => CLI_Help (LayoutPerm d)

Defined in Symantic.CLI.Layout

Associated Types

type HelpConstraint (LayoutPerm d) d :: Constraint

Methods

help :: HelpConstraint (LayoutPerm d) d0 => d0 -> LayoutPerm d f k -> LayoutPerm d f k

program :: Name -> LayoutPerm d f k -> LayoutPerm d f k

rule :: Name -> LayoutPerm d f k -> LayoutPerm d f k

LayoutDoc d => CLI_Help (LayoutSeq d)

Defined in Symantic.CLI.Layout

Associated Types

type HelpConstraint (LayoutSeq d) d :: Constraint

Methods

help :: HelpConstraint (LayoutSeq d) d0 => d0 -> LayoutSeq d f k -> LayoutSeq d f k

program :: Name -> LayoutSeq d f k -> LayoutSeq d f k

rule :: Name -> LayoutSeq d f k -> LayoutSeq d f k

LayoutDoc d => CLI_Help (Layout d)

Defined in Symantic.CLI.Layout

Associated Types

type HelpConstraint (Layout d) d :: Constraint

Methods

help :: HelpConstraint (Layout d) d0 => d0 -> Layout d f k -> Layout d f k

program :: Name -> Layout d f k -> Layout d f k

rule :: Name -> Layout d f k -> Layout d f k

SchemaDoc d => CLI_Help (HelpPerm d)

Defined in Symantic.CLI.Help

Associated Types

type HelpConstraint (HelpPerm d) d :: Constraint

Methods

help :: HelpConstraint (HelpPerm d) d0 => d0 -> HelpPerm d f k -> HelpPerm d f k

program :: Name -> HelpPerm d f k -> HelpPerm d f k

rule :: Name -> HelpPerm d f k -> HelpPerm d f k

SchemaDoc d => CLI_Help (Help d)

Defined in Symantic.CLI.Help

Associated Types

type HelpConstraint (Help d) d :: Constraint

Methods

help :: HelpConstraint (Help d) d0 => d0 -> Help d f k -> Help d f k

program :: Name -> Help d f k -> Help d f k

rule :: Name -> Help d f k -> Help d f k

Ord e => CLI_Help (Parser e d)

Defined in Symantic.CLI.Parser

Associated Types

type HelpConstraint (Parser e d) d :: Constraint

Methods

help :: HelpConstraint (Parser e d) d0 => d0 -> Parser e d f k -> Parser e d f k

program :: Name -> Parser e d f k -> Parser e d f k

rule :: Name -> Parser e d f k -> Parser e d f k

CLI_Help repr => CLI_Help (ParserPerm e d repr)

Defined in Symantic.CLI.Parser

Associated Types

type HelpConstraint (ParserPerm e d repr) d :: Constraint

Methods

help :: HelpConstraint (ParserPerm e d repr) d0 => d0 -> ParserPerm e d repr f k -> ParserPerm e d repr f k

program :: Name -> ParserPerm e d repr f k -> ParserPerm e d repr f k

rule :: Name -> ParserPerm e d repr f k -> ParserPerm e d repr f k

Type Trans

class Trans repr where

Associated Types

type UnTrans repr :: * -> * -> *

The (repr)esentation that (repr) Transforms.

Methods

noTrans :: UnTrans repr a b -> repr a b

Lift the underlying (repr)esentation to (repr). Useful to define a combinator that does nothing in a Transformation.

unTrans :: repr a b -> UnTrans repr a b

Unlift a (repr)esentation. Useful when a Transformation combinator needs to access the UnTransformed (repr)esentation, or at the end to get the underlying UnTransformed (repr)esentation from the inferred (repr) value (eg. in server).

Instances

Ord e => Trans (Router (Parser e d))

Defined in Symantic.CLI.Parser

Associated Types

type UnTrans (Router (Parser e d)) :: Type -> Type -> Type

Methods

noTrans :: UnTrans (Router (Parser e d)) a b -> Router (Parser e d) a b

unTrans :: Router (Parser e d) a b -> UnTrans (Router (Parser e d)) a b