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.

Sign up for GitHub

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

Jump to bottom

refactor(runtime): hide internals from public-facing API, export tokio #1332

Merged
merged 8 commits into from Oct 27, 2023
Merged

refactor(runtime): hide internals from public-facing API, export tokio #1332

merged 8 commits into from Oct 27, 2023

Conversation

jonaro00
Copy link
Member

@jonaro00 jonaro00 commented Oct 21, 2023 •
edited

Description of change

finally a well isolated PR...

  • Move internals into hidden module, which hides them from the cargo doc page (docs.rs).
  • Re-export tokio, allows user code to not have tokio in Cargo.toml, unless they need it for something ofc :)

How has this been tested? (if applicable)

@jonaro00 jonaro00 marked this pull request as ready for review October 21, 2023 15:48
@jonaro00 jonaro00 changed the title WIP refactor(runtime): hide internals from public-facing API, export tokio refactor(runtime): hide internals from public-facing API, export tokio Oct 21, 2023
@oddgrd
Copy link
Contributor

oddgrd commented Oct 24, 2023 •
edited

Cool! If the user wants a different version of tokio, cargo should use the one they specify in their Cargo.toml, right (as long as it's not a major version change, but that isn't planned for tokio)?

@jonaro00
Copy link
Member Author

Yes, the min version remains what we have in our Cargo.toml (1.22), and creating or bumping the lock file will choose the latest compatible one.

chesedo
chesedo reviewed Oct 27, 2023
View reviewed changes
Copy link
Member

@chesedo chesedo left a comment

Choose a reason for hiding this comment

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

Looking good. It would w great to run a cargo check on all our examples in case we missed anything with the review.

codegen/src/shuttle_main/mod.rs Outdated Show resolved Hide resolved
services/shuttle-poise/src/lib.rs Show resolved Hide resolved
chesedo
chesedo approved these changes Oct 27, 2023
View reviewed changes
Copy link
Member

@chesedo chesedo left a comment

Choose a reason for hiding this comment

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

We can merge if the dependencies improvement is not possible 😄

codegen/src/shuttle_main/mod.rs Show resolved Hide resolved
@jonaro00 jonaro00 merged commit 06e46d1 into shuttle-hq:main Oct 27, 2023
34 checks passed
@jonaro00 jonaro00 deleted the refactor/runtime-lib-exports branch October 27, 2023 15:32
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@chesedo chesedo chesedo approved these changes

@orhun orhun orhun approved these changes

@oddgrd oddgrd oddgrd approved these changes

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

None yet
4 participants
@jonaro00 @oddgrd @chesedo @orhun