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

document all remaining unsafe usages #1642

Merged
merged 3 commits into from Sep 3, 2020
Merged

document all remaining unsafe usages #1642

merged 3 commits into from Sep 3, 2020

Conversation

robjtede
Copy link
Member

@robjtede robjtede commented Aug 22, 2020

PR Type

Safety / Docs

PR Checklist

Check your PR fulfills the following:

  • Documentation comments have been added / updated.
  • Format code with the latest stable rustfmt

Overview

Rounds off our safety drive for v3 by documenting all remaining non-trivial usages of unsafe blocks and functions. Trivial cases include standard prepare_uninitialized_buffer methods and were not considered. One or two debug assertion were added.

adds some debug assertions where appropriate
@robjtede robjtede marked this pull request as ready for review August 22, 2020 02:01
@robjtede robjtede requested review from a team August 22, 2020 02:01
@robjtede robjtede added the C-docs Category: docs label Aug 22, 2020
@cdbattags
Copy link
Member

@robjtede this is amazing work, sir

@robjtede robjtede mentioned this pull request Aug 22, 2020
15 tasks
@codecov-commenter
Copy link

codecov-commenter commented Aug 22, 2020

Codecov Report

Merging #1642 into master will increase coverage by 0.00%.
The diff coverage is 60.00%.

Impacted file tree graph

@@           Coverage Diff           @@
##           master    #1642   +/-   ##
=======================================
  Coverage   53.17%   53.18%           
=======================================
  Files         126      126           
  Lines       11836    11836           
=======================================
+ Hits         6294     6295    +1     
+ Misses       5542     5541    -1     
Impacted Files Coverage Δ
actix-http/src/config.rs 58.71% <ø> (ø)
actix-http/src/h1/decoder.rs 61.85% <ø> (ø)
actix-http/src/h1/dispatcher.rs 55.64% <ø> (ø)
actix-http/src/h2/dispatcher.rs 0.00% <0.00%> (ø)
actix-http/src/macros.rs 0.00% <ø> (ø)
actix-http/src/ws/mask.rs 0.00% <ø> (ø)
actix-http/src/h1/encoder.rs 63.30% <85.71%> (+0.65%) ⬆️

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 4e32159...c873bfa. Read the comment docs.

Copy link
Member

@Neopallium Neopallium left a comment

Choose a reason for hiding this comment

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

Looks good.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
C-docs Category: docs
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

4 participants