#newtype #class #value #derive-value-struct

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

#349 in Rust patterns

Download history 12113/week @ 2024-12-14 4554/week @ 2024-12-21 6144/week @ 2024-12-28 15181/week @ 2025-01-04 42529/week @ 2025-01-11 14936/week @ 2025-01-18 13765/week @ 2025-01-25 15741/week @ 2025-02-01 15053/week @ 2025-02-08 13329/week @ 2025-02-15 16449/week @ 2025-02-22 17548/week @ 2025-03-01 15595/week @ 2025-03-08 18948/week @ 2025-03-15 16209/week @ 2025-03-22 15694/week @ 2025-03-29

69,283 downloads per month
Used in 23 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
~37K SLoC