11 releases

0.2.14 Jul 5, 2022
0.2.13 Sep 18, 2021
0.2.10 Aug 20, 2021
0.2.5 Jul 30, 2021
0.2.4 Mar 31, 2021

#247 in Rust patterns

Download history 3314/week @ 2022-06-01 2046/week @ 2022-06-08 2090/week @ 2022-06-15 5737/week @ 2022-06-22 6756/week @ 2022-06-29 6735/week @ 2022-07-06 6531/week @ 2022-07-13 5964/week @ 2022-07-20 5190/week @ 2022-07-27 7127/week @ 2022-08-03 6145/week @ 2022-08-10 6776/week @ 2022-08-17 6102/week @ 2022-08-24 3604/week @ 2022-08-31 3323/week @ 2022-09-07 3033/week @ 2022-09-14

17,452 downloads per month
Used in 28 crates (via konst)

Zlib license

23KB
671 lines

Rust crates-io api-docs

Const equivalents of std functions, compile-time comparison, and parsing.

Features

This crate provides:

Examples

Parsing an enum

This example demonstrates how you can parse a simple enum from an environment variable, at compile-time.

use konst::eq_str;
use konst::{unwrap_opt_or, unwrap_ctx};

#[derive(Debug, PartialEq)]
enum Direction {
    Forward,
    Backward,
    Left,
    Right,
}

impl Direction {
    const fn try_parse(input: &str) -> Result<Self, ParseDirectionError> {
        // As of Rust 1.51.0, string patterns don't work in const contexts
        match () {
            _ if eq_str(input, "forward") => Ok(Direction::Forward),
            _ if eq_str(input, "backward") => Ok(Direction::Backward),
            _ if eq_str(input, "left") => Ok(Direction::Left),
            _ if eq_str(input, "right") => Ok(Direction::Right),
            _ => Err(ParseDirectionError),
        }
    }
}

const CHOICE: &str = unwrap_opt_or!(option_env!("chosen-direction"), "forward");

const DIRECTION: Direction = unwrap_ctx!(Direction::try_parse(CHOICE));

fn main() {
    match DIRECTION {
        Direction::Forward => assert_eq!(CHOICE, "forward"),
        Direction::Backward => assert_eq!(CHOICE, "backward"),
        Direction::Left => assert_eq!(CHOICE, "left"),
        Direction::Right => assert_eq!(CHOICE, "right"),
    }
}

#[derive(Debug, PartialEq)]
pub struct ParseDirectionError;

use std::fmt::{self, Display};

impl Display for ParseDirectionError {
    fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
        f.write_str("Failed to parse a Direction")
    }
}

impl ParseDirectionError {
    const fn panic(&self) -> ! {
        [/*failed to parse a Direction*/][0]
    }
}



Parsing integers

You can parse integers using the parse_* functions in primitive, returning an Err(ParseIntError{...}) if the string as a whole isn't a valid integer.

use konst::{
    primitive::{ParseIntResult, parse_i128},
    result::unwrap_ctx,
};

const N_100: ParseIntResult<i128> = parse_i128("100");
assert_eq!(N_100, Ok(100));

const N_N3: ParseIntResult<i128> = parse_i128("-3");
assert_eq!(N_N3, Ok(-3));


// This is how you can unwrap integers parsed from strings, at compile-time.
const N_100_UNW: i128 = unwrap_ctx!(parse_i128("1337"));
assert_eq!(N_100_UNW, 1337);


const NONE: ParseIntResult<i128> = parse_i128("-");
assert!(NONE.is_err());

const PAIR: ParseIntResult<i128> = parse_i128("1,2");
assert!(PAIR.is_err());



For parsing an integer inside a larger string, you can use Parser::parse_u128 method and the other parse_* methods

use konst::{Parser, unwrap_ctx};

const PAIR: (i64, u128) = {;
    let parser = Parser::from_str("1365;6789");

    // Parsing "1365"
    let (l, parser) = unwrap_ctx!(parser.parse_i64());

    // Skipping the ";"
    let parser = unwrap_ctx!(parser.strip_prefix(";"));

    // Parsing "6789"
    let (r, parser) = unwrap_ctx!(parser.parse_u128());
    
    (l, r)
};
assert_eq!(PAIR.0, 1365);
assert_eq!(PAIR.1, 6789);

Parsing a struct

This example demonstrates how you can use Parser to parse a struct at compile-time.

use konst::{
    parsing::{Parser, ParseValueResult},
    for_range, parse_any, try_rebind, unwrap_ctx,
};

