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

Hide external buffer types used by primitive::Encoder in aws-smithy-types #1209

Merged
merged 7 commits into from
Feb 22, 2022

Conversation

jdisanti
Copy link
Collaborator

@jdisanti jdisanti commented Feb 19, 2022

Motivation and Context

The buffer types are an implementation detail for the primitive encoding, and should not be tied to the public API. This PR wraps them in some lightweight structs to hide them.

Testing

  • Added api-linter to CI for the aws-smithy-types crate now that it reveals no external types in its API

Checklist

  • I have updated CHANGELOG.next.toml if I made changes to the smithy-rs codegen or runtime crates

By submitting this pull request, I confirm that you can use, modify, copy, and redistribute this contribution, under the terms of your choice.

@github-actions
Copy link

A new doc preview is ready to view.

@github-actions
Copy link

A new generated diff is ready to view.

@github-actions
Copy link

A new doc preview is ready to view.

@github-actions
Copy link

A new generated diff is ready to view.

Copy link
Collaborator

@rcoh rcoh left a comment

Choose a reason for hiding this comment

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

lgtm, lmk what you think about just making it a private tuple struct though

@github-actions
Copy link

A new generated diff is ready to view.

@github-actions
Copy link

A new doc preview is ready to view.

@jdisanti jdisanti enabled auto-merge (squash) February 22, 2022 19:49
@jdisanti jdisanti merged commit 375e0b2 into main Feb 22, 2022
@jdisanti jdisanti deleted the jdisanti-hide-external-types-1 branch February 22, 2022 20:05
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.

2 participants