reference-doc.yaml

---

intro: >-
  This is the `radicle` reference document, with documentation for all functions
  which come as part of the standard distribution.

primFnsDoc: >-
  Primitive functions are those that are built into the compiler. They are
  available on all machines but may be shadowed by later definitions. Those that
  end in a `!` are only available locally, not on 'pure' machines.

preludeModulesDoc: >-
  These are the modules included in the radicle prelude and the functions these
  modules expose.

primFns:
# Basics
- "*"
- "+"
- "-"
- "/"
- "<"
- ">"
- eq?
- apply
- show
- throw
- exit!
- read-annotated
- read-many-annotated
# Eval
- base-eval
# Refs
- ref
- read-ref
- write-ref
# Pattern matching
- match-pat
# Sequences
- cons
- first
- rest
- add-right
- <>
- list
- list-to-vec
- vec-to-list
- zip
- map
- length
- foldl
- foldr
- drop
- sort-by
- take
- nth
- seq
# Dicts
- dict
- lookup
- insert
- delete
- member?
- map-keys
- map-values
# Strings
- string-append
- string-length
- string-replace
- foldl-string
# Types
- type
- atom?
- keyword?
- boolean?
- string?
- number?
- integral?
- vector?
- list?
- dict?
# Modules
- file-module!
- find-module-file!
- import
# State and Environment
- pure-state
- get-current-state
- set-current-state
- get-binding
- set-binding
- set-env
- state->env
# Time
- timestamp?
- unix-epoch
- from-unix-epoch
- now!
# JSON
- to-json
- from-json
# UUIDs
- uuid!
- uuid?
# Crypto
- default-ecc-curve
- verify-signature
- public-key?
- gen-key-pair!
- gen-signature!
# I/O
- get-args!
- put-str!
- get-line!
- load!
- cd!
- stdin!
- stdout!
- stderr!
- read-file!
- read-line-handle!
- open-file!
- close-handle!
- system!
- wait-for-process!
- write-handle!
# Repl
- subscribe-to!
# Documentation
- doc
- doc!
- apropos!

# All modules apart from prelude/test
modules:
- prelude/basic
- prelude/patterns
- prelude/bool
- prelude/seq
- prelude/list
- prelude/strings
- prelude/error-messages
- prelude/dict
- prelude/io
- prelude/exception
- prelude/set
- prelude/ref
- prelude/lens
- prelude/io-utils
- prelude/key-management
- prelude/machine
- prelude/state-machine
- prelude/validation
- prelude/util