Skip to content

examples: convert tlsserver-mio from docopt to clap#2126

Merged
cpu merged 3 commits intomainfrom
no-docopt
Sep 20, 2024
Merged

examples: convert tlsserver-mio from docopt to clap#2126
cpu merged 3 commits intomainfrom
no-docopt

Conversation

@djc
Copy link
Member

@djc djc commented Sep 19, 2024 •
edited
Loading

Not sure how best to test that this works...

I can take care of the other examples too, but figured it'd be good to get feedback on one first.

@djc djc requested review from cpu and ctz September 19, 2024 10:06
@rustls-benchmarking
Copy link

rustls-benchmarking bot commented Sep 19, 2024 •
edited
Loading

Benchmark results

Instruction counts

Significant differences

⚠️ There are significant instruction count differences

Click to expand
Scenario Baseline Candidate Diff Threshold
handshake_no_resume_aws_lc_rs_1.3_ecdsap256_chacha_server 1906254 1919037 ⚠️ 12783 (0.67%) 0.20%
handshake_no_resume_aws_lc_rs_1.3_ecdsap256_aes_server 1903960 1916015 ⚠️ 12055 (0.63%) 0.20%
handshake_no_resume_ring_1.3_ecdsap256_aes_server 2126294 2138667 ⚠️ 12373 (0.58%) 0.20%
handshake_no_resume_aws_lc_rs_1.3_rsa_chacha_client 2228278 2234107 ⚠️ 5829 (0.26%) 0.20%
handshake_no_resume_aws_lc_rs_1.3_rsa_aes_client 2221684 2226697 ⚠️ 5013 (0.23%) 0.20%

Other differences

