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: Rust bindings need an explanation for Send/Sync impls #4413

Open
maddeleine opened this issue Feb 13, 2024 · 1 comment · May be fixed by #4471
Open

docs: Rust bindings need an explanation for Send/Sync impls #4413

maddeleine opened this issue Feb 13, 2024 · 1 comment · May be fixed by #4471

Comments

@maddeleine
Copy link
Contributor

Security issue notifications

If you discover a potential security issue in s2n we ask that you notify
AWS Security via our vulnerability reporting page. Please do not create a public github issue.

Problem:

Some of our Rust bindings structs impl Send or Sync, which is kind of unusual to do manually in Rust. It's not immediately clear why these structs need these marker traits, and it would be really nice to have an explanation for why we needed to implement those traits.

Solution:

Write some documentation explaining more in detail about why the Connection struct implements Send but not Sync. Also why the Config struct implements Send and Sync.

@lrstewart
Copy link
Contributor

Also include comments about why we're NOT implementing Send or Sync

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants