libgraphviz: Id::new returns Result<Id, ()> instead of panicking on error #18921
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
|
Thanks for the pull request, and welcome! The Rust team is excited to review your changes, and you should hear from @aturon (or someone else) soon. |
|
sorry, didn't know about |
0798273 to
f4ba7ee
Compare
| @@ -351,14 +351,18 @@ impl<'a> Id<'a> { | |||
| /// defined by the DOT language. This function may change in the | |||
| /// future to accept a broader subset, or the entirety, of DOT's | |||
| /// `ID` format.) | |||
| pub fn new<Name:str::IntoMaybeOwned<'a>>(name: Name) -> Id<'a> { | |||
| pub fn new<Name:str::IntoMaybeOwned<'a>>(name: Name) -> Result<Id<'a>, ()> { | |||
There was a problem hiding this comment.
Could you update the documentation of this function to include the error cases as well? It's not totally clear when Err would be returned for example.
f4ba7ee to
6221f7e
Compare
| @@ -346,19 +346,25 @@ impl<'a> Id<'a> { | |||
| /// identifier format: it must be a non-empty string made up of | |||
| /// alphanumeric or underscore characters, not beginning with a | |||
| /// digit (i.e. the regular expression `[a-zA-Z_][a-zA-Z_0-9]*`). | |||
| /// Passing different string (i.e. containing spaces, brackets, | |||
| /// quotes, ...) will return an empty `Err` value. | |||
| /// | |||
There was a problem hiding this comment.
@alexcrichton like this or should i create an example?
6221f7e to
d0edf59
Compare
abbc1cc to
9c06cb7
Compare
…rror creating a new Id object requires the format to match a subset of `ID` format defined by the DOT language. When the format did not match, the function called assert. This was not mentioned in the docs or the spec. I made the failure explicit by returning an Result<Id, ()>.
9c06cb7 to
70bf4f7
Compare
|
the tests are now two separate tests (and they compile). |
|
Thanks @oli-obk! |
lnicola
pushed a commit
to lnicola/rust
that referenced
this pull request
Jan 20, 2025
internal: Compute inlay hint text edits lazily
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.
creating a new Id object requires the format to match a subset of
IDformat defined by the DOT language. When the format did not match, the function called assert. This was not mentioned in the docs or the spec. I made the failure explicit by returning an Result<Id, ()>.