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

Docs & Ergonomics #19

Merged
merged 8 commits into from
Dec 21, 2024
Merged

Conversation

0xAlcibiades
Copy link
Member

@0xAlcibiades 0xAlcibiades commented Sep 13, 2024

This pull request includes several updates and improvements across multiple files, focusing on dependency updates, error handling, and enhancements to HTTP/2 settings.

Dependency Updates:

  • Updated dependencies in Cargo.toml to newer versions, including async-stream, bytes, futures, http, hyper, rustls, tokio, and others.

Error Handling:

  • Added a new function handle_accept_error in src/error.rs to manage errors during connection acceptance, categorizing them as fatal or non-fatal.
  • Refactored src/tcp.rs to use the new handle_accept_error function from src/error.rs.

HTTP/2 Enhancements:

  • Modified HTTP/2 settings in benches/hello_world_tower_hyper_tls_tcp.rs to improve performance and reliability, including changes to window sizes, frame size, and keep-alive settings.
  • Updated HTTP/2 configuration in src/http.rs to match the new settings for better throughput and connection management.

Code Documentation:

  • Added detailed documentation to src/io.rs, explaining the purpose and usage of the Transport enum and its methods.

Miscellaneous:

  • Added a comment in src/lib.rs regarding the optional use of Jemalloc as an alternative global allocator.

@0xAlcibiades 0xAlcibiades marked this pull request as draft September 13, 2024 03:11
Copy link

codecov bot commented Sep 13, 2024

Codecov Report

Attention: Patch coverage is 91.27273% with 24 lines in your changes missing coverage. Please review.

Files with missing lines Patch % Lines
src/tcp.rs 79.81% 22 Missing ⚠️
src/error.rs 92.85% 1 Missing ⚠️
src/tls.rs 99.23% 1 Missing ⚠️

📢 Thoughts on this report? Let us know!

@0xAlcibiades 0xAlcibiades changed the title WIP: Docs, Ergonomics, Tests, Benchmarks, Optimization Docs & Ergonomics Dec 20, 2024
@0xAlcibiades 0xAlcibiades marked this pull request as ready for review December 20, 2024 21:52
@0xAlcibiades 0xAlcibiades merged commit 0c7e1b0 into master Dec 21, 2024
19 checks passed
@0xAlcibiades 0xAlcibiades deleted the 0xalcibiades/war-659-ergonomic-refinement branch January 8, 2025 22:59
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant