Rename WasiState::new() to WasiState::builder()
#3471
Merged
Conversation
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
Michael-F-Bryan
force-pushed
the
rename-wasistate-new
branch
from
afcab5b to
1194139
Compare
theduke
requested changes
Jan 16, 2023
lib/wasi/src/state/mod.rs
Outdated
| @@ -264,7 +264,14 @@ impl WasiState { | |||
| /// Create a [`WasiStateBuilder`] to construct a validated instance of | |||
| /// [`WasiState`]. | |||
| #[allow(clippy::new_ret_no_self)] | |||
| #[deprecated = "Use WasiState::builder()"] | |||
There was a problem hiding this comment.
Suggested change
| #[deprecated = "Use WasiState::builder()"] | |
| #[deprecated(note = "Use WasiState::builder() instead", since = "3.2.0"] |
lib/wasi/src/state/mod.rs
Outdated
|
|
||
| /// Create a [`WasiStateBuilder`] to construct a validated instance of | ||
| /// [`WasiState`]. | ||
| pub fn builder(program_name: impl AsRef<str>) -> WasiStateBuilder { | ||
| create_wasi_state(program_name.as_ref()) |
There was a problem hiding this comment.
While you are it it, can you do: create_wasi_state() -> WasiStateBuilder::new()?
theduke
approved these changes
Jan 16, 2023
|
@theduke it looks like the CI issues are coming from the |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
The typical convention is for
Foo::new()to return an instance ofFooandFoo::builder()to return some type of builder object. OurWasiStatetype doesn't follow this convention (and explicitly#[allow]s the associated clippy warning), so the API can be confusing for anyone that hasn't used it before.I've renamed the
WasiState::new()function toWasiState::builder()and added a#[deprecated]attribute to the originalWasiState::new()so it doesn't break Deploy.