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

Fix a typo #1812

Merged
merged 1 commit into from
Feb 27, 2024
Merged

Fix a typo #1812

merged 1 commit into from
Feb 27, 2024

Conversation

haroldbruintjes
Copy link
Contributor

Hi, I found a trivial typo so here is a suggested fix :).

Fixes a missing backtick in the documentation for MessageEncrypter::encrypt
Copy link
Member

@cpu cpu left a comment

Choose a reason for hiding this comment

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

Thanks!

@cpu cpu enabled auto-merge February 27, 2024 16:04
Copy link

rustls-benchmarking bot commented Feb 27, 2024

Benchmark results

Instruction counts

Significant differences

There are no significant instruction count differences

Other differences

Click to expand
Scenario Baseline Candidate Diff Threshold
handshake_tickets_aws_lc_rs_1.2_rsa_aes_server 4524619 4549892 25273 (0.56%) 2.64%
handshake_no_resume_aws_lc_rs_1.3_rsa_chacha_server 12702920 12658225 -44695 (-0.35%) 0.98%
handshake_tickets_aws_lc_rs_1.2_rsa_aes_client 4522936 4510656 -12280 (-0.27%) 1.03%
handshake_session_id_ring_1.2_rsa_aes_server 4330555 4323423 -7132 (-0.16%) 0.57%
handshake_no_resume_aws_lc_rs_1.2_rsa_aes_server 12283779 12264429 -19350 (-0.16%) 1.27%
handshake_tickets_aws_lc_rs_1.3_rsa_chacha_server 32594556 32645708 51152 (0.16%) 0.88%
transfer_no_resume_aws_lc_rs_1.2_rsa_aes_server 46200616 46265543 64927 (0.14%) 0.33%
handshake_session_id_aws_lc_rs_1.2_rsa_aes_client 4180913 4186334 5421 (0.13%) 1.00%
handshake_no_resume_aws_lc_rs_1.3_rsa_aes_server 12664504 12648822 -15682 (-0.12%) 0.93%
handshake_session_id_aws_lc_rs_1.3_ecdsap384_chacha_client 30214611 30251652 37041 (0.12%) 0.48%
transfer_no_resume_aws_lc_rs_1.3_rsa_aes_server 46300867 46249188 -51679 (-0.11%) 0.33%
handshake_tickets_ring_1.2_rsa_aes_client 4707997 4703555 -4442 (-0.09%) 0.84%
handshake_tickets_ring_1.3_ecdsap384_aes_server 43751688 43715743 -35945 (-0.08%) 0.24%
handshake_no_resume_ring_1.3_ecdsap256_chacha_server 2126431 2128028 1597 (0.08%) 0.38%
handshake_no_resume_ring_1.3_ecdsap256_chacha_client 3897037 3894389 -2648 (-0.07%) 0.35%
handshake_tickets_aws_lc_rs_1.3_rsa_aes_server 32646050 32667888 21838 (0.07%) 0.61%
handshake_session_id_ring_1.2_rsa_aes_client 4441665 4444584 2919 (0.07%) 0.85%
handshake_no_resume_ring_1.3_ecdsap256_aes_client 3895599 3893227 -2372 (-0.06%) 0.20%
handshake_no_resume_aws_lc_rs_1.3_ecdsap256_chacha_server 1881857 1880954 -903 (-0.05%) 0.20%
handshake_session_id_ring_1.3_ecdsap256_aes_client 41987595 42006075 18480 (0.04%) 0.20%
transfer_no_resume_aws_lc_rs_1.3_ecdsap384_aes_server 46265748 46245869 -19879 (-0.04%) 0.20%
handshake_tickets_ring_1.3_ecdsap256_chacha_server 43656342 43674227 17885 (0.04%) 0.20%
handshake_session_id_ring_1.3_ecdsap384_aes_server 43544776 43562125 17349 (0.04%) 0.20%
handshake_tickets_aws_lc_rs_1.3_rsa_chacha_client 30618182 30630087 11905 (0.04%) 0.28%
transfer_no_resume_aws_lc_rs_1.3_ecdsap384_chacha_client 92429033 92393616 -35417 (-0.04%) 0.20%
handshake_session_id_aws_lc_rs_1.3_ecdsap384_aes_server 32421515 32433591 12076 (0.04%) 0.26%
handshake_session_id_ring_1.3_ecdsap384_chacha_server 43440276 43424470 -15806 (-0.04%) 0.20%
handshake_session_id_ring_1.3_rsa_chacha_client 42123210 42108669 -14541 (-0.03%) 0.20%
handshake_tickets_aws_lc_rs_1.3_ecdsap384_aes_server 32621014 32610034 -10980 (-0.03%) 0.27%
handshake_tickets_aws_lc_rs_1.3_ecdsap384_chacha_client 30419987 30410128 -9859 (-0.03%) 0.39%
handshake_tickets_aws_lc_rs_1.3_ecdsap256_chacha_server 32598753 32588838 -9915 (-0.03%) 0.29%
handshake_session_id_aws_lc_rs_1.3_ecdsap256_chacha_server 32400121 32390585 -9536 (-0.03%) 0.29%
handshake_session_id_aws_lc_rs_1.3_rsa_chacha_server 32471834 32462432 -9402 (-0.03%) 0.46%
handshake_session_id_ring_1.3_rsa_aes_server 43536192 43548460 12268 (0.03%) 0.20%
handshake_session_id_aws_lc_rs_1.2_rsa_aes_server 4054911 4053780 -1131 (-0.03%) 3.58%
handshake_tickets_aws_lc_rs_1.3_ecdsap256_chacha_client 30399304 30391252 -8052 (-0.03%) 0.37%
handshake_session_id_aws_lc_rs_1.3_ecdsap384_aes_client 30251139 30259147 8008 (0.03%) 0.51%
handshake_tickets_ring_1.3_rsa_aes_server 43793747 43782176 -11571 (-0.03%) 0.20%
handshake_tickets_aws_lc_rs_1.3_ecdsap384_chacha_server 32588765 32597290 8525 (0.03%) 0.41%
handshake_tickets_aws_lc_rs_1.3_ecdsap256_aes_server 32607890 32599613 -8277 (-0.03%) 0.41%
handshake_session_id_aws_lc_rs_1.3_ecdsap256_aes_server 32429229 32437011 7782 (0.02%) 0.20%
handshake_no_resume_aws_lc_rs_1.3_ecdsap384_aes_client 8660217 8658153 -2064 (-0.02%) 0.99%
handshake_session_id_ring_1.3_ecdsap256_chacha_server 43444477 43434238 -10239 (-0.02%) 0.20%
handshake_session_id_aws_lc_rs_1.3_ecdsap384_chacha_server 32419893 32412310 -7583 (-0.02%) 0.30%
handshake_tickets_ring_1.3_rsa_chacha_client 42323183 42332501 9318 (0.02%) 0.20%
handshake_no_resume_aws_lc_rs_1.3_rsa_chacha_client 3365772 3365042 -730 (-0.02%) 0.20%
transfer_no_resume_aws_lc_rs_1.3_rsa_chacha_server 80434495 80451739 17244 (0.02%) 0.20%
handshake_session_id_ring_1.3_rsa_chacha_server 43433254 43442560 9306 (0.02%) 0.20%
handshake_session_id_ring_1.3_ecdsap256_aes_server 43542131 43532922 -9209 (-0.02%) 0.20%
handshake_no_resume_aws_lc_rs_1.3_ecdsap384_chacha_server 4261822 4260984 -838 (-0.02%) 0.20%
handshake_session_id_ring_1.3_ecdsap384_chacha_client 41933423 41925757 -7666 (-0.02%) 0.20%
handshake_session_id_aws_lc_rs_1.3_ecdsap256_chacha_client 30216509 30211120 -5389 (-0.02%) 0.26%
handshake_session_id_aws_lc_rs_1.3_rsa_aes_server 32448634 32443196 -5438 (-0.02%) 0.52%
handshake_no_resume_ring_1.2_rsa_aes_client 4440595 4439949 -646 (-0.01%) 0.20%
handshake_no_resume_aws_lc_rs_1.2_rsa_aes_client 3151623 3151170 -453 (-0.01%) 0.20%
transfer_no_resume_ring_1.2_rsa_aes_server 46176209 46169879 -6330 (-0.01%) 0.20%
handshake_session_id_ring_1.3_ecdsap256_chacha_client 41923223 41928702 5479 (0.01%) 0.20%
handshake_no_resume_ring_1.3_rsa_chacha_client 4547338 4546749 -589 (-0.01%) 0.20%
transfer_no_resume_ring_1.3_rsa_chacha_server 80353329 80343267 -10062 (-0.01%) 0.20%
handshake_tickets_ring_1.3_ecdsap256_aes_client 42172006 42177065 5059 (0.01%) 0.20%
handshake_no_resume_ring_1.3_ecdsap256_aes_server 2124422 2124171 -251 (-0.01%) 0.32%
handshake_tickets_aws_lc_rs_1.3_ecdsap256_aes_client 30419455 30415911 -3544 (-0.01%) 0.36%
handshake_session_id_aws_lc_rs_1.3_rsa_aes_client 30447468 30444033 -3435 (-0.01%) 0.27%
handshake_tickets_ring_1.2_rsa_aes_server 4767330 4767829 499 (0.01%) 0.61%
transfer_no_resume_aws_lc_rs_1.3_ecdsap384_chacha_server 80444891 80436508 -8383 (-0.01%) 0.20%
handshake_session_id_aws_lc_rs_1.3_rsa_chacha_client 30421451 30424556 3105 (0.01%) 0.22%
handshake_session_id_ring_1.3_ecdsap384_aes_client 42010885 42006894 -3991 (-0.01%) 0.20%
handshake_no_resume_ring_1.3_rsa_aes_client 4537986 4537557 -429 (-0.01%) 0.20%
handshake_no_resume_aws_lc_rs_1.3_ecdsap256_aes_server 1878092 1877931 -161 (-0.01%) 0.22%
handshake_tickets_ring_1.3_ecdsap384_chacha_client 42099045 42102237 3192 (0.01%) 0.20%
handshake_no_resume_aws_lc_rs_1.3_ecdsap384_aes_server 4256892 4256575 -317 (-0.01%) 0.20%
handshake_no_resume_aws_lc_rs_1.3_ecdsap384_chacha_client 8667646 8667049 -597 (-0.01%) 0.91%
handshake_no_resume_aws_lc_rs_1.3_rsa_aes_client 3355002 3354778 -224 (-0.01%) 0.20%
handshake_no_resume_ring_1.3_ecdsap384_aes_server 13734943 13734040 -903 (-0.01%) 0.20%
handshake_tickets_ring_1.3_ecdsap256_chacha_client 42107414 42110111 2697 (0.01%) 0.20%
handshake_session_id_ring_1.3_rsa_aes_client 42209327 42212018 2691 (0.01%) 0.20%
transfer_no_resume_aws_lc_rs_1.3_ecdsap384_aes_client 57967804 57964294 -3510 (-0.01%) 0.22%
handshake_tickets_ring_1.3_rsa_aes_client 42379687 42382213 2526 (0.01%) 0.20%
handshake_tickets_ring_1.3_ecdsap384_aes_client 42164809 42167318 2509 (0.01%) 0.20%
transfer_no_resume_ring_1.3_ecdsap256_chacha_server 80357678 80353481 -4197 (-0.01%) 0.20%
handshake_tickets_ring_1.3_ecdsap256_aes_server 43766922 43769137 2215 (0.01%) 0.33%
transfer_no_resume_ring_1.3_ecdsap256_aes_server 46295823 46293551 -2272 (-0.00%) 0.26%
handshake_tickets_aws_lc_rs_1.3_ecdsap384_aes_client 30429047 30430481 1434 (0.00%) 0.54%
transfer_no_resume_aws_lc_rs_1.3_ecdsap256_chacha_client 92434702 92430416 -4286 (-0.00%) 0.20%
transfer_no_resume_aws_lc_rs_1.3_ecdsap256_aes_client 57966071 57963642 -2429 (-0.00%) 0.20%
transfer_no_resume_ring_1.3_ecdsap384_chacha_client 92397102 92393237 -3865 (-0.00%) 0.20%
transfer_no_resume_ring_1.3_ecdsap384_chacha_server 80355529 80352177 -3352 (-0.00%) 0.20%
handshake_tickets_ring_1.3_rsa_chacha_server 43714449 43716238 1789 (0.00%) 0.20%
handshake_tickets_ring_1.3_ecdsap384_chacha_server 43673327 43675024 1697 (0.00%) 0.21%
handshake_no_resume_ring_1.3_rsa_aes_server 12237314 12236850 -464 (-0.00%) 0.20%
handshake_no_resume_aws_lc_rs_1.3_ecdsap256_chacha_client 3344221 3344099 -122 (-0.00%) 0.23%
handshake_no_resume_ring_1.3_ecdsap384_chacha_server 13737459 13736970 -489 (-0.00%) 0.20%
handshake_no_resume_ring_1.2_rsa_aes_server 12042536 12042174 -362 (-0.00%) 0.20%
handshake_no_resume_ring_1.3_rsa_chacha_server 12246636 12246320 -316 (-0.00%) 0.20%
transfer_no_resume_ring_1.3_ecdsap384_aes_server 46301941 46303128 1187 (0.00%) 0.20%
handshake_no_resume_aws_lc_rs_1.3_ecdsap256_aes_client 3340272 3340355 83 (0.00%) 0.20%
handshake_no_resume_ring_1.3_ecdsap384_aes_client 35452675 35451911 -764 (-0.00%) 0.20%
handshake_session_id_aws_lc_rs_1.3_ecdsap256_aes_client 30267933 30267314 -619 (-0.00%) 0.45%
transfer_no_resume_aws_lc_rs_1.3_ecdsap256_aes_server 46265823 46264965 -858 (-0.00%) 0.27%
handshake_no_resume_ring_1.3_ecdsap384_chacha_client 35454958 35454350 -608 (-0.00%) 0.20%
transfer_no_resume_ring_1.3_rsa_aes_server 46290165 46290798 633 (0.00%) 0.20%
transfer_no_resume_ring_1.3_ecdsap384_aes_client 58064035 58064791 756 (0.00%) 0.20%
transfer_no_resume_ring_1.2_rsa_aes_client 57920133 57920448 315 (0.00%) 0.20%
transfer_no_resume_ring_1.3_rsa_aes_client 58064756 58064476 -280 (-0.00%) 0.20%
transfer_no_resume_ring_1.3_ecdsap256_aes_client 58066458 58066711 253 (0.00%) 0.20%
handshake_tickets_aws_lc_rs_1.3_rsa_aes_client 30636678 30636590 -88 (-0.00%) 0.31%
transfer_no_resume_aws_lc_rs_1.3_rsa_aes_client 57985970 57986088 118 (0.00%) 0.20%
transfer_no_resume_ring_1.3_ecdsap256_chacha_client 92399591 92399472 -119 (-0.00%) 0.20%
transfer_no_resume_aws_lc_rs_1.2_rsa_aes_client 68386150 68386075 -75 (-0.00%) 0.20%
transfer_no_resume_ring_1.3_rsa_chacha_client 92398475 92398569 94 (0.00%) 0.20%
transfer_no_resume_aws_lc_rs_1.3_ecdsap256_chacha_server 80455944 80456017 73 (0.00%) 0.20%
transfer_no_resume_aws_lc_rs_1.3_rsa_chacha_client 92455575 92455520 -55 (-0.00%) 0.20%

