refactor: use id::new_checked #1403
Closed
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
Add a const method to IDs named `new_checked` that takes a value and
creates a non-zero ID, panicking if the value is 0. This is useful when
you have a hardcoded value, such as in tests or in const contexts.
Code such as:
```
let guild_id = GuildId::new(1).expect("non zero id");
```
can now become:
```
let guild_id = GuildId::new_checked(1);
// or
const GUILD_ID: GuildId = GuildId::new_checked(1);
```
Signed-off-by: Zeyla Hellyer <[email protected]>
Signed-off-by: Zeyla Hellyer <[email protected]>
Use the new `twilight_model::id::Id::new_checked` method over the
`Id::new` method, which creates a new ID from a value or otherwise
panics. This is equivalent behavior to nearly all uses of `Id::new` in
our codebase, and is primarily for tests.
To accomplish this two regexes were used with some manual cleaning up of
others not included due to formatting not being taken into account (i.e.
between the `Id::new` call and the `Option::expect` call).
Regex 1 input: `Id::new\(([0-9_]*)\).expect\((.+?)\)`
Regex 1 substitution: `Id::new_checked($1)`
Example:
```diff
-Some(test::user(Id::new(1).expect("non zero")))
+Some(test::user(Id::new_checked(1)))
```
Regex 2 input: `Id(::<(.+?)Marker>)?::new\(([0-9_]*)\).expect\((.+?)\)`
Regex 2 substitution: `Id::<$1Marker>::new_checked($1)`
Example:
```diff
-Id::<ChannelMarker>::new(123).expect("non zero")
+Id::<ChannelMarker>::new_checked(123)
```
Signed-off-by: Zeyla Hellyer <[email protected]>
zeylahellyer
added
c-all
Signed-off-by: Zeyla Hellyer <[email protected]>
|
Closing in favor of only having #1402. |
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.
Depends on #1402.
Use the new
twilight_model::id::Id::new_checkedmethod over theId::newmethod, which creates a new ID from a value or otherwise panics. This is equivalent behavior to nearly all uses ofId::newin our codebase, and is primarily for tests.To accomplish this two regexes were used with some manual cleaning up of others not included due to formatting not being taken into account (i.e. between the
Id::newcall and theOption::expectcall).Regex 1 input:
Id::new\(([0-9_]*)\).expect\((.+?)\)Regex 1 substitution:
Id::new_checked($1)Example:
Regex 2 input:
Id(::<(.+?)Marker>)?::new\(([0-9_]*)\).expect\((.+?)\)Regex 2 substitution:
Id::<$1Marker>::new_checked($1)Example: