A procedural macro for configuring constant values across crates

James Munns

Last update: Dec 24, 2022

Related tags

Learning Resources toml-cfg

Overview

`toml-cfg`

Rough ideas:

Crates can declare variables that can be overridden
- Anything const, e.g. usize, strings, etc.
(Only) The "root crate" can override these variables by including a cfg.toml file

Config file

# a toml-cfg file

[lib-one]
buffer_size = 4096

[lib-two]
greeting = "Guten tag!"

In the library

// lib-one
#[toml_cfg::toml_config]
pub struct Config {
    #[default(32)]
    buffer_size: usize,
}

// lib-two
#[toml_cfg::toml_config]
pub struct Config {
    #[default("hello")]
    greeting: &'static str,
}

Look at what we get!

# Print the "buffer_size" value from the `lib-one` crate.
# Since it has no cfg.toml, we just get the default value.
$ cd pkg-example/lib-one
$ cargo run
    Finished dev [unoptimized + debuginfo] target(s) in 0.01s
     Running `target/debug/lib-one`
32

# Print the "greeting" value from the `lib-two` crate.
# Since it has no cfg.toml, we just get the default value.
$ cd ../lib-two
$ cargo run
   Compiling lib-two v0.1.0 (/home/james/personal/toml-cfg/pkg-example/lib-two)
    Finished dev [unoptimized + debuginfo] target(s) in 0.32s
     Running `target/debug/lib-two`
hello

# Print the "buffer_size" value from `lib-one`, and "greeting"
# from `lib-two`. Since we HAVE defined a `cfg.toml` file, the
# values defined there are used instead.
$ cd ../application
$ cargo run
   Compiling lib-two v0.1.0 (/home/james/personal/toml-cfg/pkg-example/lib-two)
   Compiling application v0.1.0 (/home/james/personal/toml-cfg/pkg-example/application)
    Finished dev [unoptimized + debuginfo] target(s) in 0.30s
     Running `target/debug/application`
4096
Guten tag!

A Rust macro for writing nested loop expressions

loop_chain A Rust macro for writing nested loop expressions Usage | Examples | Docs Dependencies [dependencies] loop_chain = "0.1.1" Usage For express

5 Jul 30, 2021

Macro assembler for Rust

Macro Assembler This crate implement JSC/SpiderMonkey like macro assembler. Macro assembler purpose is to generate machine code for different platform

6 Nov 26, 2022

A Rust attribute macro that adds memoization to a function (rhymes with Mickey)

michie (sounds like Mickey) — an attribute macro that adds memoization to a function. Table of contents Features Non-features key_expr key_type store_

16 Dec 20, 2022

Proc macro implementation of #[naked]

#[naked] Documentation This crate provide a proc macro version of the #[naked] attribute which can be used on stable Rust. Example // The SYSV64 calli

10 Aug 13, 2022

Macro for fast implementing serialize methods in serde::Serializer trait

impl_serialize! This library provides a simple procedural macro for fast implementing serialize methods in serde::Serializer trait. [dependencies] imp

2 Sep 6, 2022

hashmap macro for creating hashmap from provided key/value pairs

HashMap Macro Creates a HashMap from provided key/value pairs. Usage use std::collections::HashMap; use hashmap_macro::hashmap; let m: HashMap&str,

6 Oct 2, 2022

Library and proc macro to analyze memory usage of data structures in rust.

Allocative: memory profiler for Rust This crate implements a lightweight memory profiler which allows object traversal and memory size introspection.

19 Jan 6, 2023

Simple Rust derive-macro that simplifies integral enum creation

Integral enum A simple way to define integer-like enums. This macro implements bunch of traits that are usually implemented via looooong derive(..) at

3 Jan 6, 2023

proc-macro to help with using surrealdb's custom functions

SurrealDB Functions This is a proc-macro crate that given a path to a .surql file or a folder of .surql files, will parse DEFINE FUNCTION fn::s inside

5 Jul 30, 2023

Comments

