Provides a new type called Named Tups that can be called using the [tup!] macro. Named Tups are structs that can
contain a set of named arguments, effectively they work like normal tuples that can be accessed and created using an
actual name.
The idea of named tuples is to provide a way to quickly iterate on ideas without having to create a builder struct or losing the ability to type check at compile time. Named tuples also allow the creation of default values that can replace nonexistent arguments.
```toml [dependencies] named-tup = "0.1.0"
[package.metadata.inwelling] named-tup-derive = true ```
```rust use named_tup::tup; let count = 5;
// This will have the type of tup!(count: i32, ingredients: [&str; 3], eggs: bool) let cakes = tup!(count, ingredients: ["milk", "flower", "sugar"], eggs: true);
// We can just add a price afterwards let mut cakes = cakes + tup!(price: 3); // And now it has the type of tup!(eggs: bool, ingredients: [&str; 3], count: i32, price: i32)
// Once the price is in the tup we can just update it! cakes.price = 4;
// Will print tup { count: 5, eggs: true, ingredients: ["milk", "flower", "sugar"], price: 4 } println!("{cakes:?}"); ```
To use defaults just annotate the item where you set a field
with #[tup_default]. Additionally since the
defaulted [tup!] is a type you need to convert into it by calling [.into_tup()] which can be accessed through
the [TupInto] trait.
```rust use namedtup::{tup, tupdefault, TupInto};
let options = tup!(read: false, write: true);
// Converts to tup!(read: false, write: true, create: false, timeout: 5) openfile("main.rs", options.intotup());
fn open_file( path: &str, options: tup!( read: bool = true, write: bool = false, create: bool = false, timeout: i32 = 5 )) { // Open the file } ```
To test the crate enable the feature dev-test.
Licensed under either of Apache License, Version 2.0 or MIT license at your option.
Unless you explicitly state otherwise, any contribution intentionally submitted for inclusion in this crate by you, as defined in the Apache-2.0 license, shall be dual licensed as above, without any additional terms or conditions.