Swarm.Log

A data type to represent log messages, both for robot logs and the system log.

Documentation

data Severity

Severity of the error - critical errors are bugs and should be reported as Issues.

Constructors

Info

Debug

Warning

Error

Critical

Instances

FromJSON Severity

Defined in Swarm.Log

Methods

parseJSON :: Value -> Parser Severity

parseJSONList :: Value -> Parser [Severity]

ToJSON Severity

Defined in Swarm.Log

Methods

toJSON :: Severity -> Value

toEncoding :: Severity -> Encoding

toJSONList :: [Severity] -> Value

toEncodingList :: [Severity] -> Encoding

Generic Severity

Defined in Swarm.Log

Associated Types

type Rep Severity :: Type -> Type

Methods

from :: Severity -> Rep Severity x

to :: Rep Severity x -> Severity

Show Severity

Defined in Swarm.Log

Methods

showsPrec :: Int -> Severity -> ShowS

show :: Severity -> String

showList :: [Severity] -> ShowS

Eq Severity

Defined in Swarm.Log

Methods

(==) :: Severity -> Severity -> Bool

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

Ord Severity

Defined in Swarm.Log

Methods

compare :: Severity -> Severity -> Ordering

(<) :: Severity -> Severity -> Bool

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

(>) :: Severity -> Severity -> Bool

(>=) :: Severity -> Severity -> Bool

max :: Severity -> Severity -> Severity

min :: Severity -> Severity -> Severity

type Rep Severity

Defined in Swarm.Log

