Swarm.Game.Failure

A data type to represent system failures (as distinct from robot program failures).

These failures are often not fatal and serve to create common infrastructure for logging.

Documentation

data SystemFailure

An enumeration of various types of failures (errors or warnings) that can occur.

Constructors

AssetNotLoaded Asset FilePath LoadingFailure

ScenarioNotFound FilePath

OrderFileWarning FilePath OrderFileWarning

CustomFailure Text

Instances

Show SystemFailure

Defined in Swarm.Game.Failure

Methods

showsPrec :: Int -> SystemFailure -> ShowS

show :: SystemFailure -> String

showList :: [SystemFailure] -> ShowS

PrettyPrec SystemFailure

Defined in Swarm.Game.Failure

Methods

prettyPrec :: Int -> SystemFailure -> Doc ann

data AssetData

Enumeration of various assets we can attempt to load.

Constructors

AppAsset

NameGeneration

Entities

Recipes

Worlds

Scenarios

Script

Instances

Show AssetData

Defined in Swarm.Game.Failure

Methods

showsPrec :: Int -> AssetData -> ShowS

show :: AssetData -> String

showList :: [AssetData] -> ShowS

Eq AssetData

Defined in Swarm.Game.Failure

Methods

(==) :: AssetData -> AssetData -> Bool

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

PrettyPrec AssetData

Defined in Swarm.Game.Failure

Methods

prettyPrec :: Int -> AssetData -> Doc ann

data Asset

Overarching enumeration of various assets we can attempt to load.

Constructors

Achievement

Data AssetData

History

Save

Instances

Show Asset

Defined in Swarm.Game.Failure

Methods

showsPrec :: Int -> Asset -> ShowS

show :: Asset -> String

showList :: [Asset] -> ShowS

Eq Asset

Defined in Swarm.Game.Failure

Methods

(==) :: Asset -> Asset -> Bool

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

PrettyPrec Asset

Defined in Swarm.Game.Failure

Methods

prettyPrec :: Int -> Asset -> Doc ann

data Entry

Enumeration type to distinguish between directories and files.

Constructors

Directory

File

Instances

Show Entry

Defined in Swarm.Game.Failure

Methods

showsPrec :: Int -> Entry -> ShowS

show :: Entry -> String

showList :: [Entry] -> ShowS

Eq Entry

Defined in Swarm.Game.Failure

Methods

(==) :: Entry -> Entry -> Bool

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

PrettyPrec Entry

Defined in Swarm.Game.Failure

Methods

prettyPrec :: Int -> Entry -> Doc ann

data LoadingFailure

An error that occurred while attempting to load some kind of asset.

Constructors

DoesNotExist Entry

EntryNot Entry

CanNotParseYaml ParseException

CanNotParseMegaparsec (ParseErrorBundle Text Void)

DoesNotTypecheck Text

Duplicate AssetData Text

CustomMessage Text

Instances

Show LoadingFailure

Defined in Swarm.Game.Failure

Methods

showsPrec :: Int -> LoadingFailure -> ShowS

show :: LoadingFailure -> String

showList :: [LoadingFailure] -> ShowS

PrettyPrec LoadingFailure

Defined in Swarm.Game.Failure

Methods

prettyPrec :: Int -> LoadingFailure -> Doc ann

data OrderFileWarning

A warning that arose while processing an 00-ORDER.txt file.

Constructors

NoOrderFile

MissingFiles (NonEmpty FilePath)

DanglingFiles (NonEmpty FilePath)

Instances

Show OrderFileWarning

Defined in Swarm.Game.Failure

Methods

showsPrec :: Int -> OrderFileWarning -> ShowS

show :: OrderFileWarning -> String

showList :: [OrderFileWarning] -> ShowS

Eq OrderFileWarning

Defined in Swarm.Game.Failure

Methods

(==) :: OrderFileWarning -> OrderFileWarning -> Bool

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

PrettyPrec OrderFileWarning

Defined in Swarm.Game.Failure

Methods

prettyPrec :: Int -> OrderFileWarning -> Doc ann