Click to expand
Scenario Baseline Candidate Diff Threshold
handshake_session_id_aws_lc_rs_1.2_rsa_aes_server 3992912 3963854 -29058 (-0.73%) 3.25%
handshake_no_resume_ring_1.3_ecdsap256_chacha_server 2127739 2140586 12847 (0.60%) 0.82%
handshake_tickets_aws_lc_rs_1.2_rsa_aes_server 5140155 5159027 18872 (0.37%) 4.29%
handshake_session_id_aws_lc_rs_1.3_ecdsap384_aes_client 30679945 30760193 80248 (0.26%) 0.52%
handshake_no_resume_aws_lc_rs_1.3_ecdsap384_chacha_client 8874354 8897437 23083 (0.26%) 0.98%
handshake_no_resume_aws_lc_rs_1.2_rsa_aes_server 13405165 13440031 34866 (0.26%) 0.83%
handshake_no_resume_ring_1.3_ecdsap256_chacha_client 3911026 3920675 9649 (0.25%) 0.44%
handshake_no_resume_ring_1.3_ecdsap256_aes_client 3909888 3918979 9091 (0.23%) 0.41%
handshake_tickets_aws_lc_rs_1.3_ecdsap384_aes_client 31079734 31145625 65891 (0.21%) 0.35%
handshake_session_id_aws_lc_rs_1.3_ecdsap256_chacha_client 30662400 30721538 59138 (0.19%) 0.20%
handshake_no_resume_ring_1.3_rsa_chacha_client 2951945 2957434 5489 (0.19%) 0.20%
handshake_no_resume_aws_lc_rs_1.3_ecdsap384_chacha_server 4377269 4385358 8089 (0.18%) 0.20%
handshake_session_id_aws_lc_rs_1.3_rsa_chacha_client 30682961 30739529 56568 (0.18%) 0.20%
handshake_tickets_aws_lc_rs_1.3_ecdsap256_chacha_client 31118307 31175535 57228 (0.18%) 0.20%
handshake_session_id_aws_lc_rs_1.3_ecdsap256_chacha_server 32907224 32966003 58779 (0.18%) 0.20%
handshake_session_id_aws_lc_rs_1.3_rsa_chacha_server 32864424 32922955 58531 (0.18%) 0.60%
handshake_no_resume_aws_lc_rs_1.3_ecdsap384_aes_server 4374557 4382288 7731 (0.18%) 0.20%
handshake_tickets_aws_lc_rs_1.3_rsa_chacha_client 31142414 31197384 54970 (0.18%) 0.20%
handshake_no_resume_ring_1.3_rsa_aes_client 2946367 2951508 5141 (0.17%) 0.20%
handshake_tickets_aws_lc_rs_1.3_ecdsap384_chacha_server 34729637 34790089 60452 (0.17%) 0.20%
handshake_session_id_aws_lc_rs_1.3_ecdsap384_chacha_server 32908765 32965551 56786 (0.17%) 0.20%
handshake_tickets_aws_lc_rs_1.3_ecdsap256_chacha_server 34733378 34789061 55683 (0.16%) 0.20%
handshake_tickets_aws_lc_rs_1.3_rsa_aes_server 34713327 34768302 54975 (0.16%) 0.41%
handshake_tickets_aws_lc_rs_1.3_ecdsap256_aes_client 31084350 31130400 46050 (0.15%) 0.20%
handshake_session_id_aws_lc_rs_1.3_rsa_aes_client 30718803 30763880 45077 (0.15%) 0.20%
handshake_tickets_aws_lc_rs_1.3_rsa_aes_client 31106150 31151278 45128 (0.15%) 0.20%
handshake_session_id_aws_lc_rs_1.3_ecdsap256_aes_client 30703127 30746941 43814 (0.14%) 0.20%
handshake_session_id_aws_lc_rs_1.3_ecdsap384_aes_server 32959263 33006196 46933 (0.14%) 0.20%
handshake_session_id_aws_lc_rs_1.3_ecdsap256_aes_server 32959831 33006312 46481 (0.14%) 0.20%
handshake_tickets_aws_lc_rs_1.3_ecdsap384_aes_server 34720873 34769430 48557 (0.14%) 0.20%
handshake_no_resume_aws_lc_rs_1.3_ecdsap256_chacha_client 3378796 3383252 4456 (0.13%) 0.23%
handshake_session_id_ring_1.3_ecdsap384_chacha_client 41827380 41881554 54174 (0.13%) 0.20%
handshake_tickets_aws_lc_rs_1.3_ecdsap256_aes_server 34725013 34769261 44248 (0.13%) 0.20%
handshake_tickets_ring_1.3_rsa_chacha_client 42309322 42363188 53866 (0.13%) 0.20%
handshake_no_resume_aws_lc_rs_1.3_ecdsap256_aes_client 3374047 3378342 4295 (0.13%) 0.26%
handshake_session_id_ring_1.3_rsa_chacha_client 41846014 41899011 52997 (0.13%) 0.20%
handshake_tickets_ring_1.3_rsa_chacha_server 43903138 43958437 55299 (0.13%) 0.20%
handshake_tickets_ring_1.3_ecdsap384_chacha_client 42292150 42345290 53140 (0.13%) 0.20%
handshake_session_id_ring_1.3_rsa_chacha_server 43312885 43367100 54215 (0.13%) 0.20%
handshake_session_id_ring_1.3_ecdsap384_chacha_server 43316161 43370323 54162 (0.13%) 0.20%
handshake_tickets_ring_1.3_ecdsap384_chacha_server 43907154 43961306 54152 (0.12%) 0.20%
handshake_tickets_ring_1.3_ecdsap256_chacha_client 42294973 42345843 50870 (0.12%) 0.20%
handshake_session_id_ring_1.3_ecdsap256_chacha_client 41831732 41881117 49385 (0.12%) 0.20%
handshake_session_id_ring_1.3_ecdsap256_chacha_server 43316998 43366751 49753 (0.11%) 0.20%
handshake_tickets_ring_1.3_ecdsap256_chacha_server 43907063 43956979 49916 (0.11%) 0.20%
handshake_tickets_ring_1.3_ecdsap256_aes_client 42368637 42415786 47149 (0.11%) 0.20%
handshake_session_id_ring_1.3_ecdsap384_aes_client 41915153 41961719 46566 (0.11%) 0.20%
handshake_session_id_ring_1.3_rsa_aes_client 41932982 41978772 45790 (0.11%) 0.20%
handshake_tickets_ring_1.3_rsa_aes_client 42382105 42427950 45845 (0.11%) 0.20%
handshake_tickets_ring_1.3_ecdsap384_aes_client 42364341 42410145 45804 (0.11%) 0.20%
handshake_session_id_ring_1.3_rsa_aes_server 43422892 43468447 45555 (0.10%) 0.20%
handshake_session_id_ring_1.3_ecdsap384_aes_server 43425993 43470719 44726 (0.10%) 0.20%
handshake_tickets_ring_1.3_ecdsap256_aes_server 43999777 44045026 45249 (0.10%) 0.20%
handshake_tickets_ring_1.3_rsa_aes_server 43996738 44041551 44813 (0.10%) 0.20%
handshake_tickets_ring_1.3_ecdsap384_aes_server 43999699 44043425 43726 (0.10%) 0.20%
handshake_no_resume_ring_1.2_rsa_aes_server 11980957 11992220 11263 (0.09%) 0.20%
handshake_session_id_ring_1.3_ecdsap256_aes_client 41924664 41961647 36983 (0.09%) 0.20%
handshake_session_id_ring_1.3_ecdsap256_aes_server 43431327 43467629 36302 (0.08%) 0.20%
transfer_no_resume_aws_lc_rs_1.3_rsa_aes_server 46410700 46448470 37770 (0.08%) 0.20%
handshake_session_id_aws_lc_rs_1.3_rsa_aes_server 32923006 32948940 25934 (0.08%) 0.52%
handshake_no_resume_aws_lc_rs_1.3_rsa_chacha_server 13830589 13841378 10789 (0.08%) 0.86%
handshake_tickets_aws_lc_rs_1.3_ecdsap384_chacha_client 31140381 31164284 23903 (0.08%) 0.56%
handshake_session_id_aws_lc_rs_1.2_rsa_aes_client 4036393 4033369 -3024 (-0.07%) 0.20%
handshake_no_resume_ring_1.3_rsa_chacha_server 12178443 12186069 7626 (0.06%) 0.20%
handshake_no_resume_ring_1.3_rsa_aes_server 12172468 12179996 7528 (0.06%) 0.20%
handshake_no_resume_ring_1.3_ecdsap384_aes_server 13734397 13742487 8090 (0.06%) 0.20%
transfer_no_resume_aws_lc_rs_1.3_rsa_chacha_server 80573387 80619773 46386 (0.06%) 0.24%
handshake_no_resume_aws_lc_rs_1.2_rsa_aes_client 2010479 2011619 1140 (0.06%) 0.20%
handshake_tickets_ring_1.2_rsa_aes_client 4562851 4560351 -2500 (-0.05%) 0.20%
handshake_no_resume_ring_1.3_ecdsap384_chacha_server 13736863 13744291 7428 (0.05%) 0.20%
handshake_session_id_ring_1.2_rsa_aes_client 4290133 4287867 -2266 (-0.05%) 0.20%
handshake_tickets_aws_lc_rs_1.2_rsa_aes_client 4448636 4446573 -2063 (-0.05%) 0.20%
handshake_session_id_aws_lc_rs_1.3_ecdsap384_chacha_client 30677436 30690450 13014 (0.04%) 0.42%
handshake_no_resume_ring_1.2_rsa_aes_client 2852623 2853808 1185 (0.04%) 0.20%
handshake_no_resume_aws_lc_rs_1.3_ecdsap384_aes_client 8871890 8875372 3482 (0.04%) 1.25%
transfer_no_resume_aws_lc_rs_1.3_ecdsap384_aes_client 58262549 58239822 -22727 (-0.04%) 0.20%
handshake_no_resume_aws_lc_rs_1.3_rsa_aes_server 13838108 13842325 4217 (0.03%) 0.82%
handshake_no_resume_ring_1.3_ecdsap384_aes_client 35468955 35473916 4961 (0.01%) 0.20%
transfer_no_resume_aws_lc_rs_1.2_rsa_aes_server 46384528 46390544 6016 (0.01%) 0.33%
handshake_no_resume_ring_1.3_ecdsap384_chacha_client 35471139 35475671 4532 (0.01%) 0.20%
transfer_no_resume_ring_1.3_ecdsap256_aes_server 46436567 46431117 -5450 (-0.01%) 0.20%
transfer_no_resume_ring_1.2_rsa_aes_server 46348236 46352758 4522 (0.01%) 0.20%
transfer_no_resume_aws_lc_rs_1.3_ecdsap256_aes_server 46429734 46425843 -3891 (-0.01%) 0.20%
transfer_no_resume_ring_1.3_ecdsap256_aes_client 58330608 58326535 -4073 (-0.01%) 0.20%
handshake_session_id_ring_1.2_rsa_aes_server 4269536 4269268 -268 (-0.01%) 0.20%
transfer_no_resume_ring_1.3_ecdsap256_chacha_server 80504812 80499975 -4837 (-0.01%) 0.20%
transfer_no_resume_ring_1.3_ecdsap256_chacha_client 92664733 92659648 -5085 (-0.01%) 0.20%
handshake_tickets_aws_lc_rs_1.3_rsa_chacha_server 34763347 34761441 -1906 (-0.01%) 0.55%
transfer_no_resume_aws_lc_rs_1.3_ecdsap256_chacha_server 80610217 80606509 -3708 (-0.00%) 0.20%
handshake_tickets_ring_1.2_rsa_aes_server 4707918 4707753 -165 (-0.00%) 0.20%
transfer_no_resume_aws_lc_rs_1.3_ecdsap256_aes_client 58246799 58248267 1468 (0.00%) 0.20%
transfer_no_resume_ring_1.3_ecdsap384_aes_server 46439745 46438785 -960 (-0.00%) 0.20%
transfer_no_resume_aws_lc_rs_1.3_ecdsap384_aes_server 46427335 46426753 -582 (-0.00%) 0.20%
transfer_no_resume_ring_1.3_ecdsap384_chacha_server 80508021 80507509 -512 (-0.00%) 0.20%
transfer_no_resume_ring_1.3_ecdsap384_chacha_client 92660319 92660744 425 (0.00%) 0.20%
transfer_no_resume_aws_lc_rs_1.3_ecdsap384_chacha_client 92695039 92695437 398 (0.00%) 0.20%
transfer_no_resume_aws_lc_rs_1.3_ecdsap256_chacha_client 92704128 92703744 -384 (-0.00%) 0.20%
transfer_no_resume_ring_1.3_rsa_chacha_client 92664835 92664575 -260 (-0.00%) 0.20%
transfer_no_resume_ring_1.2_rsa_aes_client 58207866 58207716 -150 (-0.00%) 0.20%
transfer_no_resume_aws_lc_rs_1.3_rsa_chacha_client 92705527 92705336 -191 (-0.00%) 0.20%
transfer_no_resume_ring_1.3_ecdsap384_aes_client 58328094 58328214 120 (0.00%) 0.20%
transfer_no_resume_ring_1.3_rsa_aes_server 46447347 46447414 67 (0.00%) 0.20%
transfer_no_resume_aws_lc_rs_1.2_rsa_aes_client 68658369 68658274 -95 (-0.00%) 0.20%
transfer_no_resume_aws_lc_rs_1.3_rsa_aes_client 58246965 58247032 67 (0.00%) 0.20%
transfer_no_resume_ring_1.3_rsa_chacha_server 80516000 80515922 -78 (-0.00%) 0.20%
transfer_no_resume_aws_lc_rs_1.3_ecdsap384_chacha_server 80608220 80608167 -53 (-0.00%) 0.20%
transfer_no_resume_ring_1.3_rsa_aes_client 58331922 58331914 -8 (-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_aws_lc_rs_1.3_ecdsap256_aes 4.58 ms 4.47 ms -0.11 ms (-2.42%) 5.50%
transfer_no_resume_aws_lc_rs_1.3_ecdsap384_aes 5.31 ms 5.20 ms -0.11 ms (-2.09%) 4.63%
transfer_no_resume_aws_lc_rs_1.2_rsa_aes 5.52 ms 5.42 ms -0.10 ms (-1.84%) 5.26%
transfer_no_resume_aws_lc_rs_1.3_rsa_aes 5.52 ms 5.43 ms -0.09 ms (-1.71%) 5.40%
handshake_no_resume_aws_lc_rs_1.3_ecdsap256_aes 491.17 µs 483.88 µs -7.29 µs (-1.48%) 3.02%
transfer_no_resume_ring_1.3_ecdsap256_aes 6.40 ms 6.31 ms -0.09 ms (-1.37%) 4.55%
transfer_no_resume_ring_1.2_rsa_aes 6.80 ms 6.71 ms -0.09 ms (-1.37%) 3.46%
transfer_no_resume_ring_1.3_rsa_aes 6.88 ms 6.79 ms -0.09 ms (-1.26%) 3.88%
handshake_no_resume_ring_1.3_ecdsap256_aes 512.99 µs 507.20 µs -5.79 µs (-1.13%) 1.86%
transfer_no_resume_ring_1.3_ecdsap384_aes 9.50 ms 9.41 ms -0.09 ms (-0.95%) 2.82%
handshake_no_resume_aws_lc_rs_1.3_ecdsap256_chacha 486.07 µs 481.88 µs -4.19 µs (-0.86%) 3.73%
transfer_no_resume_aws_lc_rs_1.3_ecdsap256_chacha 13.05 ms 12.94 ms -0.11 ms (-0.84%) 2.26%
transfer_no_resume_ring_1.3_ecdsap256_chacha 13.05 ms 12.95 ms -0.11 ms (-0.83%) 1.86%
transfer_no_resume_ring_1.3_rsa_chacha 13.54 ms 13.43 ms -0.11 ms (-0.83%) 1.96%
transfer_no_resume_aws_lc_rs_1.3_ecdsap384_chacha 13.77 ms 13.66 ms -0.11 ms (-0.80%) 1.89%
handshake_no_resume_ring_1.3_ecdsap256_chacha 507.78 µs 504.04 µs -3.74 µs (-0.74%) 2.63%
transfer_no_resume_aws_lc_rs_1.3_rsa_chacha 13.99 ms 13.89 ms -0.10 ms (-0.70%) 2.19%
handshake_session_id_aws_lc_rs_1.2_rsa_aes 2.08 ms 2.10 ms 0.01 ms (0.70%) 2.47%
transfer_no_resume_ring_1.3_ecdsap384_chacha 16.15 ms 16.04 ms -0.11 ms (-0.66%) 1.80%
handshake_no_resume_aws_lc_rs_1.3_rsa_aes 1.42 ms 1.43 ms 0.01 ms (0.64%) 2.10%
handshake_no_resume_aws_lc_rs_1.3_ecdsap384_aes 1.21 ms 1.20 ms -0.01 ms (-0.58%) 1.40%
handshake_tickets_aws_lc_rs_1.2_rsa_aes 2.30 ms 2.31 ms 0.01 ms (0.56%) 1.80%
handshake_no_resume_aws_lc_rs_1.3_rsa_chacha 1.41 ms 1.42 ms 0.01 ms (0.56%) 3.08%
handshake_no_resume_aws_lc_rs_1.3_ecdsap384_chacha 1.20 ms 1.20 ms -0.01 ms (-0.49%) 1.17%
handshake_tickets_aws_lc_rs_1.3_rsa_chacha 6.50 ms 6.53 ms 0.03 ms (0.43%) 1.69%
handshake_tickets_ring_1.2_rsa_aes 1.67 ms 1.66 ms -0.01 ms (-0.39%) 1.05%
handshake_tickets_aws_lc_rs_1.3_ecdsap256_chacha 5.55 ms 5.57 ms 0.02 ms (0.38%) 2.29%
handshake_tickets_aws_lc_rs_1.3_rsa_aes 6.50 ms 6.52 ms 0.02 ms (0.36%) 1.85%
handshake_no_resume_ring_1.3_rsa_chacha 993.33 µs 989.82 µs -3.52 µs (-0.35%) 1.00%
handshake_no_resume_aws_lc_rs_1.2_rsa_aes 1.37 ms 1.37 ms 0.00 ms (0.34%) 2.33%
handshake_no_resume_ring_1.2_rsa_aes 981.94 µs 979.03 µs -2.91 µs (-0.30%) 1.30%
handshake_tickets_aws_lc_rs_1.3_ecdsap384_chacha 6.26 ms 6.28 ms 0.02 ms (0.29%) 1.80%
handshake_no_resume_ring_1.3_rsa_aes 992.20 µs 989.36 µs -2.84 µs (-0.29%) 1.08%
handshake_session_id_aws_lc_rs_1.3_rsa_chacha 6.38 ms 6.39 ms 0.02 ms (0.28%) 1.80%
handshake_session_id_ring_1.2_rsa_aes 1.58 ms 1.58 ms -0.00 ms (-0.28%) 1.39%
handshake_session_id_aws_lc_rs_1.3_ecdsap256_aes 5.45 ms 5.44 ms -0.01 ms (-0.22%) 2.10%
handshake_session_id_aws_lc_rs_1.3_rsa_aes 6.40 ms 6.41 ms 0.01 ms (0.20%) 1.86%
handshake_session_id_aws_lc_rs_1.3_ecdsap384_chacha 6.14 ms 6.15 ms 0.01 ms (0.18%) 1.66%
handshake_tickets_ring_1.3_rsa_aes 7.30 ms 7.31 ms 0.01 ms (0.17%) 1.22%
handshake_no_resume_ring_1.3_ecdsap384_aes 3.61 ms 3.60 ms -0.01 ms (-0.15%) 1.00%
handshake_tickets_aws_lc_rs_1.3_ecdsap256_aes 5.55 ms 5.56 ms 0.01 ms (0.14%) 1.87%
handshake_no_resume_ring_1.3_ecdsap384_chacha 3.60 ms 3.60 ms -0.00 ms (-0.14%) 1.00%
handshake_tickets_ring_1.3_ecdsap256_aes 6.82 ms 6.83 ms 0.01 ms (0.12%) 1.24%
handshake_session_id_aws_lc_rs_1.3_ecdsap384_aes 6.16 ms 6.16 ms -0.01 ms (-0.11%) 2.11%
handshake_session_id_aws_lc_rs_1.3_ecdsap256_chacha 5.43 ms 5.43 ms 0.01 ms (0.11%) 2.16%
handshake_tickets_ring_1.3_rsa_chacha 7.25 ms 7.25 ms 0.01 ms (0.11%) 1.29%
handshake_tickets_aws_lc_rs_1.3_ecdsap384_aes 6.27 ms 6.27 ms 0.01 ms (0.09%) 1.66%
handshake_session_id_ring_1.3_ecdsap384_aes 9.86 ms 9.85 ms -0.01 ms (-0.07%) 1.08%
handshake_session_id_ring_1.3_ecdsap256_aes 6.77 ms 6.77 ms 0.00 ms (0.06%) 1.79%
handshake_session_id_ring_1.3_ecdsap384_chacha 9.82 ms 9.81 ms -0.01 ms (-0.06%) 1.00%
handshake_session_id_ring_1.3_rsa_aes 7.26 ms 7.26 ms 0.00 ms (0.06%) 1.35%
handshake_tickets_ring_1.3_ecdsap384_aes 9.90 ms 9.91 ms 0.01 ms (0.06%) 1.00%
handshake_tickets_ring_1.3_ecdsap256_chacha 6.77 ms 6.77 ms 0.00 ms (0.03%) 1.22%
handshake_session_id_ring_1.3_ecdsap256_chacha 6.72 ms 6.72 ms -0.00 ms (-0.02%) 1.44%
handshake_session_id_ring_1.3_rsa_chacha 7.20 ms 7.20 ms 0.00 ms (0.01%) 1.06%
handshake_tickets_ring_1.3_ecdsap384_chacha 9.85 ms 9.85 ms 0.00 ms (0.00%) 1.00%

Additional information

Historical results

Checkout details:

@codecov
Copy link

codecov bot commented Sep 19, 2024 •
edited
Loading

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 94.87%. Comparing base (a4dbf73) to head (19bac23).
Report is 17 commits behind head on main.

Additional details and impacted files 
@@            Coverage Diff             @@
##             main    #2126      +/-   ##
==========================================
+ Coverage   94.66%   94.87%   +0.21%     
==========================================
  Files         102      102              
  Lines       23450    24263     +813     
==========================================
+ Hits        22198    23019     +821     
+ Misses       1252     1244       -8

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

@djc djc force-pushed the no-docopt branch 2 times, most recently from fae6fa9 to b65fb44 Compare September 19, 2024 10:35
djc
djc commented Sep 19, 2024
View reviewed changes
ctz
ctz reviewed Sep 19, 2024
View reviewed changes
@ctz
Copy link
Member

ctz commented Sep 19, 2024

Thanks for doing this, happy to do the legwork on the remaining samples to eliminate docopt altogether after this is finished.

@djc djc force-pushed the no-docopt branch 2 times, most recently from cc3fcdd to 64733fb Compare September 19, 2024 11:50
cpu
cpu approved these changes Sep 19, 2024
View reviewed changes
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.

Very nice 👍

@cpu
Copy link
Member

cpu commented Sep 19, 2024

Separate from the docopt -> clap change, how do folks feel about the "mio" part of the example names? I've heard from at least one person looking for something sort of like a openssl s_client and openssl s_server that these examples might be better named rustls_client and rustls_server.

It feels a little bit like the MIO part is an implementation detail, and perhaps not the "main draw" of the examples. WDYT?

@djc
Copy link
Member Author

djc commented Sep 19, 2024

It feels a little bit like the MIO part is an implementation detail, and perhaps not the "main draw" of the examples. WDYT?

Seems fair. Since we have the simpleclient/simpleserver as well as minimal implementations, we could argue that these are less "example code" and more CLI interfaces, in which case renaming makes sense but I'd probably also migrate from using mio directly to just using tokio-rustls for these, since the rustls <-> mio interworkings seem extremely niche in practice.

@cpu
Copy link
Member

cpu commented Sep 19, 2024 •
edited
Loading

I'd probably also migrate from using mio directly to just using tokio-rustls for these, since the rustls <-> mio interworkings seem extremely niche in practice.

I'm a little bit torn on that direction. If we made that change, would there be an argument the examples should live in the tokio-rustls repo instead? I also think there's some value in having an example that sits between the simple examples that use complete_io / the stream abstractions and something that defers to Tokio for the guts of the I/O. 🤔 On the other hand, I agree with you that few folks are likely to want to operate at that level and MIO feels niche.

Edit; also don't want to derail this PR too much. Maybe best to file a separate issue?

@djc
Copy link
Member Author

djc commented Sep 19, 2024

I'd probably also migrate from using mio directly to just using tokio-rustls for these, since the rustls <-> mio interworkings seem extremely niche in practice.

I'm a little bit torn on that direction. If we made that change, would there be an argument the examples should live in the tokio-rustls repo instead? I also think there's some value in having an example that sits between the simple examples that use complete_io / the stream abstractions and something that defers to Tokio for the guts of the I/O. 🤔 On the other hand, I agree with you that few folks are likely to want to operate at that level and MIO feels niche.

You were the one arguing that these examples are effectively providing a CLI for rustls, which makes sense to me. I think any value from sitting between the simple examples and deferring to Tokio for I/O is extremely niche. But as discussed recently, I'm kind of down on having many examples...

Edit; also don't want to derail this PR too much. Maybe best to file a separate issue?

Yeah, wasn't going to pick it up for this PR.

@cpu cpu added this pull request to the merge queue Sep 20, 2024
Merged via the queue into main with commit a92dd8f Sep 20, 2024
@cpu cpu deleted the no-docopt branch September 20, 2024 13:38
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@cpu cpu cpu approved these changes

@ctz ctz ctz 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.

3 participants

@djc @ctz @cpu