get_set_macro

Procedural macro to automatically generate getters and setters for struct fields in Rust, with fine-grained control over behavior.

Features

• Generate getters that return either references or copies, depending on your needs.
• Automatically generate setters for fields.
• Customize method names for getters and setters.
• Choose to have a getter or setter be not inlined with noinline
• Return proper compiler errors instead of panicking.
• Lightweight and minimal dependencies.

Installation

Run cargo add get_set_macro.

Usage

Import the macro:

use get_set_macro::get_set;

Apply it to a struct: (see tests/ui/ok_readme.rs)

#[get_set(default(vis = "pub"))]
struct Example {
    #[gsflag(get)]
    name: String,

    #[gsflag(get_copy)]
    age: u32,

    #[gsflag(get(inline_always, rename = "city_ref"), set(rename = "set_city"))]
    city: String,
}

// Has functionality
fn main() {
    let mut example = Example {
        name: "ExampleName".to_string(),
        age: 55,
        city: "ExampleCity".to_string(),
    };

    assert_eq!("ExampleName", example.get_name().as_str());
    assert_eq!(55, example.get_age());
    assert_eq!("ExampleCity", example.city_ref().as_str());

    example.set_city("NewCity".to_string());

    assert_eq!("NewCity", example.city_ref().as_str());
}

Attributes

Note: Only structs with named fields are currently supported.

Limitations

• Only named fields (struct Foo { x: T }) are supported — tuple structs are not yet supported.

Planned Features

• accessor shorthand. e.g. #[gsflags(accessor(...))]would be the same as #[gsflags(get(...), set(...))] (ignoring rename).
• default tag changing the default behaviour. e.g. #[get_set(default(...))] or #[gsflags(default(...))] would change get into get(...) (ignoring rename).

Contributing

Pull requests, issues, and suggestions are welcome!

If you find a bug or would like to request a feature, feel free to open an issue.

License

This project is licensed under the MIT License.

Acknowledgments

I did this.