const PARSED: Struct = {
    // You can also parse strings from environment variables, or from an `include_str!(....)`
    let input = "\
        1000,
        circle,
        red, blue, green, blue,
    ";
    
    unwrap_ctx!(parse_struct(Parser::from_str(input))).0
};

fn main(){
    assert_eq!(
        PARSED,
        Struct{
            amount: 1000,
            repeating: Shape::Circle,
            colors: [Color::Red, Color::Blue, Color::Green, Color::Blue],
        }
    );
}

#[derive(Debug, Clone, PartialEq, Eq)]
pub struct Struct {
    pub amount: usize,
    pub repeating: Shape,
    pub colors: [Color; 4],
}

#[derive(Debug, Clone, PartialEq, Eq)]
pub enum Shape {
    Circle,
    Square,
    Line,
}

#[derive(Debug, Copy, Clone, PartialEq, Eq)]
pub enum Color {
    Red,
    Blue,
    Green,
}

pub const fn parse_struct(mut parser: Parser<'_>) -> ParseValueResult<'_, Struct> {
    try_rebind!{(let amount, parser) = parser.trim_start().parse_usize()}
    try_rebind!{parser = parser.strip_prefix(",")}

    try_rebind!{(let repeating, parser) = parse_shape(parser.trim_start())}
    try_rebind!{parser = parser.strip_prefix(",")}

    try_rebind!{(let colors, parser) = parse_colors(parser.trim_start())}

    Ok((Struct{amount, repeating, colors}, parser))
}

pub const fn parse_shape(mut parser: Parser<'_>) -> ParseValueResult<'_, Shape> {
    let shape = parse_any!{parser, strip_prefix;
        "circle" => Shape::Circle,
        "square" => Shape::Square,
        "line" => Shape::Line,
        _ => return Err(parser.into_other_error())
    };
    Ok((shape, parser))
}

pub const fn parse_colors(mut parser: Parser<'_>) -> ParseValueResult<'_, [Color; 4]> {
    let mut colors = [Color::Red; 4];

    for_range!{i in 0..4 =>
        try_rebind!{(colors[i], parser) = parse_color(parser.trim_start())}
        try_rebind!{parser = parser.strip_prefix(",")}
    }

    Ok((colors, parser))
}

pub const fn parse_color(mut parser: Parser<'_>) -> ParseValueResult<'_, Color> {
    let color = parse_any!{parser, strip_prefix;
        "red" => Color::Red,
        "blue" => Color::Blue,
        "green" => Color::Green,
        _ => return Err(parser.into_other_error())
    };
    Ok((color, parser))
}



Cargo features

These are the features of these crates:

  • "cmp"(enabled by default): Enables all comparison functions and macros, the string equality and ordering comparison functions don't require this feature.

  • "parsing"(enabled by default): Enables the "parsing_no_proc" feature, compiles the konst_proc_macros dependency, and enables the parse_any macro. You can use this feature instead of "parsing_no_proc" if the slightly longer compile times aren't a problem.

  • "parsing_no_proc"(enabled by default): Enables the parsing module (for parsing from &str and &[u8]), the primitive::parse_* functions, try_rebind, and rebind_if_ok macros.

  • alloc": Enables items that use types from the alloc crate, including Vec and String.

Rust release related

  • "const_generics" (disabled by default): Requires Rust 1.51.0. Enables items that require const generics, and impls for arrays to use const generics instead of only supporting small arrays.

  • "rust_1_55": Enables the string::from_utf8 function (the macro works in all versions), str indexing functions, and the "const_generics" feature.

  • "rust_1_56": Enables functions that internally use raw pointer dereferences or transmutes, and the "rust_1_55" feature.

  • "constant_time_slice"(disabled by default):
    Requires Rust nightly. Improves the performance of slice functions that split slices, from taking linear time to taking constant time.
    Note that only functions which mention this feature in their documentation are affected.

  • "mut_refs"(disabled by default): Enables const functions that take mutable references. Use this whenever mutable references in const contexts are stabilized. Also enables the "rust_1_56" feature.

  • "nightly_mut_refs"(disabled by default): Enables the "mut_refs" feature. Requires Rust nightly.

No-std support

konst is #![no_std], it can be used anywhere Rust can be used.

Minimum Supported Rust Version

konst requires Rust 1.46.0, because it uses looping an branching in const contexts.

Features that require newer versions of Rust, or the nightly compiler, need to be explicitly enabled with cargo features.

No runtime deps

Features

  • const_generics
  • deref_raw_in_fn
  • mut_refs
  • nightly_mut_refs
  • rust_1_55
  • rust_1_56