#newtype #class #macro-derive #value

rvstruct

A helper macros implementation for Value Classes in Rust

6 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

#1006 in Rust patterns

Download history 9693/week @ 2024-08-17 10288/week @ 2024-08-24 10243/week @ 2024-08-31 11066/week @ 2024-09-07 11403/week @ 2024-09-14 12337/week @ 2024-09-21 11918/week @ 2024-09-28 11496/week @ 2024-10-05 11104/week @ 2024-10-12 12968/week @ 2024-10-19 10842/week @ 2024-10-26 11307/week @ 2024-11-02 11715/week @ 2024-11-09 13168/week @ 2024-11-16 10641/week @ 2024-11-23 10890/week @ 2024-11-30

48,431 downloads per month
Used in 22 crates (8 directly)

Apache-2.0

6KB

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
~38K SLoC