Crate opstr

Crate opstr 

Source
Expand description

opstr is a library to apply operations to strings.

§Objects

  • Configuration represents how the output shall be represented and which locale shall be used for Unicode operations.
  • LibError is an enum of all possible error types that can occur
  • Arg represents one input argument (final content, in the case of stdin/file). Args is a sequence of them.

§Concepts

  • Operations provide a priority. A priority defines how much sense this request made. A priority of 1.0 means “very likely what you looked for” (on the CLI, the result will be shown on the bottom). A priority close to 0.0 means “unlikely helpful” (on the CLI, the result will be printed out first). Results with priority 0.0 make no sense and will be discarded immediately.

§API

  • list_all_ops returns the list of supported operations
  • list_matching_ops returns the list of possible operations for the provided arguments
  • matcher::run_op returns the Output after running the one operation specified
  • matcher::run_matching_ops runs all operations appropriate for the provided arguments and writes the result to stdout & stderr

§Notes

  1. The CLI output is always valid UTF-8. This might change in the future, but in the current release, this is the case.
  2. Arg is either Unicode content (Chars) or an arbitrary byte sequence (Bytes). Bytes is not yet supported.
  3. Output abstracts the type of result of an operation.
  4. Configuration.syntax defines which formal grammar shall be used for representation. The default representation for humans does not have a specification.

Structs§

Args
An ordered container for arguments
Configuration
Global application settings (mainly to configure representation)

Enums§

Arg
An argument for an operation
ColorScheme
Enum ColorScheme in use to represent the diagnostic message.
LibError
LibError represents one of all possible error cases possible to occur in this library
Output
Output is the result of an operation ready for user-friendly representation through the print method

Functions§

list_all_ops
Return the list of all operations as Output::Association of (name, description) entries.
list_color_schemes
Run all operations appropriate for the provided Args. Write the result to stdout & stderr, so we return ()
list_matching_ops
Return the ordered list of appropriate operations as Output::Association of (name, description) entries.
run_matching_ops
Run all operations appropriate for the provided Args. Write the result to stdout & stderr, so we return ()
run_op
Return (op_name, Output) as result of running the specified operation op_name with Args