#newtype #class #value

macro rvs_derive

A helper macros implementation for Value Classes in Rust

11 releases

0.3.2 Dec 11, 2022
0.3.1 Dec 11, 2022
0.3.0 Nov 4, 2021
0.2.3 Jun 19, 2020
0.1.1 Apr 30, 2020

#59 in #newtype

Download history 6101/week @ 2024-03-30 5730/week @ 2024-04-06 7725/week @ 2024-04-13 7466/week @ 2024-04-20 5916/week @ 2024-04-27 5910/week @ 2024-05-04 6172/week @ 2024-05-11 6497/week @ 2024-05-18 6212/week @ 2024-05-25 5955/week @ 2024-06-01 8217/week @ 2024-06-08 8371/week @ 2024-06-15 8828/week @ 2024-06-22 8371/week @ 2024-06-29 9136/week @ 2024-07-06 6454/week @ 2024-07-13

34,163 downloads per month
Used in 20 crates (via rvstruct)

Apache-2.0

9KB
137 lines

Cargo

Value Structs derive macros for Rust to support the newtype pattern

Motivation

A very simple derive macros to support strong type system and the newtype pattern. Newtypes are a zero-cost abstraction: they introduce a new, distinct name for an existing type, with no runtime overhead when converting between the two types. This is a similar approach to Haskell's newtype keyword.

For example:

#[derive(ValueStruct)]
struct UserId(String);

let uid : UserId = "my-uid".into();

Macros overview

ValueStruct generates for you:

  • std::convert::From<> instances automatically to help you to create your structs.
  • ValueStruct::value() function implementation to access your field directly without using .0.

There are different behaviour for different field types:

  • For std::string::String it generates From<String>, From<&String>, From<&str>

Usage

Add this to your Cargo.toml:

[dependencies]
rvstruct = "0.3"
// Import it
use rvstruct::ValueStruct;

// And use it on your structs
#[derive(ValueStruct)]
struct UserId(String);

Licence

Apache Software License (ASL)

Author

Abdulla Abdurakhmanov

Dependencies

~1.5MB
~35K SLoC