Use SDL_GetError for sdl2::ttf::init instead of the last OS error
#1348
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
sprocklem
force-pushed
the
fix-ttf-init-error
branch
from
817121e
to
fc5fce8
Compare
sprocklem
changed the title
sprocklem
changed the title
SDL_GetError for sdl2::ttf::init instead of the last OS error
sprocklem
force-pushed
the
fix-ttf-init-error
branch
from
fc5fce8
to
74f17f1
Compare
Previously, the code use the last OS error. However, not all errors returned by `TTF_Init` are OS errors, and the expected behaviour is that the caller instead use `SDL_GetError` when an error is encountered. To limit breakage for existing application the error is still returned as an `io::Error`, albeit one with `io::ErrorKind::Other`. It is worth noting that this does lead to an observable difference in behaviour for callers – the error has a different kind – although any code that is inspecting this was already relying on an unreliable source of data. This fixes issue Rust-SDL2#1347.
sprocklem
force-pushed
the
fix-ttf-init-error
branch
from
74f17f1
to
dd3721b
Compare
I think it's better to break the API here and return the correct type instead (and put in in the changelog as breaking change). That will allow users that actually use it to change their code accordingly, rather than just breaking silently if they did use this before. |
antonilol
added a commit
to antonilol/rust-sdl2
that referenced
this pull request
Oct 8, 2024
various other changes: - allow multiple `ttf::init` calls, the same way it works with TTF_Init - return last sdl error instead of I/O error (like stale pr Rust-SDL2#1348, fixes Rust-SDL2#1347 and closes Rust-SDL2#1348) - implement `Clone` for `Sdl2TtfContext`, SDL C code will do the reference counting - make `ttf::font::internal_*` `pub(super)` - make `ttf::font::Font::raw` safe (obtaining a raw pointer is safe, using it is unsafe)
antonilol
added a commit
to antonilol/rust-sdl2
that referenced
this pull request
Oct 8, 2024
and various other changes, including: - allow multiple `ttf::init` calls, the same way it works with TTF_Init - return last sdl error instead of I/O error (like stale pr Rust-SDL2#1348, fixes Rust-SDL2#1347 and closes Rust-SDL2#1348) - implement `Clone` for `Sdl2TtfContext`, SDL C code will do the reference counting - make `ttf::font::internal_*` `pub(super)` - make `ttf::font::Font::raw` safe (obtaining a raw pointer is safe, using it is unsafe)
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.
Previously, the code use the last OS error. However, not all errors returned by
TTF_Initare OS errors, and the expected behaviour is that the caller instead useSDL_GetErrorwhen an error is encountered.To limit breakage for existing callers the error is still returned as an
io::Error, albeit one withio::ErrorKind::Other. It is worth noting that this does lead to an observable difference in behaviour for callers – the error has a different kind – although any code that is inspecting this was already relying on an unreliable source of data.This fixes issue #1347.