NetSpider.CLI.Snapshot

This module defines CLI option parser for Query for snapshot graphs.

Documentation

parserSnapshotQuery :: SnapshotConfig n -> Parser (CLISnapshotQuery n)

CLI option parser for Snapshot Query. Use makeSnapshotQuery to convert CLISnapshotQuery to Query.

Since: 0.2.0.0

makeSnapshotQuery

Arguments

:: Query n na fla sla

base query

-> CLISnapshotQuery n

-> Either String (Query n na fla sla)

Left: human-readable error message. Right: updated query

Make a Query by applying CLISnapshotQuery to the base query. The CLISnapshotQuery overwrites startsFrom and timeInterval fields.

It can fail to convert CLISnapshotQuery to Query fields. In that case, the result is Left with a human-readable error message.

Since: 0.2.0.0

data SnapshotConfig n

Configuration for option parser for Snapshot Query.

Since: 0.2.0.0

Constructors

SnapshotConfig

Fields

• nodeIDReader :: ReadM n

  Parser that reads a CLI option to generate a node ID.

• startsFromAsArguments :: Bool

  If True, the startsFrom field is read from CLI arguments. If False, arguments are not parsed. In either case, "-s" option is always parsed to generate startsFrom.

data CLISnapshotQuery n

Settings for Snapshot Query parsed from the command-line options. You can make Query by makeSnapshotQuery function.

Since: 0.2.0.0

Instances

Eq n => Eq (CLISnapshotQuery n)

Defined in NetSpider.CLI.Snapshot

Methods

(==) :: CLISnapshotQuery n -> CLISnapshotQuery n -> Bool

(/=) :: CLISnapshotQuery n -> CLISnapshotQuery n -> Bool

Ord n => Ord (CLISnapshotQuery n)

Defined in NetSpider.CLI.Snapshot

Methods

compare :: CLISnapshotQuery n -> CLISnapshotQuery n -> Ordering

(<) :: CLISnapshotQuery n -> CLISnapshotQuery n -> Bool

(<=) :: CLISnapshotQuery n -> CLISnapshotQuery n -> Bool

(>) :: CLISnapshotQuery n -> CLISnapshotQuery n -> Bool

(>=) :: CLISnapshotQuery n -> CLISnapshotQuery n -> Bool

max :: CLISnapshotQuery n -> CLISnapshotQuery n -> CLISnapshotQuery n

min :: CLISnapshotQuery n -> CLISnapshotQuery n -> CLISnapshotQuery n

Show n => Show (CLISnapshotQuery n)

Defined in NetSpider.CLI.Snapshot

Methods

showsPrec :: Int -> CLISnapshotQuery n -> ShowS

show :: CLISnapshotQuery n -> String

showList :: [CLISnapshotQuery n] -> ShowS