Return Result from AudioQueue::queue instead of bool
#1189
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
|
Looks good, but please don't change the signature without prior warning. Add the function with Result as "queue_audio" or something like that, and deprecate |
|
Sure. I'll update my patch. |
rhysd
force-pushed
the
queue-return-result
branch
from
5d4a7c0 to
5d8ba4a
Compare
rhysd
commented
Dec 30, 2021
| @@ -750,6 +750,10 @@ impl<'a, Channel: AudioFormatNum> AudioQueue<Channel> { | |||
|
|
|||
| /// Adds data to the audio queue. | |||
| #[doc(alias = "SDL_QueueAudio")] | |||
| #[deprecated( | |||
| since = "0.36.0", | |||
There was a problem hiding this comment.
I'm not sure what the next version is. If 0.35.2 is better, please let me know.
|
Thanks! |
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.
Hi, thank you for developing the nice binding library. I enjoyed trying some SDL2 features with this library.
I noticed that
AudioQueue::queueis not so idiomatic Rust API. It returns if it succeeded asbool. This PR replaces the return value with more idiomaticResulttype. I believeResultis better becauseaudio-queue-squarewaveexample missed the error handling.sdl::get_error. This is not idiomatic error handling and the error message may be overwritten by other errors.I'm not sure that this change is appropriate because I'm new to both rust-sdl2 and SDL2. Please feel free to reject this PR if it's not appropriate.