Change panics when parsing a malformed dmi to return a Result instead #319
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
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.
Currently parsing a malformed - but also well-formed, yet ancient - .dmi files results in a panic deep within the guts of SapacemanDMM. That's undesirable, since
.dmi's which SpacemanDMM does not understand (yet BYOND dreammaker handles fine) do exist in the wild (see ParadiseSS13/Paradise#17800 for a couple of examples).I don't think teaching SpacemanDMM of the legacy file formats is worth it, but making it return a Result instead of outright panicking definitely is (and it's much less work than the former).
This is technically a breaking change since it changes the signature of the public
dreammaker::dmi::Metadata::meta_from_str(). (But it's probably rarely used, and definitely easy to fix at the call site?..)