4 releases (1 stable)

1.0.0 Sep 21, 2023
0.3.0 Sep 21, 2023
0.2.0 Sep 20, 2023
0.1.0 Sep 19, 2023

#509 in Procedural macros

Download history 117/week @ 2023-12-29 11/week @ 2024-01-05 9/week @ 2024-01-12 66/week @ 2024-01-19 55/week @ 2024-01-26 20/week @ 2024-02-02 6/week @ 2024-02-09 37/week @ 2024-02-16 42/week @ 2024-02-23 68/week @ 2024-03-01 56/week @ 2024-03-08 38/week @ 2024-03-15 3/week @ 2024-03-22 22/week @ 2024-03-29 35/week @ 2024-04-05 11/week @ 2024-04-12

77 downloads per month

MIT license

7KB
71 lines

getter-methods

ci docs license

This is getter-methods, a derive macro that will generate an impl with accessor methods for each field on the struct.

Using getter-methods is straightforward: simply derive it:

use getter_methods::GetterMethods;

#[derive(GetterMethods)]
struct Foo {
  bar: String,
  baz: i64,
}

let foo = Foo { bar: "bacon".into(), baz: 42 };
assert_eq!(foo.bar(), "bacon");
assert_eq!(foo.baz(), 42);

For more, see the documentation.


lib.rs:

getter_methods is a derive macro that will implement accessor methods for each field on the struct.

Using getter_methods is straightforward: simply derive it:

use getter_methods::GetterMethods;

#[derive(GetterMethods)]
struct Foo {
  bar: String,
  baz: i64,
}

let foo = Foo { bar: "bacon".into(), baz: 42 };
assert_eq!(foo.bar(), "bacon");
assert_eq!(foo.baz(), 42);

Return types

Accessors will get a convenient return type depending on the type of the field on the struct:

Struct Field Accessor Return Type
String [&str][str]
Primitive T (e.g. [i64]) T
Any other T &T

Documentation

Any docstrings used on the fields are copied to the accessor method.

Skipping fields

If you don't want a certain field to have an accessor method, annotate it:

use getter_methods::GetterMethods;

#[derive(GetterMethods)]
struct Foo {
  bar: String,
  #[getter_methods(skip)]
  baz: i64,
}

let foo = Foo { bar: "bacon".into(), baz: 42 }
assert_eq!(foo.bar(), "bacon");
assert_eq!(foo.baz(), 42);  // Compile error: There is no `foo.baz()`.

Dependencies

~335–790KB
~19K SLoC