is_effects 0.1.2
is_effects: ^0.1.2 copied to clipboard
The shared vocabulary of intersyntactic's effects: what reading, writing, starting a program and sending out of the home take and give back, and the drivers that carry them out.
is_effects #
The shared vocabulary of intersyntactic's effects. Tools describe effects in these words, the airlock decides on them, and drivers carry them out.
A driver depends on this package alone, so it sees no run, journey path or
decision: it is reached only once a run is decided, by is_airlock_api.
What an effect takes and gives back #
PathInRepo: a path inside the repo, made only byparse. What stays inside is the text; a symlink in the tree can still point out, and only a driver can refuse that.- Reading and writing:
FileTextin,ReadResult(ReadText,ReadMissing) andWroteout. - Starting a program: a
ProgramName(made only byparse, no whitespace) andArgs, giving anExecResult, which isExited(exitCode)orKilled(why), each with stdout and stderr. How long a program may run, and when it is killed, is the driver's. Outcome<O>:Ran(output), orRefused(why).Progress: what a driver reports while it works,Printedfor a program's output.
Nothing here sends out of the home. A journey path's model calls are made by its own loop, which holds only the sign-ins its rules allow; an effect for a tool that sends is added when a tool needs one.
Drivers #
FileDriver and ProgramDriver, the latter reporting progress as it goes.
A machine loads the drivers it can run: a phone's loads no ProgramDriver.
The library imports path and nothing else outside the SDK; a test reads
every directive's URI from Dart's parse tree and holds it to that.