#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

#365 in Rust patterns

Download history 10915/week @ 2024-10-30 10502/week @ 2024-11-06 13725/week @ 2024-11-13 12813/week @ 2024-11-20 10383/week @ 2024-11-27 12788/week @ 2024-12-04 12851/week @ 2024-12-11 8664/week @ 2024-12-18 4934/week @ 2024-12-25 8660/week @ 2025-01-01 32083/week @ 2025-01-08 26741/week @ 2025-01-15 15140/week @ 2025-01-22 13780/week @ 2025-01-29 16536/week @ 2025-02-05 10619/week @ 2025-02-12

59,069 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