Wall-time

Significant differences

There are no significant wall-time differences

Other differences

Click to expand
Scenario Baseline Candidate Diff Threshold
transfer_no_resume_ring_1.2_rsa_aes 7.15 ms 7.20 ms 0.05 ms (0.70%) 2.94%
handshake_no_resume_aws_lc_rs_1.3_ecdsap256_chacha 479.17 µs 482.27 µs 3.10 µs (0.65%) 2.96%
transfer_no_resume_aws_lc_rs_1.2_rsa_aes 5.78 ms 5.81 ms 0.03 ms (0.58%) 3.44%
handshake_session_id_ring_1.2_rsa_aes 1.75 ms 1.76 ms 0.01 ms (0.58%) 2.70%
handshake_no_resume_ring_1.3_ecdsap256_aes 509.29 µs 511.68 µs 2.39 µs (0.47%) 2.39%
handshake_no_resume_aws_lc_rs_1.3_ecdsap256_aes 479.83 µs 482.04 µs 2.21 µs (0.46%) 2.52%
handshake_no_resume_ring_1.3_ecdsap256_chacha 507.88 µs 510.20 µs 2.32 µs (0.46%) 2.34%
transfer_no_resume_ring_1.3_ecdsap384_aes 9.77 ms 9.81 ms 0.04 ms (0.44%) 2.61%
handshake_no_resume_ring_1.3_rsa_aes 1.08 ms 1.09 ms 0.00 ms (0.41%) 1.00%
transfer_no_resume_ring_1.3_rsa_aes 7.24 ms 7.27 ms 0.03 ms (0.40%) 2.60%
transfer_no_resume_ring_1.3_ecdsap256_aes 6.67 ms 6.69 ms 0.02 ms (0.31%) 3.49%
handshake_no_resume_ring_1.2_rsa_aes 1.07 ms 1.08 ms 0.00 ms (0.30%) 1.06%
transfer_no_resume_aws_lc_rs_1.3_ecdsap384_aes 5.57 ms 5.58 ms 0.02 ms (0.28%) 3.94%
handshake_session_id_aws_lc_rs_1.3_ecdsap256_aes 5.45 ms 5.47 ms 0.01 ms (0.27%) 1.95%
handshake_no_resume_ring_1.3_rsa_chacha 1.09 ms 1.09 ms 0.00 ms (0.27%) 1.00%
handshake_tickets_aws_lc_rs_1.3_ecdsap384_aes 6.20 ms 6.21 ms 0.02 ms (0.27%) 1.91%
handshake_tickets_ring_1.3_ecdsap256_chacha 6.90 ms 6.88 ms -0.02 ms (-0.26%) 2.45%
transfer_no_resume_aws_lc_rs_1.3_rsa_aes 5.79 ms 5.81 ms 0.01 ms (0.25%) 3.69%
handshake_session_id_aws_lc_rs_1.3_ecdsap384_aes 6.16 ms 6.17 ms 0.01 ms (0.23%) 1.98%
handshake_no_resume_ring_1.3_ecdsap384_aes 3.61 ms 3.62 ms 0.01 ms (0.23%) 1.39%
handshake_session_id_aws_lc_rs_1.2_rsa_aes 2.18 ms 2.18 ms 0.01 ms (0.23%) 1.54%
transfer_no_resume_aws_lc_rs_1.3_ecdsap384_chacha 14.03 ms 14.06 ms 0.03 ms (0.22%) 1.65%
transfer_no_resume_aws_lc_rs_1.3_rsa_chacha 14.27 ms 14.30 ms 0.03 ms (0.22%) 1.36%
handshake_tickets_ring_1.3_ecdsap256_aes 6.95 ms 6.93 ms -0.01 ms (-0.22%) 1.91%
handshake_no_resume_aws_lc_rs_1.3_ecdsap384_chacha 1.18 ms 1.19 ms 0.00 ms (0.21%) 1.15%
transfer_no_resume_aws_lc_rs_1.3_ecdsap256_chacha 13.33 ms 13.36 ms 0.03 ms (0.21%) 1.58%
handshake_no_resume_ring_1.3_ecdsap384_chacha 3.61 ms 3.62 ms 0.01 ms (0.21%) 1.45%
handshake_tickets_aws_lc_rs_1.3_ecdsap256_chacha 5.46 ms 5.47 ms 0.01 ms (0.20%) 2.65%
transfer_no_resume_ring_1.3_ecdsap384_chacha 16.44 ms 16.47 ms 0.03 ms (0.20%) 1.66%
handshake_session_id_ring_1.3_ecdsap256_aes 6.92 ms 6.91 ms -0.01 ms (-0.19%) 1.89%
handshake_session_id_aws_lc_rs_1.3_rsa_aes 6.45 ms 6.47 ms 0.01 ms (0.19%) 1.76%
transfer_no_resume_ring_1.3_rsa_chacha 13.92 ms 13.94 ms 0.03 ms (0.19%) 1.56%
handshake_tickets_aws_lc_rs_1.3_rsa_aes 6.48 ms 6.49 ms 0.01 ms (0.18%) 2.01%
handshake_tickets_aws_lc_rs_1.3_ecdsap256_aes 5.48 ms 5.49 ms 0.01 ms (0.17%) 2.37%
handshake_session_id_ring_1.3_ecdsap256_chacha 6.87 ms 6.86 ms -0.01 ms (-0.16%) 2.45%
handshake_tickets_ring_1.2_rsa_aes 1.85 ms 1.85 ms -0.00 ms (-0.15%) 1.65%
transfer_no_resume_aws_lc_rs_1.3_ecdsap256_aes 4.85 ms 4.86 ms 0.01 ms (0.14%) 4.58%
transfer_no_resume_ring_1.3_ecdsap256_chacha 13.34 ms 13.36 ms 0.02 ms (0.12%) 1.78%
handshake_session_id_aws_lc_rs_1.3_rsa_chacha 6.43 ms 6.43 ms 0.01 ms (0.09%) 2.58%
handshake_no_resume_aws_lc_rs_1.2_rsa_aes 1.37 ms 1.37 ms 0.00 ms (0.09%) 1.10%
handshake_tickets_ring_1.3_ecdsap384_chacha 10.00 ms 9.99 ms -0.01 ms (-0.08%) 2.28%
handshake_tickets_aws_lc_rs_1.3_rsa_chacha 6.47 ms 6.47 ms 0.01 ms (0.08%) 2.33%
handshake_tickets_aws_lc_rs_1.3_ecdsap384_chacha 6.17 ms 6.18 ms 0.00 ms (0.08%) 2.32%
handshake_session_id_aws_lc_rs_1.3_ecdsap384_chacha 6.12 ms 6.13 ms 0.00 ms (0.08%) 2.26%
handshake_tickets_aws_lc_rs_1.2_rsa_aes 2.34 ms 2.34 ms 0.00 ms (0.07%) 1.81%
handshake_session_id_ring_1.3_rsa_aes 7.55 ms 7.56 ms 0.01 ms (0.07%) 2.24%
handshake_no_resume_aws_lc_rs_1.3_rsa_aes 1.42 ms 1.42 ms 0.00 ms (0.07%) 1.00%
handshake_no_resume_aws_lc_rs_1.3_ecdsap384_aes 1.19 ms 1.19 ms 0.00 ms (0.07%) 1.15%
handshake_no_resume_aws_lc_rs_1.3_rsa_chacha 1.41 ms 1.41 ms 0.00 ms (0.06%) 1.00%
handshake_tickets_ring_1.3_ecdsap384_aes 10.05 ms 10.04 ms -0.00 ms (-0.05%) 2.42%
handshake_session_id_ring_1.3_rsa_chacha 7.50 ms 7.49 ms -0.00 ms (-0.05%) 2.43%
handshake_session_id_ring_1.3_ecdsap384_chacha 9.97 ms 9.96 ms -0.00 ms (-0.04%) 2.18%
handshake_tickets_ring_1.3_rsa_aes 7.58 ms 7.58 ms -0.00 ms (-0.02%) 1.97%
handshake_tickets_ring_1.3_rsa_chacha 7.52 ms 7.52 ms -0.00 ms (-0.02%) 2.13%
handshake_session_id_ring_1.3_ecdsap384_aes 10.02 ms 10.01 ms -0.00 ms (-0.02%) 1.84%
handshake_session_id_aws_lc_rs_1.3_ecdsap256_chacha 5.43 ms 5.43 ms 0.00 ms (0.01%) 2.85%

Additional information

Historical results

Checkout details:

Copy link

codecov bot commented Feb 27, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 95.98%. Comparing base (02fb712) to head (362e5fb).

Additional details and impacted files
@@           Coverage Diff           @@
##             main    #1812   +/-   ##
=======================================
  Coverage   95.98%   95.98%           
=======================================
  Files          84       84           
  Lines       18791    18791           
=======================================
  Hits        18036    18036           
  Misses        755      755           

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

@cpu cpu added this pull request to the merge queue Feb 27, 2024
Merged via the queue into rustls:main with commit 64f9742 Feb 27, 2024
24 checks passed
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.

None yet

3 participants