Skip to main content

Crate unilang

Crate unilang 

Source
Expand description

§Module :: unilang

experimental rust-status docs.rs Open in Gitpod discord

Zero-overhead command framework with compile-time command registration

unilang processes command definitions at compile-time, generating optimized static command registries with O(1) lookups (~80ns), zero runtime overhead, and SIMD-accelerated parsing. Commands are defined in YAML (default), JSON, or Rust DSL; the build system auto-discovers and validates them before your binary ships.

§Features

  • 50x faster command resolution — static PHF map vs runtime HashMap (~80ns vs ~4,000ns)
  • Compile-time validation — all command definitions checked before deployment
  • SIMD parsing — 4-25x parsing performance improvement
  • Multiple definition styles — YAML, JSON, Rust DSL (builder or const fn)
  • Multi-file aggregation — auto-discover commands across files with conflict detection
  • Hybrid mode — static base + runtime plugins in one registry
  • Built-in REPL — interactive shell with history, completion, secure input
  • CLI aggregation — unify multiple tools under one interface with namespace isolation

§Installation

[dependencies]
unilang = "0.51"

The default configuration enables multi-YAML build-time static registration (Approach #2 — recommended for 95% of users).

§Minimal Example

Create unilang.commands.yaml:

- name: ".greet"
  description: "Greeting command"
  arguments:
    - name: "name"
      kind: "String"
      attributes:
        optional: true
        default: "World"

Use it in src/main.rs:

use unilang::prelude::*;

include!( concat!( env!( "OUT_DIR" ), "/static_commands.rs" ) );

fn main() -> Result< (), unilang::Error >
{
  let registry = StaticCommandRegistry::from_commands( &STATIC_COMMANDS );
  let pipeline = Pipeline::new( registry );
  let result = pipeline.process_command_simple( ".greet name::Alice" );
  println!( "{}", result.outputs[ 0 ].content );
  Ok( () )
}
cargo run  # Builds, generates static registry, runs

§Parameter Syntax

Named parameters use name::valuedouble colon is required. The :: operator activates value context, preserving special characters (/, ., #, ?) until whitespace:

.greet name::Alice
.run   file::./examples/plan.md          # file paths — fully supported
.fetch url::https://example.com/path     # URLs — fully supported
.find  pattern::"multi word value"       # spaces → quote the value

Single colon (name:value) is not valid syntax and produces a parse error. See docs/parameter_syntax.md for the full reference.

§Documentation

DocumentContents
docs/quick_start.mdStep-by-step setup guide
docs/parameter_syntax.md:: operator, value context, file paths, quoting
docs/cli_definition_approaches.mdAll 21 approaches (YAML/JSON/DSL, build/runtime)
docs/cli_aggregation.mdCLI aggregation with namespace isolation
docs/migration.mdRuntime → build-time migration (50x speedup)
docs/troubleshooting.mdCommon errors and solutions
docs/features.mdFull feature tracking table
docs/optimization_guide.mdPerformance tuning guidelines
docs/phf_reexport.mdPHF re-export for static_registry users
docs/feature/Feature requirements (FR-REG, FR-ARG, FR-PIPE, FR-HELP)
docs/invariant/System invariants, NFRs, governing principles
docs/api/API contracts, data structures, implementation details
examples/Runnable examples with learning path

§Approach Selection

#ApproachFeature FlagDefaultLookup
2Multi-YAML → Build-time staticapproach_yaml_multi_build~80ns
1Single YAML → Build-time staticapproach_yaml_single_build~80ns
3YAML → Runtime loadingapproach_yaml_runtime~4,200ns
4–6JSON variants (same as 1–3)approach_json_*80/4,200ns
7Rust DSL builder API(always available)~4,200ns
8Rust DSL const fn staticapproach_rust_dsl_const~80ns
18Hybrid (static + runtime)approach_hybridMixed

See docs/cli_definition_approaches.md for all 21 approaches.

§Design Rules Compliance Notice

CRITICAL: This codebase must follow strict design rules. Before making changes, review:

  • $PRO/genai/code/rules/code_design.rulebook.md - Core design patterns and architecture rules
  • $PRO/genai/code/rules/code_style.rulebook.md - Code formatting and style requirements

Key Rules Summary:

  • Testing: All tests MUST be in tests/ directory, NOT in src/ as mod tests
  • Benchmarking: Use benchkit framework ONLY - no custom timing code in tests
  • Performance Tests: NEVER mix benchmarks with unit tests - separate concerns
  • Test Documentation: Every test file MUST have Test Matrix documentation
  • Directory Structure: tests/ for tests, benches/ for benchmarks (if using benchkit)

Common Violations to Avoid: ❌ Custom std::time::Instant timing code in test files ❌ Performance/benchmark tests in tests/ directory ❌ Missing file-level documentation with Test Matrix in test files ❌ Using anything other than benchkit for performance measurement

§Feature Flags

Unilang supports multiple feature flags to customize functionality and dependencies:

§Core Features

  • enabled - Core functionality (included in default)
  • full - All features enabled for maximum functionality

§REPL Features

  • repl - Basic REPL functionality with standard I/O

    • Provides interactive command execution
    • Basic command history tracking
    • Cross-platform compatibility
    • No additional dependencies
  • enhanced_replEnabled by Default - Advanced REPL with rustyline integration

    • Enables: All features from repl plus:
    • Arrow Key Navigation: ↑/↓ for command history browsing
    • Tab Auto-completion: Command and argument completion
    • Interactive Prompts: Secure password input with masking
    • Session Persistence: History saved across sessions
    • Terminal Detection: Auto-fallback to basic REPL in non-interactive environments
    • Dependencies: rustyline, std::io::IsTerminal

§Performance Features

  • simd - SIMD optimizations for parsing and JSON processing
    • Enables: simd-json (4-25x faster JSON), SIMD string operations
    • Automatic: Included in default for maximum performance
    • Disable with: cargo build --no-default-features --features enabled

§Optional Features

  • on_unknown_suggest - Fuzzy command suggestions (requires textdistance)

Note: Benchmarking tools are available in the separate unilang_benchmarks workspace crate

§Usage Examples

Basic REPL (minimal dependencies):

[dependencies]
unilang = { version = "0.10", features = ["repl"] }

Default (Enhanced REPL included):

[dependencies]
unilang = "0.10"  # Enhanced REPL enabled by default

Performance-optimized CLI:

[dependencies]
unilang = { version = "0.10", features = ["enhanced_repl", "simd", "on_unknown_suggest"] }

Embedded/minimal:

[dependencies]
unilang = { version = "0.10", default-features = false, features = ["enabled"] }

§Feature Compatibility

  • enhanced_repl automatically includes repl
  • full includes all features except development-only ones
  • All features work together without conflicts
  • Enhanced REPL gracefully falls back to basic REPL when needed

Re-exports§

pub use super::private::TypeAnalyzer;
pub use super::private::TypeHint;
pub use super::private::Severity;
pub use super::private::HintGenerator;
pub use super::aggregator;
pub use super::builder;
pub use super::type_analyzer;
pub use super::hint_generator;
pub use super::private::TypeAnalyzer;
pub use super::private::TypeHint;
pub use super::private::Severity;
pub use super::private::HintGenerator;
pub use unilang_parser as parser;
pub use phf;
pub use super::prelude::*;
pub use super::prelude::*;

Modules§

build_helpers
Build-time helper utilities for type analysis and hint generation. Provides tools for detecting type issues in YAML command definitions during build. Requires feature: yaml_parser Build-time helper utilities for static registry generation
command_validation
Command validation utilities. Command registration validation and utilities.
config_extraction
Config value extraction utilities. Generic extractors for HashMap<String, (JsonValue, S)> config maps. Requires feature: json_parser
data
Core data structures and types.
error
Error handling utilities.
exposed
Exposed namespace of the module.
help
Help generation system.
interner
String interning system for performance optimization. String Interning System
interpreter
Command execution interpreter.
loader
Configuration loading from YAML/JSON. Functions gated by yaml_parser and json_parser features.
multi_yaml
Multi-YAML build system for compile-time aggregation. Requires feature: multi_file Multi-YAML Build System and Ergonomic Aggregation APIs
orphan
Orphan namespace of the module.
own
Own namespace of the module.
pipeline
High-level pipeline API.
prelude
Prelude to use essentials: use my_module ::prelude :: *.
registry
Command registry management. Some functions gated by approach features.
semantic
Semantic analysis and validation.
simd_json_parser
SIMD-optimized JSON parsing for 4-25x performance improvements. Requires features: simd-json AND json_parser
simd_tokenizer
SIMD-optimized tokenization for 3-6x performance improvements. SIMD-optimized tokenization for high-performance string processing.
static_data
Static data structures for compile-time commands. Requires feature: static_registry
types
Value types and type system.
validation_core
Core validation logic shared between runtime and build.rs. This module can be included in build.rs via include!() since it has no dependencies. Core validation logic shared between runtime and build.rs.

Structs§

AggregationConfig
Multi-YAML build system for compile-time aggregation. Requires feature: multi_file Re-export key aggregator types Multi-YAML build system for compile-time aggregation. Requires feature: multi_file Re-export key aggregator types Configuration for multi-YAML aggregation
ArgumentAttributes
Core data structures and types. Core data structures and types. Core data structures and types. Core data structures and types. Core data structures and types.
ArgumentDefinition
Core data structures and types. Core data structures and types. Core data structures and types. Core data structures and types. Core data structures and types.
BatchResult
High-level pipeline API. High-level pipeline API. High-level pipeline API. High-level pipeline API. High-level pipeline API.
CliBuilder
Multi-YAML build system for compile-time aggregation. Requires feature: multi_file Re-export key builder types Multi-YAML build system for compile-time aggregation. Requires feature: multi_file Re-export key builder types Ergonomic CLI builder for simple and complex aggregation scenarios
CliConfig
Multi-YAML build system for compile-time aggregation. Requires feature: multi_file Re-export key builder types Multi-YAML build system for compile-time aggregation. Requires feature: multi_file Re-export key builder types Global CLI configuration
CommandDefinition
Core data structures and types. Core data structures and types. Core data structures and types. Core data structures and types. Core data structures and types.
CommandDefinitionBuilder
Core data structures and types. Core data structures and types. Type-state builder for CommandDefinition that enforces required fields at compile time.
CommandName
Core data structures and types. Core data structures and types. Core data structures and types. Core data structures and types. Core data structures and types.
CommandRegistry
Command registry management. Some functions gated by approach features. Command registry management. Some functions gated by approach features. Command registry management. Some functions gated by approach features. Command registry management. Some functions gated by approach features. Command registry management. Some functions gated by approach features.
CommandRegistryBuilder
Command registry management. Some functions gated by approach features. Command registry management. Some functions gated by approach features. Command registry management. Some functions gated by approach features. Command registry management. Some functions gated by approach features. Command registry management. Some functions gated by approach features.
CommandResult
High-level pipeline API. High-level pipeline API. High-level pipeline API. High-level pipeline API. High-level pipeline API.
ConditionalModule
Multi-YAML build system for compile-time aggregation. Requires feature: multi_file Re-export key builder types Multi-YAML build system for compile-time aggregation. Requires feature: multi_file Re-export key builder types Conditional module based on feature flags
ConflictReport
Multi-YAML build system for compile-time aggregation. Requires feature: multi_file Re-export key aggregator types Multi-YAML build system for compile-time aggregation. Requires feature: multi_file Re-export key aggregator types Report of detected conflicts
DynamicCommandMap
Command registry management. Some functions gated by approach features. Command registry management. Some functions gated by approach features. Optimized dynamic command storage with intelligent caching
DynamicModule
Multi-YAML build system for compile-time aggregation. Requires feature: multi_file Re-export key builder types Multi-YAML build system for compile-time aggregation. Requires feature: multi_file Re-export key builder types Dynamic YAML module configuration for ergonomic APIs
EnvConfigParser
Multi-YAML build system for compile-time aggregation. Requires feature: multi_file Re-export key aggregator types Multi-YAML build system for compile-time aggregation. Requires feature: multi_file Re-export key aggregator types Environment variable configuration parser
ErrorData
Core data structures and types. Core data structures and types. Core data structures and types. Core data structures and types. Core data structures and types. Represents an error that occurred during command execution
ExecutionContext
Command execution interpreter. Command execution interpreter. Command execution interpreter. Command execution interpreter. Command execution interpreter.
FastJsonValue
SIMD-optimized JSON parsing for 4-25x performance improvements. Requires features: simd-json AND json_parser SIMD-optimized JSON parsing for 4-25x performance improvements. Requires features: simd-json AND json_parser SIMD-optimized JSON parsing for 4-25x performance improvements. Requires features: simd-json AND json_parser SIMD-optimized JSON parsing for 4-25x performance improvements. Requires features: simd-json AND json_parser SIMD-optimized JSON parsing for 4-25x performance improvements. Requires features: simd-json AND json_parser
HelpDisplayOptions
Help generation system. Help generation system. Help generation system. Help generation system. Help generation system. Global configuration for help output display.
HelpGenerator
Help generation system. Help generation system. Help generation system. Help generation system. Help generation system.
InternerStats
String interning system for performance optimization. String interning system for performance optimization. Statistics about the string interner’s current state.
Interpreter
Command execution interpreter. Command execution interpreter. Command execution interpreter. Command execution interpreter. Command execution interpreter.
ModuleConfig
Multi-YAML build system for compile-time aggregation. Requires feature: multi_file Re-export key aggregator types Multi-YAML build system for compile-time aggregation. Requires feature: multi_file Re-export key aggregator types Configuration for a single module
MultiYamlAggregator
Multi-YAML build system for compile-time aggregation. Requires feature: multi_file Re-export key aggregator types Multi-YAML build system for compile-time aggregation. Requires feature: multi_file Re-export key aggregator types Multi-YAML aggregation system for compile-time command processing
Namespace
Core data structures and types. Core data structures and types.
NamespaceIsolation
Multi-YAML build system for compile-time aggregation. Requires feature: multi_file Re-export key aggregator types Multi-YAML build system for compile-time aggregation. Requires feature: multi_file Re-export key aggregator types Namespace isolation configuration
NamespaceType
Core data structures and types. Core data structures and types. Core data structures and types. Core data structures and types. Core data structures and types.
NotSet
Core data structures and types. Core data structures and types. Marker type indicating a required field has not been set.
OutputData
Core data structures and types. Core data structures and types. Core data structures and types. Core data structures and types. Core data structures and types.
PerformanceMetrics
Command registry management. Some functions gated by approach features. Command registry management. Some functions gated by approach features. Command registry management. Some functions gated by approach features. Command registry management. Some functions gated by approach features. Command registry management. Some functions gated by approach features. Performance metrics for command registry operations.
Pipeline
High-level pipeline API. High-level pipeline API. High-level pipeline API. High-level pipeline API. High-level pipeline API.
ReplInput
Re-export of input marker newtypes from unilang_parser.
SIMDJsonParser
SIMD-optimized JSON parsing for 4-25x performance improvements. Requires features: simd-json AND json_parser SIMD-optimized JSON parsing for 4-25x performance improvements. Requires features: simd-json AND json_parser SIMD-optimized JSON parsing for 4-25x performance improvements. Requires features: simd-json AND json_parser SIMD-optimized JSON parsing for 4-25x performance improvements. Requires features: simd-json AND json_parser SIMD-optimized JSON parsing for 4-25x performance improvements. Requires features: simd-json AND json_parser
SIMDTokenizer
SIMD-optimized tokenization for 3-6x performance improvements. SIMD-optimized tokenizer for splitting strings by delimiters. SIMD-optimized tokenizer for splitting strings by delimiters.
SemanticAnalyzer
Semantic analysis and validation. Semantic analysis and validation. Semantic analysis and validation. Semantic analysis and validation. Semantic analysis and validation.
Set
Core data structures and types. Core data structures and types. Marker type indicating a required field has been set.
ShellArgv
Re-export of input marker newtypes from unilang_parser.
StaticArgumentAttributes
Static data structures for compile-time commands. Requires feature: static_registry Static data structures for compile-time commands. Requires feature: static_registry Static data structures for compile-time commands. Requires feature: static_registry Static data structures for compile-time commands. Requires feature: static_registry Static data structures for compile-time commands. Requires feature: static_registry
StaticArgumentDefinition
Static data structures for compile-time commands. Requires feature: static_registry Static data structures for compile-time commands. Requires feature: static_registry Static data structures for compile-time commands. Requires feature: static_registry Static data structures for compile-time commands. Requires feature: static_registry Static data structures for compile-time commands. Requires feature: static_registry
StaticCommandDefinition
Static data structures for compile-time commands. Requires feature: static_registry Static data structures for compile-time commands. Requires feature: static_registry Static data structures for compile-time commands. Requires feature: static_registry Static data structures for compile-time commands. Requires feature: static_registry Static data structures for compile-time commands. Requires feature: static_registry
StaticCommandMap
Static data structures for compile-time commands. Requires feature: static_registry Static data structures for compile-time commands. Requires feature: static_registry Static data structures for compile-time commands. Requires feature: static_registry Static data structures for compile-time commands. Requires feature: static_registry Static data structures for compile-time commands. Requires feature: static_registry
StaticCommandRegistry
Command registry management. Some functions gated by approach features. Command registry management. Some functions gated by approach features. Command registry management. Some functions gated by approach features. Command registry management. Some functions gated by approach features. Command registry management. Some functions gated by approach features.
StaticModule
Multi-YAML build system for compile-time aggregation. Requires feature: multi_file Re-export key builder types Multi-YAML build system for compile-time aggregation. Requires feature: multi_file Re-export key builder types Static module configuration for ergonomic APIs
StringInterner
String interning system for performance optimization. String interning system for performance optimization. Thread-safe string interner that caches strings and returns ’static references.
TypeError
Value types and type system. Value types and type system. Value types and type system. Value types and type system. Value types and type system. An error that can occur during type parsing or validation.
VerifiedCommand
Semantic analysis and validation. Semantic analysis and validation. Semantic analysis and validation. Semantic analysis and validation. Semantic analysis and validation.
VersionType
Core data structures and types. Core data structures and types. Core data structures and types. Core data structures and types. Core data structures and types.

Enums§

AggregationMode
Multi-YAML build system for compile-time aggregation. Requires feature: multi_file Re-export key builder types Multi-YAML build system for compile-time aggregation. Requires feature: multi_file Re-export key builder types Ergonomic CLI aggregation modes
CommandStatus
Core data structures and types. Core data structures and types. Core data structures and types. Core data structures and types. Core data structures and types.
ConflictResolutionStrategy
Multi-YAML build system for compile-time aggregation. Requires feature: multi_file Re-export key aggregator types Multi-YAML build system for compile-time aggregation. Requires feature: multi_file Re-export key aggregator types Conflict resolution strategies for handling duplicate commands
ConflictType
Multi-YAML build system for compile-time aggregation. Requires feature: multi_file Re-export key aggregator types Multi-YAML build system for compile-time aggregation. Requires feature: multi_file Re-export key aggregator types Types of conflicts that can be detected
Error
Error handling utilities. Error handling utilities. Error handling utilities. Error handling utilities. Error handling utilities.
ErrorCode
Core data structures and types. Core data structures and types. Core data structures and types. Core data structures and types. Core data structures and types. Standard error codes for command execution failures
HelpVerbosity
Help generation system. Help generation system. Help generation system. Help generation system. Help generation system.
Kind
Core data structures and types. Core data structures and types. Core data structures and types. Core data structures and types. Core data structures and types.
ModuleSource
Multi-YAML build system for compile-time aggregation. Requires feature: multi_file Re-export key builder types Multi-YAML build system for compile-time aggregation. Requires feature: multi_file Re-export key builder types Module source type for aggregation
RegistryMode
Command registry management. Some functions gated by approach features. Command registry management. Some functions gated by approach features. Command registry management. Some functions gated by approach features. Command registry management. Some functions gated by approach features. Command registry management. Some functions gated by approach features. Registry operation mode for hybrid command lookup optimization
StaticKind
Static data structures for compile-time commands. Requires feature: static_registry Static data structures for compile-time commands. Requires feature: static_registry Static data structures for compile-time commands. Requires feature: static_registry Static data structures for compile-time commands. Requires feature: static_registry Static data structures for compile-time commands. Requires feature: static_registry
StaticValidationRule
Static data structures for compile-time commands. Requires feature: static_registry Static data structures for compile-time commands. Requires feature: static_registry Static data structures for compile-time commands. Requires feature: static_registry Static data structures for compile-time commands. Requires feature: static_registry Static data structures for compile-time commands. Requires feature: static_registry
UnilangError
High-level pipeline API. High-level pipeline API. High-level pipeline API. High-level pipeline API. High-level pipeline API.
ValidationRule
Core data structures and types. Core data structures and types. Validation rule for argument values.
Value
Value types and type system. Value types and type system. Value types and type system. Value types and type system. Value types and type system. Represents a parsed and validated value of a specific kind.

Traits§

CommandRegistryTrait
Command registry management. Some functions gated by approach features. Command registry management. Some functions gated by approach features. Common trait for command registries to enable interoperability.

Functions§

aggregate_cli_complex
Multi-YAML build system for compile-time aggregation. Requires feature: multi_file Re-export key aggregator types Multi-YAML build system for compile-time aggregation. Requires feature: multi_file Re-export key aggregator types More complex aggregate_cli simulation
aggregate_cli_simple
Multi-YAML build system for compile-time aggregation. Requires feature: multi_file Re-export key aggregator types Multi-YAML build system for compile-time aggregation. Requires feature: multi_file Re-export key aggregator types Convenience function for zero-boilerplate static aggregation (aggregate_cli! macro simulation)
compute_full_name_core
Core validation logic shared between runtime and build.rs. This module can be included in build.rs via include!() since it has no dependencies. Core validation logic shared between runtime and build.rs. This module can be included in build.rs via include!() since it has no dependencies. Core validation logic shared between runtime and build.rs. This module can be included in build.rs via include!() since it has no dependencies. Core validation logic shared between runtime and build.rs. This module can be included in build.rs via include!() since it has no dependencies. Core validation logic shared between runtime and build.rs. This module can be included in build.rs via include!() since it has no dependencies. Computes full command name from namespace and name.
create_aggregated_registry
Multi-YAML build system for compile-time aggregation. Requires feature: multi_file Re-export key aggregator types Multi-YAML build system for compile-time aggregation. Requires feature: multi_file Re-export key aggregator types Runtime multi-YAML aggregation with environment variable support.
extract_bool
Config value extraction utilities. Generic extractors for HashMap<String, (JsonValue, S)> config maps. Requires feature: json_parser Config value extraction utilities. Generic extractors for HashMap<String, (JsonValue, S)> config maps. Requires feature: json_parser Extract bool value from config.
extract_f64
Config value extraction utilities. Generic extractors for HashMap<String, (JsonValue, S)> config maps. Requires feature: json_parser Config value extraction utilities. Generic extractors for HashMap<String, (JsonValue, S)> config maps. Requires feature: json_parser Extract f64 value from config.
extract_i32
Config value extraction utilities. Generic extractors for HashMap<String, (JsonValue, S)> config maps. Requires feature: json_parser Config value extraction utilities. Generic extractors for HashMap<String, (JsonValue, S)> config maps. Requires feature: json_parser Extract i32 value from config.
extract_i64
Config value extraction utilities. Generic extractors for HashMap<String, (JsonValue, S)> config maps. Requires feature: json_parser Config value extraction utilities. Generic extractors for HashMap<String, (JsonValue, S)> config maps. Requires feature: json_parser Extract i64 value from config.
extract_string
Config value extraction utilities. Generic extractors for HashMap<String, (JsonValue, S)> config maps. Requires feature: json_parser Config value extraction utilities. Generic extractors for HashMap<String, (JsonValue, S)> config maps. Requires feature: json_parser Extract String value from config.
extract_string_array
Config value extraction utilities. Generic extractors for HashMap<String, (JsonValue, S)> config maps. Requires feature: json_parser Config value extraction utilities. Generic extractors for HashMap<String, (JsonValue, S)> config maps. Requires feature: json_parser Extract array of strings from config. Non-string elements are filtered out.
extract_u8
Config value extraction utilities. Generic extractors for HashMap<String, (JsonValue, S)> config maps. Requires feature: json_parser Config value extraction utilities. Generic extractors for HashMap<String, (JsonValue, S)> config maps. Requires feature: json_parser Extract u8 value from config.
extract_u16
Config value extraction utilities. Generic extractors for HashMap<String, (JsonValue, S)> config maps. Requires feature: json_parser Config value extraction utilities. Generic extractors for HashMap<String, (JsonValue, S)> config maps. Requires feature: json_parser Extract u16 value from config.
extract_u32
Config value extraction utilities. Generic extractors for HashMap<String, (JsonValue, S)> config maps. Requires feature: json_parser Config value extraction utilities. Generic extractors for HashMap<String, (JsonValue, S)> config maps. Requires feature: json_parser Extract u32 value from config.
extract_u64
Config value extraction utilities. Generic extractors for HashMap<String, (JsonValue, S)> config maps. Requires feature: json_parser Config value extraction utilities. Generic extractors for HashMap<String, (JsonValue, S)> config maps. Requires feature: json_parser Extract u64 value from config.
global_interner
String interning system for performance optimization. String interning system for performance optimization. Returns a reference to the global string interner instance.
intern
String interning system for performance optimization. String interning system for performance optimization. Convenience function to intern a string using the global interner.
intern_command_name
String interning system for performance optimization. String interning system for performance optimization. Convenience function to intern command names using the global interner.
is_help_command
Command validation utilities. Command validation utilities. Command validation utilities. Command validation utilities. Command validation utilities. Checks if command name ends with “.help” suffix.
is_simd_enabled
SIMD-optimized tokenization for 3-6x performance improvements. Returns true if SIMD optimizations are available and enabled. Returns true if SIMD optimizations are available and enabled.
load_command_definitions_from_json_str
Configuration loading from YAML/JSON. Functions gated by yaml_parser and json_parser features. Configuration loading from YAML/JSON. Functions gated by yaml_parser and json_parser features. Configuration loading from YAML/JSON. Functions gated by yaml_parser and json_parser features. Configuration loading from YAML/JSON. Functions gated by yaml_parser and json_parser features. Configuration loading from YAML/JSON. Functions gated by yaml_parser and json_parser features.
load_command_definitions_from_yaml_str
Configuration loading from YAML/JSON. Functions gated by yaml_parser and json_parser features. Configuration loading from YAML/JSON. Functions gated by yaml_parser and json_parser features. Configuration loading from YAML/JSON. Functions gated by yaml_parser and json_parser features. Configuration loading from YAML/JSON. Functions gated by yaml_parser and json_parser features. Configuration loading from YAML/JSON. Functions gated by yaml_parser and json_parser features.
make_help_command_name
Command validation utilities. Command validation utilities. Command validation utilities. Command validation utilities. Command validation utilities. Builds help command name from command name.
parse_cargo_metadata
Multi-YAML build system for compile-time aggregation. Requires feature: multi_file Re-export key aggregator types Multi-YAML build system for compile-time aggregation. Requires feature: multi_file Re-export key aggregator types Parse Cargo.toml metadata for build configuration
parse_value
Value types and type system. Value types and type system. Value types and type system. Value types and type system. Value types and type system. Parses a raw string input into a Value based on the specified Kind.
process_single_command
High-level pipeline API. High-level pipeline API. High-level pipeline API. High-level pipeline API. High-level pipeline API.
resolve_routine_link
Configuration loading from YAML/JSON. Functions gated by yaml_parser and json_parser features. Configuration loading from YAML/JSON. Functions gated by yaml_parser and json_parser features.
simd_support_info
SIMD-optimized tokenization for 3-6x performance improvements. CPU feature detection for SIMD optimization selection. CPU feature detection for SIMD optimization selection.
validate_command_definition_core
Core validation logic shared between runtime and build.rs. This module can be included in build.rs via include!() since it has no dependencies. Core validation logic shared between runtime and build.rs. This module can be included in build.rs via include!() since it has no dependencies. Core validation logic shared between runtime and build.rs. This module can be included in build.rs via include!() since it has no dependencies. Core validation logic shared between runtime and build.rs. This module can be included in build.rs via include!() since it has no dependencies. Core validation logic shared between runtime and build.rs. This module can be included in build.rs via include!() since it has no dependencies. Validates a complete command definition at build time.
validate_command_for_registration
Command validation utilities. Command validation utilities. Command validation utilities. Command validation utilities. Command validation utilities. Validates entire command definition for registration.
validate_command_name
Command validation utilities. Command validation utilities. Command validation utilities. Command validation utilities. Command validation utilities. Validates command name follows dot-prefix naming convention.
validate_command_name_core
Core validation logic shared between runtime and build.rs. This module can be included in build.rs via include!() since it has no dependencies. Core validation logic shared between runtime and build.rs. This module can be included in build.rs via include!() since it has no dependencies. Core validation logic shared between runtime and build.rs. This module can be included in build.rs via include!() since it has no dependencies. Core validation logic shared between runtime and build.rs. This module can be included in build.rs via include!() since it has no dependencies. Core validation logic shared between runtime and build.rs. This module can be included in build.rs via include!() since it has no dependencies. Validates command name follows dot-prefix naming convention.
validate_full_name_core
Core validation logic shared between runtime and build.rs. This module can be included in build.rs via include!() since it has no dependencies. Core validation logic shared between runtime and build.rs. This module can be included in build.rs via include!() since it has no dependencies. Core validation logic shared between runtime and build.rs. This module can be included in build.rs via include!() since it has no dependencies. Core validation logic shared between runtime and build.rs. This module can be included in build.rs via include!() since it has no dependencies. Core validation logic shared between runtime and build.rs. This module can be included in build.rs via include!() since it has no dependencies. Validates the full name (namespace + name combination).
validate_namespace
Command validation utilities. Command validation utilities. Command validation utilities. Command validation utilities. Command validation utilities. Validates namespace follows dot-prefix naming convention.
validate_namespace_core
Core validation logic shared between runtime and build.rs. This module can be included in build.rs via include!() since it has no dependencies. Core validation logic shared between runtime and build.rs. This module can be included in build.rs via include!() since it has no dependencies. Core validation logic shared between runtime and build.rs. This module can be included in build.rs via include!() since it has no dependencies. Core validation logic shared between runtime and build.rs. This module can be included in build.rs via include!() since it has no dependencies. Core validation logic shared between runtime and build.rs. This module can be included in build.rs via include!() since it has no dependencies. Validates namespace follows dot-prefix naming convention.
validate_parameter_storage_types
Command validation utilities. Command validation utilities. Command validation utilities. Command validation utilities. Command validation utilities. Validates parameter storage types match their multiple attribute.
validate_single_command
High-level pipeline API. High-level pipeline API.
validate_version_core
Core validation logic shared between runtime and build.rs. This module can be included in build.rs via include!() since it has no dependencies. Core validation logic shared between runtime and build.rs. This module can be included in build.rs via include!() since it has no dependencies. Core validation logic shared between runtime and build.rs. This module can be included in build.rs via include!() since it has no dependencies. Core validation logic shared between runtime and build.rs. This module can be included in build.rs via include!() since it has no dependencies. Core validation logic shared between runtime and build.rs. This module can be included in build.rs via include!() since it has no dependencies. Validates version string is non-empty.

Type Aliases§

CommandRoutine
Command registry management. Some functions gated by approach features. Command registry management. Some functions gated by approach features. Command registry management. Some functions gated by approach features. Command registry management. Some functions gated by approach features. Command registry management. Some functions gated by approach features. Type alias for a command routine. A routine takes a VerifiedCommand and an ExecutionContext, and returns a Result of OutputData or ErrorData.
ConfigMap
Config value extraction utilities. Generic extractors for HashMap<String, (JsonValue, S)> config maps. Requires feature: json_parser Config value extraction utilities. Generic extractors for HashMap<String, (JsonValue, S)> config maps. Requires feature: json_parser Type alias for configuration maps with any source type.