1 unstable release

Uses new Rust 2024

new 0.1.0 Apr 17, 2025

#525 in Rust patterns

MIT/Apache

19KB
466 lines

Accessorise

Crates.io License Downloads Docs Twitch Status

X | Twitch | Youtube | Mastodon | GitHub | GitHub Sponsors

Add accessors to your objects.


use accessorise::*;

//use super::*;

use paste::paste;

trait TestTrait
{

    trait_get!(a_number, i32);

    trait_set!(a_number, i32);

    trait_get_ref!(a_string, String);

    trait_get_mut!(a_string, String);

    trait_get!(a_number_doc, i8, "This is a getter declaration, presumably for a number field.");

    trait_set!(a_number_doc, i8, "This is a setter declaration, presumably for a number field.");

    trait_get_ref!(a_string_doc, String, "This is a getter declaration, presumably for a String field.");

    trait_get_mut!(a_string_doc, String, "This is a setter declaration, presumably for a String field.");

}

#[derive(Default)]
struct TestStruct
{

    a_number: i32,
    a_string: String,
    a_number_doc: i8,
    a_string_doc: String,
    some_numbers: Vec<i32>

}

impl TestStruct
{

    pub fn new() -> Self
    {

        Self::default()

    }

    impl_get!(a_number, i32);

    impl_set!(a_number, i32);

    impl_get_clone!(a_string, String);

    impl_get_clone!(a_string_doc, String, "Returns a cloned String.");

    impl_get_ref!(some_numbers, Vec<i32>, "Returns some numbers by reference.");

    impl_get_mut!(some_numbers, Vec<i32>, "Returns some numbers by mutable reference.");

    impl_get_clone!(some_numbers, Vec<i32>);

    impl_set_clone!(some_numbers, Vec<i32>);

}

impl TestTrait for TestStruct
{

    impl_trait_get!(a_number, i32);

    impl_trait_set!(a_number, i32);

    impl_trait_get_ref!(a_string, String);

    impl_trait_get_mut!(a_string, String);

    impl_trait_get!(a_number_doc, i8, "This is a getter implementation for a number field.");

    impl_trait_set!(a_number_doc, i8, "This is a setter implementation for a number field.");

    impl_trait_get_ref!(a_string_doc, String, "This is a getter implementation for a String field.");

    impl_trait_get_mut!(a_string_doc, String, "This is a setter implementation for a String field.");
    
}

fn main()
{
    
    let mut test_struct = TestStruct::new();

    let _number = test_struct.a_number();

    test_struct.set_a_number(5);

}


Compiler:

Build with the latest stable compiler.


Todo:

  • Add documentation
  • Add more macros
  • Add macro rules for things like aliases and multiple accessor declarations and definitions in one macro call.

Coding Style

This project uses a coding style the emphasises the use of white space over keeping the line and column counts as low as possible.

So this:

fn bar() {}

fn foo()
{

    bar();

}

Not this:

fn bar() {}

fn foo()
{
    bar();
}


License

Licensed under either of:

at your discretion


Contributing

Please clone the repository and create an issue explaining what feature or features you'd like to add or bug or bugs you'd like to fix and perhaps how you intend to implement these additions or fixes. Try to include details though it doesn't need to be exhaustive and we'll take it from there (dependant on availability).


Unless you explicitly state otherwise, any contribution intentionally submitted for inclusion in the work by you, as defined in the Apache-2.0 license, shall be dual licensed as above, without any additional terms or conditions.

No runtime deps