#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

#54 in #newtype

Download history 4185/week @ 2023-12-15 2394/week @ 2023-12-22 2995/week @ 2023-12-29 4320/week @ 2024-01-05 4342/week @ 2024-01-12 5132/week @ 2024-01-19 5393/week @ 2024-01-26 4785/week @ 2024-02-02 4706/week @ 2024-02-09 4690/week @ 2024-02-16 4266/week @ 2024-02-23 5707/week @ 2024-03-01 5143/week @ 2024-03-08 5866/week @ 2024-03-15 6804/week @ 2024-03-22 4474/week @ 2024-03-29

23,340 downloads per month
Used in 19 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
~33K SLoC