Skip to content
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

chore(core): Align Reader and Writer's API design #4498

Merged
merged 3 commits into from
Apr 16, 2024
Merged

Conversation

Xuanwo
Copy link
Member

@Xuanwo Xuanwo commented Apr 16, 2024

Align the Reader and Writer's API design as mentioned in #4465

  • From into_futures_io_async_read to into_futures_async_read.
  • From into_futures_io_async_write to into_futures_async_write.
  • From into_std_io_read to into_std_read.

The context is clear that we don't need to re-mention io in our API.

  • From into_futures_bytes_stream to into_bytes_stream
  • From into_std_bytes_iterator to into_bytes_iterator

There is only one widely used stream API so far. Remove futures to make API more clear.

Signed-off-by: Xuanwo <github@xuanwo.io>
Signed-off-by: Xuanwo <github@xuanwo.io>
Signed-off-by: Xuanwo <github@xuanwo.io>
@Xuanwo Xuanwo requested a review from tisonkun April 16, 2024 10:25
@Xuanwo Xuanwo merged commit 655a487 into main Apr 16, 2024
251 checks passed
@Xuanwo Xuanwo deleted the polish-read-naming branch April 16, 2024 10:28
@tisonkun tisonkun mentioned this pull request Apr 16, 2024
6 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants