Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/Hoverbear/getset
Getters and Setters for Rust.
https://github.com/Hoverbear/getset
getters rust rust-macro setters
Last synced: 8 days ago
JSON representation
Getters and Setters for Rust.
- Host: GitHub
- URL: https://github.com/Hoverbear/getset
- Owner: jbaublitz
- License: mit
- Created: 2017-06-01T13:58:50.000Z (over 7 years ago)
- Default Branch: main
- Last Pushed: 2024-09-10T20:17:37.000Z (3 months ago)
- Last Synced: 2024-12-12T01:24:04.842Z (10 days ago)
- Topics: getters, rust, rust-macro, setters
- Language: Rust
- Homepage: https://docs.rs/getset/
- Size: 137 KB
- Stars: 342
- Watchers: 7
- Forks: 24
- Open Issues: 20
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# getset
[](https://crates.io/crates/getset)
[](https://github.com/Hoverbear/getset/blob/master/LICENSE)
[](https://docs.rs/getset/)
[](https://coveralls.io/github/Hoverbear/getset)
Getset, we're ready to go!
A procedural macro for generating the most basic getters and setters on fields.
Getters are generated as `fn field(&self) -> &type`, while setters are generated as `fn field(&mut self, val: type)`.
These macros are not intended to be used on fields which require custom logic inside of their setters and getters. Just write your own in that case!
```rust
use getset::{CopyGetters, Getters, MutGetters, Setters};
#[derive(Getters, Setters, MutGetters, CopyGetters, Default)]
pub struct Foo
where
T: Copy + Clone + Default,
{
/// Doc comments are supported!
/// Multiline, even.
#[getset(get, set, get_mut)]
private: T,
/// Doc comments are supported!
/// Multiline, even.
#[getset(get_copy = "pub", set = "pub", get_mut = "pub")]
public: T,
}
fn main() {
let mut foo = Foo::default();
foo.set_private(1);
(*foo.private_mut()) += 1;
assert_eq!(*foo.private(), 2);
}
```
You can use `cargo-expand` to generate the output. Here are the functions that the above generates (Replicate with `cargo expand --example simple`):
```rust
use getset::{Getters, MutGetters, CopyGetters, Setters};
pub struct Foo
where
T: Copy + Clone + Default,
{
/// Doc comments are supported!
/// Multiline, even.
#[getset(get, get, get_mut)]
private: T,
/// Doc comments are supported!
/// Multiline, even.
#[getset(get_copy = "pub", set = "pub", get_mut = "pub")]
public: T,
}
impl Foo
where
T: Copy + Clone + Default,
{
/// Doc comments are supported!
/// Multiline, even.
#[inline(always)]
fn private(&self) -> &T {
&self.private
}
}
impl Foo
where
T: Copy + Clone + Default,
{
/// Doc comments are supported!
/// Multiline, even.
#[inline(always)]
pub fn set_public(&mut self, val: T) -> &mut Self {
self.public = val;
self
}
}
impl Foo
where
T: Copy + Clone + Default,
{
/// Doc comments are supported!
/// Multiline, even.
#[inline(always)]
fn private_mut(&mut self) -> &mut T {
&mut self.private
}
/// Doc comments are supported!
/// Multiline, even.
#[inline(always)]
pub fn public_mut(&mut self) -> &mut T {
&mut self.public
}
}
impl Foo
where
T: Copy + Clone + Default,
{
/// Doc comments are supported!
/// Multiline, even.
#[inline(always)]
pub fn public(&self) -> T {
self.public
}
}
```
Attributes can be set on struct level for all fields in struct as well. Field level attributes take
precedence.
```rust
#[macro_use]
extern crate getset;
mod submodule {
#[derive(Getters, CopyGetters, Default)]
#[get_copy = "pub"] // By default add a pub getting for all fields.
pub struct Foo {
public: i32,
#[get_copy] // Override as private
private: i32,
}
fn demo() {
let mut foo = Foo::default();
foo.private();
}
}
fn main() {
let mut foo = submodule::Foo::default();
foo.public();
}
```
For some purposes, it's useful to have the `get_` prefix on the getters for
either legacy of compatability reasons. It is done with `with_prefix`.
```rust
#[macro_use]
extern crate getset;
#[derive(Getters, Default)]
pub struct Foo {
#[get = "pub with_prefix"]
field: bool,
}
fn main() {
let mut foo = Foo::default();
let val = foo.get_field();
}
```
Skipping setters and getters generation for a field when struct level attribute is used
is possible with `#[getset(skip)]`.
```rust
use getset::{CopyGetters, Setters};
#[derive(CopyGetters, Setters)]
#[getset(get_copy, set)]
pub struct Foo {
// If the field was not skipped, the compiler would complain about moving
// a non-copyable type in copy getter.
#[getset(skip)]
skipped: String,
field1: usize,
field2: usize,
}
impl Foo {
// It is possible to write getters and setters manually,
// possibly with a custom logic.
fn skipped(&self) -> &str {
&self.skipped
}
fn set_skipped(&mut self, val: &str) -> &mut Self {
self.skipped = val.to_string();
self
}
}
```