Skip to content

Document quinn feature flags#2426

Open
paulcdejean wants to merge 3 commits into
quinn-rs:mainfrom
paulcdejean:issue-2425
Open

Document quinn feature flags#2426
paulcdejean wants to merge 3 commits into
quinn-rs:mainfrom
paulcdejean:issue-2425

Conversation

@paulcdejean

Copy link
Copy Markdown

No description provided.

@paulcdejean paulcdejean marked this pull request as draft October 25, 2025 20:19
@paulcdejean

Copy link
Copy Markdown
Author

Fixes #2425

@paulcdejean

Copy link
Copy Markdown
Author

There's currently TODOs all over the place here. I did try and dig through the code and see what the feature flags were actually doing but I'm not going to have the same depth of understanding as a maintainer.

Happy to update this based on feedback, however I'm not going to be able to complete the existing TODOs on my own without feedback or assistance.

@djc djc left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Thanks for getting this started!

Comment thread quinn/src/lib.rs Outdated
Comment thread quinn/src/lib.rs Outdated
Comment thread quinn/src/lib.rs Outdated
Comment thread quinn/src/lib.rs Outdated
Comment thread quinn/src/lib.rs Outdated
Comment thread quinn/src/lib.rs Outdated
Comment thread quinn/src/lib.rs Outdated
Comment thread quinn/src/lib.rs Outdated
Comment thread quinn/src/lib.rs Outdated

@mxinden mxinden left a comment

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

Comment thread quinn/src/lib.rs Outdated
@paulcdejean paulcdejean marked this pull request as ready for review October 29, 2025 02:16
@paulcdejean

Copy link
Copy Markdown
Author

Ready for re review! Thanks for all the helpful feedback.

@djc djc left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

A few more nits. I'll make another pass after this is merged.

Please make sure to squash all of your commits and fix the CI issues.

Comment thread quinn/src/lib.rs Outdated
Comment thread quinn/src/lib.rs Outdated
Comment thread quinn/src/lib.rs Outdated
@cathaysia

Copy link
Copy Markdown

Do you know this crate: https://docs.rs/document-features/latest/document_features/

it's very useful for this case.

@djc

djc commented Oct 30, 2025

Copy link
Copy Markdown
Member

(If you rebase on main, the WASM failure in CI should go away.)

@paulcdejean

Copy link
Copy Markdown
Author

I rebased. Should I also squash? Or will do you the squashing?

@paulcdejean

Copy link
Copy Markdown
Author

I saw you said to squash so I squashed.

Comment thread quinn/src/lib.rs Outdated
Comment thread quinn/src/lib.rs
//!
//! - `runtime-tokio`: Enable integration with the tokio async runtime.
//! - `runtime-smol`: Enable integration with the smol runtime.
//! - `smol`: Also enable integration with the smol runtime.

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

What's the difference between runtime-smol and smol? Should be explained here.

Copy link
Copy Markdown
Author

Choose a reason for hiding this comment

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

I have no idea. @djc do you have any idea? Looking at the code I'm not sure how to better document this.

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Comment thread quinn/src/lib.rs Outdated
@paulcdejean

Copy link
Copy Markdown
Author

@Frando I reworked the crypto section based on your feedback and based on digging into the code more.

@paulcdejean

Copy link
Copy Markdown
Author

This PR is currently soft blocked by #2443

@gretchenfrage

Copy link
Copy Markdown
Collaborator

@paulcdejean #2443 is merged JSYK. Interested in rebasing and squashing?

@paulcdejean

Copy link
Copy Markdown
Author

Thanks for letting me know. My life has been kinda hectic as of late, but definitely will take a pass at this again next time I sit down for programming time.

@paulcdejean

Copy link
Copy Markdown
Author

@djc @gretchenfrage can someone else take this? I haven't been active in the rust or quic spaces recently. Feel free to copy and paste my changes or similar if that would be helpful.

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.

6 participants