get_set_macro

Crates.ioget_set_macro
lib.rsget_set_macro
version1.1.2
created_at2025-04-27 22:20:44.838944+00
updated_at2025-04-30 02:53:24.171149+00
descriptionProcedural macro to generate customizable getters and setters in Rust
homepage
repositoryhttps://github.com/Orkking2/get_set_macro
max_upload_size
id1651514
size35,676
Orkking2 (Orkking2)

documentation

https://docs.rs/get_set_macro

README

get_set_macro

Crates.io Docs.rs

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

Features

Syntactically efficient way of creating getters and/or setters with lots of customizability (see Attributes).

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

Attribute Description
#[get] Generate a getter that returns a reference.
#[get_copy] Generate a getter that returns a copy. (Use only with Copy types.)
#[set] Generate a setter that sets a new value.
rename = "..." Customize the method name (e.g., #[gsflags(get(rename = "fetch_{name}"))]).
inline(|_always|_never) Choose to have a getter or setter inlined and how (e.g. #[gsflags(get(inline_always, rename = "always_inlined_get"))]).
#[set_get(struct-wide settings)] Applies get/set settings to all fields in the struct (ignores rename). If default is used here, it will be the default to every gsflags attribute in the struct.
skip Skip struct-wide gs-settings for this field.
vis = "..." Change the visibility of generated getters/setters.
default(...) Applies get/set settings (except rename) to each getter/setter in this gsflags attribute

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.

Commit count: 36

cargo fmt