Skip to content
New issue

Have a question about this project? # for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “#”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? # to your account

Updating poll functions to return results #147

Open
wants to merge 1 commit into
base: master
Choose a base branch
from

Conversation

ryan-summers
Copy link
Member

This PR updates the traits to allow poll() to return Result<> types if needed. I'm unsure if the UsbClass::poll() function should return a Result or not currently.

@sourcebox
Copy link
Contributor

I think this PR makes sense because currently there's no way to return an error from the driver. Using PollResult::None in such situations is ambiguous.

Copy link
Contributor

@ianrrees ianrrees left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I like this change, in particular because it encourages users to think about how to handle the return value of poll() - in most of the examples I've seen it is just ignored.

@@ -228,15 +228,17 @@ impl<B: UsbBus> UsbDevice<'_, B> {

match req {
Some(req) if req.direction == UsbDirection::In => {
if let Err(_err) = self.control_in(classes, req) {
if let Err(err) = self.control_in(classes, req) {
// TODO: Propagate error out of `poll()`
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This comment should go away with the PR, the same appears in a couple more places below.

@@ -317,10 +319,10 @@ impl<B: UsbBus> UsbDevice<'_, B> {
}

for cls in classes.iter_mut() {
cls.poll();
Copy link
Contributor

@ianrrees ianrrees Mar 5, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This introduces a subtle change in behaviour that maybe should be documented: if there are multiple classes and an earlier one errors out, the later classes won't be polled.

However, looking at the current implementation and docstring, it's not explicit that polling the device (sometimes... unclear if that's correct per #32) results in the classes being polled.

# for free to join this conversation on GitHub. Already have an account? # to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants