-
-
Notifications
You must be signed in to change notification settings - Fork 1.5k
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Lack of documentation on Read trait #3649
Comments
Agreed, it is lacking in documentation. That'd be helpful to improve. Regarding the It only has the minimum methods in hyper because I wanted "needs" to drive adding methods, instead of trying to guess which might be useful. |
I have come to the need of implementing
hyper::rt::Read
on a custom struct. It seems to me that its documentation has been copy-pasted from tokio'sAsyncRead
, except it's outdated since the signature has been changed. For some reason not stated in the doc, aReadBufCursor
is used instead of the originalReadBuf
. Now, I simply couldn't understand from the doc how I was supposed to implementRead
, consideringReadBufCursor
only has 2 unsafe methods and isn't too-well documented either. I would greatly appreciate further official guidance on implementing the Read trait. Thank you for making hyperThe text was updated successfully, but these errors were encountered: