Modulevortex-console-0.1.3GHC2021

Vortex.Console

A console session over a vortex socket, as a pure state machine: what the user typed, what was sent, what came back. Every front end (a browser component, a terminal, a game overlay) feeds it Events and performs the Outs; nothing here knows how frames travel.

Synopsis

data Kind
data Entry
data Model
value initial
data Event
newtype Out
value step
value prefix
value loginBlock

Packagevortex-console-0.1.3
Exports9
LanguageGHC2021
LicenceBSD-3-Clause
SourceConsole.hs

datadata Kind

Source#

What a line of the transcript is.

Constructors

Block
A block the user ran.
Said
Something the block said on the way.
Result
The block's value.
Failed
The block's refusal or failure, or a transport problem.

Instances2Eq, Show

Eq KindDefined in vortex-console-0.1.3 · Vortex.Console
Show KindDefined in vortex-console-0.1.3 · Vortex.Console

datadata Entry

Constructors

Entry
- entryKind :: Kind
- entryText :: String

Instances2Eq, Show

Eq EntryDefined in vortex-console-0.1.3 · Vortex.Console
Show EntryDefined in vortex-console-0.1.3 · Vortex.Console

datadata Model

Constructors

Model
- input :: String
  The block being written.
- entries :: [Entry]
  The transcript, oldest first.
- connected :: Bool
- inFlight :: Int
  Blocks sent whose terminal reply has not arrived.

Instances2Eq, Show

Eq ModelDefined in vortex-console-0.1.3 · Vortex.Console
Show ModelDefined in vortex-console-0.1.3 · Vortex.Console

valueinitial :: Model

datadata Event

Constructors

Typed String
The input changed.
Run
Run the input as one block.
Clear
Forget the transcript.
Opened
The socket opened.
Closed
The socket closed.
Frame String
A frame arrived: show of a Reply.

Instances2Eq, Show

Eq EventDefined in vortex-console-0.1.3 · Vortex.Console
Show EventDefined in vortex-console-0.1.3 · Vortex.Console

newtypenewtype Out

Source#

What the front end must do after a step.

Constructors

Send String

Instances2Eq, Show

Eq OutDefined in vortex-console-0.1.3 · Vortex.Console
Show OutDefined in vortex-console-0.1.3 · Vortex.Console

valuestep :: Event -> Model -> (Model, [Out])

valueprefix :: Kind -> String

Source#

How a transcript line is introduced when shown as text.

valueloginBlock :: String -> String -> String

Source#

The transport meta-command that binds a session to a user.