Rust-Property

Generate several common methods for structs automatically.

Usage

Apply the derive proc-macro #[derive(Property)] to structs, and use #[property(..)] to configure it.

Set container attributes can change the default settings for all fields.

Change the settings of a single field via setting field attributes.

There are three kinds of methods: get (is for Boolean), set, get_mut.

The return type of get method can be set via get_type, there are three kinds of the return type: ref (default in most cases), clone and copy.

In Action

Original Code

use property::Property;

#[derive(Copy, Clone)]
pub enum Species {
    Dog,
    Cat,
    Bird,
    Other,
}

#[derive(Property)]
#[property(get(public), set(private), get_mut(disable))]
pub struct Pet {
    #[property(set(disable))]
    id: [u8; 32],
    name: String,
    #[property(set(crate))]
    age: u32,
    #[property(get_type(copy))]
    species: Species,
    died: bool,
    #[property(get_type(clone))]
    owner: String,
    family_members: Vec<String>,
    #[property(get_type(ref))]
    info: String,
    #[property(get_mut(public))]
    note: Option<String>,
}

Generated Code

impl Pet {
    #[inline(always)]
    pub fn get_id(&self) -> &[u8] {
        &self.id[..]
    }
    #[inline(always)]
    pub fn get_name(&self) -> &str {
        &self.name[..]
    }
    #[inline(always)]
    fn set_name(&mut self, val: String) -> &mut Self {
        self.name = val;
        self
    }
    #[inline(always)]
    pub fn get_age(&self) -> u32 {
        self.age
    }
    #[inline(always)]
    pub(crate) fn set_age(&mut self, val: u32) -> &mut Self {
        self.age = val;
        self
    }
    #[inline(always)]
    pub fn get_species(&self) -> Species {
        self.species
    }
    #[inline(always)]
    fn set_species(&mut self, val: Species) -> &mut Self {
        self.species = val;
        self
    }
    #[inline(always)]
    pub fn is_died(&self) -> bool {
        self.died
    }
    #[inline(always)]
    fn set_died(&mut self, val: bool) -> &mut Self {
        self.died = val;
        self
    }
    #[inline(always)]
    pub fn get_owner(&self) -> String {
        self.owner.clone()
    }
    #[inline(always)]
    fn set_owner(&mut self, val: String) -> &mut Self {
        self.owner = val;
        self
    }
    #[inline(always)]
    pub fn get_family_members(&self) -> &[String] {
        &self.family_members[..]
    }
    #[inline(always)]
    fn set_family_members(&mut self, val: Vec<String>) -> &mut Self {
        self.family_members = val;
        self
    }
    #[inline(always)]
    pub fn get_info(&self) -> &String {
        &self.info
    }
    #[inline(always)]
    fn set_info(&mut self, val: String) -> &mut Self {
        self.info = val;
        self
    }
    #[inline(always)]
    pub fn get_note(&self) -> Option<&String> {
        self.note.as_ref()
    }
    #[inline(always)]
    fn set_note(&mut self, val: Option<String>) -> &mut Self {
        self.note = val;
        self
    }
    #[inline(always)]
    pub fn get_mut_note(&mut self) -> &mut Option<String> {
        &mut self.note
    }
}

Enjoy it!

License