Configuration file changes aren't automatically detected

Unfortunately, changing the cfg.toml does not prompt the macro to be re-invoked. For now, you'll need to run cargo clean after changing the config file.

If you know how to fix this, please let me know!

opened by jamesmunns 1
Valid config not found for cargo doc --open command
Unexpected behaviour of the TOML_CFG=require_cfg_present env:

The cargo doc --open fails when TOML_CFG=require_cfg_present is set, even when there is an existing valid cfg.toml file. The cargo build, nonetheless, works as expected (i.e. fails only when the cfg.toml file is missing).

Error:

error: custom attribute panicked --> src\main.rs:10:1 | 10 | #[toml_cfg::toml_config] | ^^^^^^^^^^^^^^^^^^^^^^^^ | = help: message: TOML_CFG=require_cfg_present set, but valid config not found! error: Compilation failed, aborting rustdoc error: could not document `tst-rust-esp32`
opened by theguardian58 0
configuration file name

I've mistakenly used config.toml as file name several times, so I'd suggest a rename. However, a bare config.toml name would cause confusion with .cargo/config.toml, so how about something along the lines of project-config.toml or crate-config.toml?

opened by spookyvision 0

Owner

James Munns

Bringing Rust to new places, big and small. Resources Team @ Rust Embedded Working Group

GitHub

A procedural macro to generate a new function implementation for your struct.

Impl New ?? A procedural macro to generate a new function implementation for your struct. ?? Add to your project Add this to your Cargo.toml: [depende

4 Sep 8, 2023

"Crates for Cheese" is a Rust collection library of those crates I consider a useful "extended standard".

cfc The purpose of this library is to provide a minimal list of currated crates which enhance the std library. In addition, most or all crates in this

0 Dec 23, 2021

Learn to write Rust procedural macros [Rust Latam conference, Montevideo Uruguay, March 2019]

Rust Latam: procedural macros workshop This repo contains a selection of projects designed to learn to write Rust procedural macros — Rust code that g

2.5k Dec 29, 2022

Simple and customizable procedural noise generation library written in Rust.

libnoise A simple, performant, and customizable procedural noise generation library inspired by libnoise for C++ featuring: Easy coherent noise genera

29 Aug 13, 2023

CloudLLM is a Rust library designed to seamlessly bridge applications with remote Language Learning Models (LLMs) across various platforms.

CloudLLM CloudLLM is a Rust library designed to seamlessly bridge applications with remote Language Learning Models (LLMs) across various platforms. W

4 Oct 13, 2023

A procedural macro for configuring constant values across crates

Related tags

Overview

`toml-cfg`

Config file

In the library

Look at what we get!

You might also like...

A Rust macro for writing nested loop expressions

Macro assembler for Rust

A Rust attribute macro that adds memoization to a function (rhymes with Mickey)

Proc macro implementation of #[naked]

Macro for fast implementing serialize methods in serde::Serializer trait

hashmap macro for creating hashmap from provided key/value pairs

Library and proc macro to analyze memory usage of data structures in rust.

Simple Rust derive-macro that simplifies integral enum creation

proc-macro to help with using surrealdb's custom functions

Comments

Configuration file changes aren't automatically detected

Valid config not found for cargo doc --open command

configuration file name

Owner

James Munns

A procedural macro to generate a new function implementation for your struct.

"Crates for Cheese" is a Rust collection library of those crates I consider a useful "extended standard".

Learn to write Rust procedural macros [Rust Latam conference, Montevideo Uruguay, March 2019]

Simple and customizable procedural noise generation library written in Rust.

CloudLLM is a Rust library designed to seamlessly bridge applications with remote Language Learning Models (LLMs) across various platforms.

UNIC: Unicode and Internationalization Crates for Rust

List public items (public API) of Rust library crates. Enables diffing public API between releases.

Rust crates with map and set with interval keys (ranges x..y).

Game development practices with Rust programming language. I want to use different crates for this.

A collection of crates to make minecraft development (client, server) with rust possible.