Add env chapter to book #788
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
fishrockz
reviewed
Mar 31, 2020
luleyleo
approved these changes
Apr 1, 2020
Comment on lines
+34
to
+50
| 1. **`Key`s should be `const`s with unique names.** If you need to use a custom | ||
| key, you should declare it as a `const`, and give it a unique name. By | ||
| convention, you should namespace your keys using something like [reverse-DNS] | ||
| notation, or even just prefixing them with the name of your app. | ||
|
|
||
| ```rust,noplaypen | ||
| const BAD_NAME: Key<f64> = Key::new("height"); | ||
| const GOOD_NAME: Key<f64> = Key::new("com.example.my-app.main-view-height"); | ||
| ``` | ||
| 1. **`Key`s must always be set before they are used.** In practice this means | ||
| that most keys are set when your application launches, using | ||
| [`AppLauncher::configure_env`]. Once a key has been added to the `Env`, it | ||
| cannot be deleted, although it can be overwritten. | ||
|
|
||
| 1. **Values can only be overwritten by values of the same type.** If you have a | ||
| `Key<f64>`, assuming that key has already been added to the `Env`, you cannot | ||
| replace it with any other type. |
There was a problem hiding this comment.
I think it would be nice to add (at least the bold parts) of this list directly to the Env docs as well
Comment on lines
+87
to
+98
| [`Env`]: https://docs.rs/druid/0.4.0/druid/struct.Env.html | ||
| [`Key`]: https://docs.rs/druid/0.4.0/druid/struct.Key.html | ||
| [`Value`]: https://docs.rs/druid/0.4.0/druid/struct.Value.html | ||
| [`LocalizedString`]: https://docs.rs/druid/0.4.0/druid/struct.LocalizedString.html | ||
| [`resolve`]: https://docs.rs/druid/0.4.0/druid/struct.LocalizedString.html#method.resolve | ||
| [localization]: ./localization.md | ||
| [reverse-DNS]: https://en.wikipedia.org/wiki/Reverse_domain_name_notation | ||
| [`AppLauncher::configure_env`]: https://docs.rs/druid/0.4.0/druid/struct.AppLauncher.html#method.configure_env | ||
| [`KeyOrValue`]: https://docs.rs/druid/0.4.0/druid/enum.KeyOrValue.html | ||
| [`EnvScope`]: https://docs.rs/druid/0.4.0/druid/widget/struct.EnvScope.html | ||
| [`WidgetExt`]: https://docs.rs/druid/0.4.0/druid/trait.WidgetExt.html | ||
| [`env_scope`]: https://docs.rs/druid/0.4.0/druid/trait.WidgetExt.html#method.env_scope |
There was a problem hiding this comment.
Quite a few of those are dead ends (KeyOrValue for example), I suppose they did not yet exist in druid 0.4.0 and you added them as a reminder?
There was a problem hiding this comment.
They will probably work with 0.5.0. I confirmed KeyOrValue working.
There was a problem hiding this comment.
yea, I want to keep this at 0.4.0 and then I'll bump to 0.5.0 all at once.
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.
No description provided.