#validation #macro #input #accord #length #contain

adequate

A yet another validation library provides a macro inspired by Accord

6 releases

0.1.5 Mar 2, 2025
0.1.4 Feb 26, 2025
0.1.3 Jan 24, 2025
0.1.2 May 19, 2021
0.1.0 Oct 15, 2020

#465 in Web programming

Download history 1/week @ 2024-11-13 1/week @ 2024-11-20 116/week @ 2025-01-22 18/week @ 2025-01-29 7/week @ 2025-02-05 310/week @ 2025-02-26

320 downloads per month

Apache-2.0

37KB
945 lines

Adequate

status-badge doc::adequate crate::adequate

A yet another validation library provides a macro inspired by Accord.

Repositories

This library is developed mainly on Codeberg.org, but the source code is hosted also on sourcehut.

Any patches, merge/pull requests or issues on those repositories are welcomed.

# the main branch is "trunk"
% git clone git@codeberg.org:grauwoelfchen/adequate.git
% git --no-pager branch -v
* trunk xxxxxxx XXX

Installation

% cargo install adequate

Usage

TODO: Add more detailed examples

See src/validation directory for validators.

use adequate::validation::{contain, length};

// input
let fullname = Some("Albrecht Dürer".to_string());
let username = "albrecht".to_string();

let result = validate! {
    "fullname" => fullname => [
        length::max_if_present(3)
    ],
    "username" => username => [
        length::within(3..9),
        contain::contains_only_alphanumeric_chars(),
    ],
};
assert!(result.is_err());

Validations

Contain
  • contains
  • contains_any
  • contains_any_digits
  • contains_any_lower_letters
  • contains_any_upper_letters
  • contains_only
  • contains_only_alphanumeric_chars
  • contains_if_present
  • contains_if_given
  • not_contain_if_given
Length
  • max
  • max_if_present
  • min
  • min_if_present
  • within

Development

See help as below:

% make help

Vet

% make check
% make fmt
% make lint

# check code using all these vet-{check,format,lint} targets at once
% make vet

Test

% make test

# check the report by kcov
% make cov

Build

# debug build
% make build

Release

All notable released changes of this package will be documented in CHANGELOG file.

Unreleased commits

v0.1.5...trunk

License

Adequate
Copyright 2020-2025 Yasha

Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at

   http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.

Dependencies

~0.4–1MB
~21K SLoC