type Rep Severity = D1 ('MetaData "Severity" "Swarm.Log" "swarm-0.5.0.0-6qXEbhCmuXA4wRndqqhBu" 'False) ((C1 ('MetaCons "Info" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "Debug" 'PrefixI 'False) (U1 :: Type -> Type)) :+: (C1 ('MetaCons "Warning" 'PrefixI 'False) (U1 :: Type -> Type) :+: (C1 ('MetaCons "Error" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "Critical" 'PrefixI 'False) (U1 :: Type -> Type))))

data RobotLogSource

How a robot log entry was produced.

Constructors

Said

Produced by Say

Logged

Produced by Log

RobotError

Produced as the result of an error.

Instances

FromJSON RobotLogSource

Defined in Swarm.Log

Methods

parseJSON :: Value -> Parser RobotLogSource

parseJSONList :: Value -> Parser [RobotLogSource]

ToJSON RobotLogSource

Defined in Swarm.Log

Methods

toJSON :: RobotLogSource -> Value

toEncoding :: RobotLogSource -> Encoding

toJSONList :: [RobotLogSource] -> Value

toEncodingList :: [RobotLogSource] -> Encoding

Generic RobotLogSource

Defined in Swarm.Log

Associated Types

type Rep RobotLogSource :: Type -> Type

Methods

from :: RobotLogSource -> Rep RobotLogSource x

to :: Rep RobotLogSource x -> RobotLogSource

Show RobotLogSource

Defined in Swarm.Log

Methods

showsPrec :: Int -> RobotLogSource -> ShowS

show :: RobotLogSource -> String

showList :: [RobotLogSource] -> ShowS

Eq RobotLogSource

Defined in Swarm.Log

Methods

(==) :: RobotLogSource -> RobotLogSource -> Bool

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

Ord RobotLogSource

Defined in Swarm.Log

Methods

compare :: RobotLogSource -> RobotLogSource -> Ordering

(<) :: RobotLogSource -> RobotLogSource -> Bool

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

(>) :: RobotLogSource -> RobotLogSource -> Bool

(>=) :: RobotLogSource -> RobotLogSource -> Bool

max :: RobotLogSource -> RobotLogSource -> RobotLogSource

min :: RobotLogSource -> RobotLogSource -> RobotLogSource

type Rep RobotLogSource

Defined in Swarm.Log

type Rep RobotLogSource = D1 ('MetaData "RobotLogSource" "Swarm.Log" "swarm-0.5.0.0-6qXEbhCmuXA4wRndqqhBu" 'False) (C1 ('MetaCons "Said" 'PrefixI 'False) (U1 :: Type -> Type) :+: (C1 ('MetaCons "Logged" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "RobotError" 'PrefixI 'False) (U1 :: Type -> Type)))

data LogSource

Source of a log entry.

Constructors

RobotLog RobotLogSource Int (Cosmic Location)

Log produced by a robot. Stores information about which command was used and the ID and location of the producing robot.

SystemLog

Log produced by an exception or system.

Instances

FromJSON LogSource

Defined in Swarm.Log

Methods

parseJSON :: Value -> Parser LogSource

parseJSONList :: Value -> Parser [LogSource]

ToJSON LogSource

Defined in Swarm.Log

Methods

toJSON :: LogSource -> Value

toEncoding :: LogSource -> Encoding

toJSONList :: [LogSource] -> Value

toEncodingList :: [LogSource] -> Encoding

Generic LogSource

Defined in Swarm.Log

Associated Types

type Rep LogSource :: Type -> Type

Methods

from :: LogSource -> Rep LogSource x

to :: Rep LogSource x -> LogSource

Show LogSource

Defined in Swarm.Log

Methods

showsPrec :: Int -> LogSource -> ShowS

show :: LogSource -> String

showList :: [LogSource] -> ShowS

Eq LogSource

Defined in Swarm.Log

Methods

(==) :: LogSource -> LogSource -> Bool

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

Ord LogSource

Defined in Swarm.Log

Methods

compare :: LogSource -> LogSource -> Ordering

(<) :: LogSource -> LogSource -> Bool

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

(>) :: LogSource -> LogSource -> Bool

(>=) :: LogSource -> LogSource -> Bool

max :: LogSource -> LogSource -> LogSource

min :: LogSource -> LogSource -> LogSource

type Rep LogSource

Defined in Swarm.Log

type Rep LogSource = D1 ('MetaData "LogSource" "Swarm.Log" "swarm-0.5.0.0-6qXEbhCmuXA4wRndqqhBu" 'False) (C1 ('MetaCons "RobotLog" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 RobotLogSource) :*: (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int) :*: S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Cosmic Location)))) :+: C1 ('MetaCons "SystemLog" 'PrefixI 'False) (U1 :: Type -> Type))

data LogEntry

A log entry.

Constructors

LogEntry

Fields

• _leTime :: TickNumber

  The time at which the entry was created. Note that this is the first field we sort on.

• _leSource :: LogSource

  Where this log message came from.

• _leSeverity :: Severity

  Severity level of this log message.

• _leName :: Text

  Name of the robot or subsystem that generated this log entry.

• _leText :: Text

  The text of the log entry.

Instances

FromJSON LogEntry

Defined in Swarm.Log

Methods

parseJSON :: Value -> Parser LogEntry

parseJSONList :: Value -> Parser [LogEntry]

ToJSON LogEntry

Defined in Swarm.Log

Methods

toJSON :: LogEntry -> Value

toEncoding :: LogEntry -> Encoding

toJSONList :: [LogEntry] -> Value

toEncodingList :: [LogEntry] -> Encoding

Generic LogEntry

Defined in Swarm.Log

Associated Types

type Rep LogEntry :: Type -> Type

Methods

from :: LogEntry -> Rep LogEntry x

to :: Rep LogEntry x -> LogEntry

Show LogEntry

Defined in Swarm.Log

Methods

showsPrec :: Int -> LogEntry -> ShowS

show :: LogEntry -> String

showList :: [LogEntry] -> ShowS

Eq LogEntry

Defined in Swarm.Log

Methods

(==) :: LogEntry -> LogEntry -> Bool

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

Ord LogEntry

Defined in Swarm.Log

Methods

compare :: LogEntry -> LogEntry -> Ordering

(<) :: LogEntry -> LogEntry -> Bool

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

(>) :: LogEntry -> LogEntry -> Bool

(>=) :: LogEntry -> LogEntry -> Bool

max :: LogEntry -> LogEntry -> LogEntry

min :: LogEntry -> LogEntry -> LogEntry

type Rep LogEntry

Defined in Swarm.Log

type Rep LogEntry = D1 ('MetaData "LogEntry" "Swarm.Log" "swarm-0.5.0.0-6qXEbhCmuXA4wRndqqhBu" 'False) (C1 ('MetaCons "LogEntry" 'PrefixI 'True) ((S1 ('MetaSel ('Just "_leTime") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 TickNumber) :*: S1 ('MetaSel ('Just "_leSource") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 LogSource)) :*: (S1 ('MetaSel ('Just "_leSeverity") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Severity) :*: (S1 ('MetaSel ('Just "_leName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "_leText") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))))

leTime :: Lens' LogEntry TickNumber

leSource :: Lens' LogEntry LogSource

leSeverity :: Lens' LogEntry Severity

leName :: Lens' LogEntry Text

leText :: Lens' LogEntry Text