-
Notifications
You must be signed in to change notification settings - Fork 381
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Add init-struct pattern #388
Draft
virtualritz
wants to merge
2
commits into
rust-unofficial:main
Choose a base branch
from
virtualritz:main
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Draft
Changes from 1 commit
Commits
Show all changes
2 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change | ||||
---|---|---|---|---|---|---|
@@ -0,0 +1,66 @@ | ||||||
# Init-Struct | ||||||
|
||||||
## Description | ||||||
|
||||||
Construct an object relying on defaults for omitted fields. | ||||||
|
||||||
## Example | ||||||
|
||||||
```rust | ||||||
#[derive(Debug, Default, PartialEq)] | ||||||
pub struct Foo { | ||||||
pub foo: Some(u32) | ||||||
pub bar: String, | ||||||
// Private members. | ||||||
baz: Vec<u16> | ||||||
// A lots more fields. | ||||||
} | ||||||
|
||||||
|
||||||
#[test] | ||||||
fn inint_struct_test() { | ||||||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more.
Suggested change
|
||||||
let foo = Foo { | ||||||
bar: "Some string".to_string(), | ||||||
..Default::default | ||||||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more.
Suggested change
|
||||||
}; | ||||||
} | ||||||
``` | ||||||
|
||||||
## Motivation | ||||||
|
||||||
Useful when you have a struct with a lot of fields that have well-defined/useful defaults. | ||||||
|
||||||
## Advantages | ||||||
|
||||||
On complex/deeply nested structs only the fields that require explicit initalization have to be | ||||||
touched. | ||||||
|
||||||
Prevents proliferation of constructors. | ||||||
|
||||||
Can be used for one-liner initialisation as well as more complex construction. | ||||||
|
||||||
Avoids having to write a lot of boilerplate for the common alternative, the [Builder](builder.md) | ||||||
pattern. | ||||||
|
||||||
Can still be combined with the Builder pattern if initializtion requires transformation of some | ||||||
sort. | ||||||
|
||||||
Members can still be private as long as they implement [`Default`](https://doc.rust-lang.org/std/default/trait.Default.html). | ||||||
|
||||||
## Disadvantages | ||||||
|
||||||
Requires each field of the struct to implement `Default`. | ||||||
|
||||||
I.e. if a field is missing `Default`, `default()` has to be implemented and all fields have to be set manualy to their defaults. | ||||||
|
||||||
## Discussion | ||||||
|
||||||
This pattern is seen frequently in Rust since you can only have a single method with a given name. | ||||||
Having multiple constructors is thus less nice in Rust than it is in C++, Java, or others. | ||||||
|
||||||
The common way to solve this is the [Builder](builder.md) pattern but this often requires a lot of | ||||||
boilerplate. | ||||||
|
||||||
## See Also | ||||||
|
||||||
- [Init Struct Pattern](https://xaeroxe.github.io/init-struct-pattern/) |
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.