Add function to return a vector of all the handles in a queue #16
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
FelixMcFelix
added
enhancement
FelixMcFelix
requested changes
Nov 19, 2020
src/tracks/queue.rs
Outdated
| @@ -278,6 +278,13 @@ impl TrackQueue { | |||
|
|
|||
| inner.stop_current() | |||
| } | |||
|
|
|||
| /// Returns Vec of all handles in queue | |||
There was a problem hiding this comment.
Main points to mention in docs after the headline:
- Reordering the queue can't be done here, and has to go through
modify_queue. The returned Vec is a snapshot of the queue at the time of call, and might change afterwards. - Calling
stopon a handle will effectively skip that track.
Minor nits:
- can you please end doc comments with a full stop?
- Maybe something like "Returns a list of currently queued tracks." for the headline?
src/tracks/queue.rs
Outdated
| @@ -278,6 +278,13 @@ impl TrackQueue { | |||
|
|
|||
| inner.stop_current() | |||
| } | |||
|
|
|||
| /// Returns Vec of all handles in queue | |||
| pub fn to_vec(&self) -> Vec<TrackHandle> { | |||
There was a problem hiding this comment.
Suggested change
| pub fn to_vec(&self) -> Vec<TrackHandle> { | |
| pub fn current_queue(&self) -> Vec<TrackHandle> { |
This is a little more descriptive of the function's purpose here.
FelixMcFelix
approved these changes
Nov 19, 2020
FelixMcFelix
pushed a commit
to FelixMcFelix/songbird
that referenced
this pull request
Nov 30, 2020
Merged
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.
Basically, an extension to current() but returns a vector of all the handles in a queue