Anoma.Utility (Anoma v0.29.0)
I provide utility functions for users.
Public API
I possess the following public API:
- message_label/1
- rocks_opts/1
Summary
Functions
I am the function definition macro for debugging.
I am a macro which allows to provide documentation to possibly private functions.
Helps labeling for Kino.Process.seq_trace/2
, for the Router abstraction
If I receive true, I give a list with a rocksdb option.
Functions
I am the function definition macro for debugging.
I mainly should be used on functions which satisfy:
- Needing to be private i.e. not expose API to other Engines.
- Important for core functionality and hence requiring documentation.
Given the two are satisfied, use me to define a function which becomes public once in debug mode and otherwise remains private.
I am to be used alongside the docp/1
macro to allow for good
documentation practices.
I am a macro which allows to provide documentation to possibly private functions.
If the environment of the application is :debug
I actually put the docs
into the compiled module. If not, I produce nil
, which does not
interact with overall module environment.
message_label(message)
Helps labeling for Kino.Process.seq_trace/2
, for the Router abstraction
rock_opts(rocks)
@spec rock_opts(bool()) :: list()
If I receive true, I give a list with a rocksdb option.
Else I give an empty list.