https://github.com/jdno/typed-fields
Macros to create strongly-typed fields for structs
https://github.com/jdno/typed-fields
crate newtype rust
Last synced: over 1 year ago
JSON representation
Macros to create strongly-typed fields for structs
- Host: GitHub
- URL: https://github.com/jdno/typed-fields
- Owner: jdno
- License: apache-2.0
- Created: 2024-01-11T13:33:37.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2025-03-14T06:34:07.000Z (over 1 year ago)
- Last Synced: 2025-03-14T07:30:18.414Z (over 1 year ago)
- Topics: crate, newtype, rust
- Language: Rust
- Homepage:
- Size: 184 KB
- Stars: 0
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE-APACHE
Awesome Lists containing this project
README
# 🦀 `typed-fields`
Do you like strongly-typed structs?
`typed-fields` is a collection of macros that generate types following the
[newtype] pattern. The following types are currently supported:
- `name!` - a string-based type
- `number!` - a number-based type
- `secret!` - a type for secrets (requires the `secret` feature)
- `ulid!` - a type for ULIDs (requires the `ulid` feature)
- `url!` - a type for URLs (requires the `url` feature)
- `uuid!` - a type for UUIDs (requires the `uuid` feature)
## Example
The following example showcases the `number!` macro, which generates a new type
that is backed by an `i64`.
```rust
use typed_fields::number;
// Define a new type that is backed by an `i64`
number!(UserId);
fn main() {
// Create a new `UserId` from an `i64`
let id = UserId::new(42);
// Common traits like `Display` are automatically implemented for the type
println!("User ID: {}", id);
}
```
## License
Licensed under either of
- Apache License, Version 2.0 ([LICENSE-APACHE](LICENSE-APACHE)
or )
- MIT license ([LICENSE-MIT](LICENSE-MIT)
or )
at your option.
## Contribution
Unless you explicitly state otherwise, any contribution intentionally submitted
for inclusion in the work by you, as defined in the Apache-2.0 license, shall be
dual licensed as above, without any additional terms or conditions.
[newtype]: https://doc.rust-lang.org/rust-by-example/generics/new_types.html