-- Hoogle documentation, generated by Haddock
-- See Hoogle, http://www.haskell.org/hoogle/


-- | CLI option parsers for NetSpider objects
--   
--   CLI option parsers for NetSpider objects. See <a>NetSpider.CLI</a>.
@package net-spider-cli
@version 0.2.0.1


-- | This module defines CLI option parser for <a>Query</a> for snapshot
--   graphs.
module NetSpider.CLI.Snapshot

-- | CLI option parser for Snapshot <a>Query</a>. Use
--   <a>makeSnapshotQuery</a> to convert <a>CLISnapshotQuery</a> to
--   <a>Query</a>.
parserSnapshotQuery :: SnapshotConfig n -> Parser (CLISnapshotQuery n)

-- | Make a <a>Query</a> by applying <a>CLISnapshotQuery</a> to the base
--   query. The <a>CLISnapshotQuery</a> overwrites <a>startsFrom</a> and
--   <a>timeInterval</a> fields.
--   
--   It can fail to convert <a>CLISnapshotQuery</a> to <a>Query</a> fields.
--   In that case, the result is <a>Left</a> with a human-readable error
--   message.
makeSnapshotQuery :: Query n na fla sla -> CLISnapshotQuery n -> Either String (Query n na fla sla)

-- | Configuration for option parser for Snapshot <a>Query</a>.
data SnapshotConfig n
SnapshotConfig :: ReadM n -> Bool -> SnapshotConfig n

-- | Parser that reads a CLI option to generate a node ID.
[nodeIDReader] :: SnapshotConfig n -> ReadM n

-- | If <a>True</a>, the <a>startsFrom</a> field is read from CLI
--   arguments. If <a>False</a>, arguments are not parsed. In either case,
--   "-s" option is always parsed to generate <a>startsFrom</a>.
[startsFromAsArguments] :: SnapshotConfig n -> Bool

-- | Settings for Snapshot <a>Query</a> parsed from the command-line
--   options. You can make <a>Query</a> by <a>makeSnapshotQuery</a>
--   function.
data CLISnapshotQuery n
instance GHC.Classes.Ord n => GHC.Classes.Ord (NetSpider.CLI.Snapshot.CLISnapshotQuery n)
instance GHC.Classes.Eq n => GHC.Classes.Eq (NetSpider.CLI.Snapshot.CLISnapshotQuery n)
instance GHC.Show.Show n => GHC.Show.Show (NetSpider.CLI.Snapshot.CLISnapshotQuery n)


-- | This module define CLI option parser for <a>SpiderConfig</a>.
module NetSpider.CLI.Spider

-- | Command-line option parser for <a>Config</a> of <tt>Spider</tt>.
parserSpiderConfig :: Parser (SpiderConfig n na fla)

-- | <a>Config</a> of the Spider.
type SpiderConfig = Config


-- | This module defines CLI option parsers for NetSpider objects, such as
--   configuration for Spider object and a query for a snapshot graph. The
--   option parsers are based on <a>Parser</a> from
--   <a>Options.Applicative</a> (optparse-applicative package), so you can
--   easily integrade those parsers into the CLI option parser of your own
--   executable program.
module NetSpider.CLI