CLASP.Rust

Command-Line Argument Sorting and Parsing (for Rust)

Table of Contents

• Introduction
• Developer Experience
• Installation
• Components
  • Constants
  • Enumerations
  • Features
  • Functions
  • Macros
  • Structures
  • Traits
• Examples
• Project Information
  • Where to get help
  • Contribution guidelines
  • Minimum Supported Rust Version (MSRV)
  • Dependencies
    • Efferent (fan-out)
    • Build Dependencies
    • Development Dependencies
    • Afferent (fan-in)
  • Related projects
  • License

Introduction

CLASP stands for Command-Line Argument Sorting and Parsing. CLASP.Rust is an initial published scaffold with no supported public API. The reference implementation is the C/C++ CLASP library. The other implementations are listed under Related projects.

Developer Experience

A stable Rust toolchain at MSRV 1.74 or newer is required. From the crate root:

cargo build
cargo test
./scripts/fmt

scripts/fmt runs the pinned nightly rustfmt described in rustfmt.toml. The stock example is examples/versions/main.rs.

Installation

Reference in Cargo.toml in the usual way:

clasp-rs = { version = "0.0.1" }

Components

Constants

None defined at this time.

Enumerations

None defined at this time.

Features

The following crate features are defined:

• null-feature — a feature that has no effect (useful for simplifying driver scripts);

Functions

None defined at this time.

Macros

None defined at this time.

Structures

None defined at this time.

Traits

None defined at this time.

Examples

Examples can be found in examples/:

• examples/versions/main.rs — prints the crate name and version;

Project Information

Where to get help

GitHub Page

Contribution guidelines

Defect reports, feature requests, and pull requests are welcome on https://github.com/synesissoftware/CLASP.Rust.

Minimum Supported Rust Version (MSRV)

The declared Minimum Supported Rust Version (MSRV) for CLASP.Rust is 1.74.

This MSRV guarantee applies to the library crate itself, its runtime dependencies ([dependencies]), and its build dependencies ([build-dependencies]). Downstream consumers compiling this crate as a dependency are guaranteed that it builds cleanly on the declared MSRV toolchain.

Development dependencies ([dev-dependencies], such as benchmarking frameworks like criterion) may require newer Rust toolchains for local development or performance testing. These dev-dependencies are never fetched or compiled by downstream consumers and do not affect the library's MSRV guarantee.

Dependencies

Efferent (fan-out)

Libraries upon which CLASP.Rust depends:

• None currently.

Build Dependencies

None currently.

Development Dependencies

• test_help-rs — test helpers for unit tests;

Afferent (fan-in)

None currently.

Related projects

• CLASP — the C/C++ reference implementation;
• CLASP.Go;
• CLASP.js;
• CLASP.NET;
• CLASP.Python;
• CLASP.Ruby;
• libCLImate.Rust;

License

CLASP.Rust is released under the 3-clause BSD license. See LICENSE for details.