Expand description
§🌱 ACORN Library
“Plant an ACORN and grow your research”
acorn-lib is a one-stop-shop for everything related to building and maintaining research activity data (RAD)-related technology, including the Accessible Content Optimization for Research Needs (ACORN) tool.
The modules, structs, enums and constants found here support the ACORN CLI, which checks, analyzes, and exports research activity data into useable formats.
Modules§
- analyzer
- Prose analyzer module
- io
- IO Utilities
- prelude
- Wrapper module isolate
stdusage and enableno_stdsupport - schema
- ACORN schemas
- util
- Common utilities
Macros§
- args
- Build a
Vec<OsString>of command arguments with automatic.into()conversion and..spread for conditional sub-vectors. - check
- Build an analyzer [
Check] with required category/success and optional fields. - check_
err - Build a failing [
Check] withErrorseverity and optional fields. - check_
ok - Build a successful [
Check] with optional fields. - cmd
- Execute a command and capture its output.
- fail
- Logging macro for failures
- list_
validator - Generate a list validator function from an existing scalar validator function
- method_
validator - Generate a validator function that delegates to a method on the input value
- param
- Creates a
Paramwith the given style, name, and values. - regex_
validator - Generate a validator function that matches a value against a regex
- skip
- Logging macro for skipped operations
Structs§
- Release
- Struct for release data from GitLab or GitHub
Enums§
- Location
- Descriptive/persistent location reference for use in configuration (buckets, repositories, etc.).
- Repository
- Git hosting repository data
- Scheme
- URI Scheme