├── .github └── workflows │ ├── check.yml │ └── deploy.yml ├── .gitignore ├── Cargo.lock ├── Cargo.toml ├── LICENSE ├── README.md ├── content ├── async-fn-in-trait.md ├── await-multiple-futures.md ├── binary-size.md ├── common-ide.md ├── debug-build-slow.md ├── error-handling.md ├── fn-pointer-fn-trait.md ├── format-macro.md ├── future-poll-perf.md ├── futures-rel.md ├── generic-primitive-num.md ├── glossary.toml ├── heap-new.md ├── static-lifetime-bound-var.md ├── trait-obj-upcast.md ├── vec-new-ptr.md └── where-to-find-crates.md ├── res ├── cc0.png ├── edit.svg ├── index.html.hbs ├── style.css └── telegram.png └── src ├── entry_writer.rs └── main.rs /.github/workflows/check.yml: -------------------------------------------------------------------------------- 1 | on: [push, pull_request] 2 | name: Check 3 | 4 | jobs: 5 | format: 6 | name: Format 7 | runs-on: ubuntu-latest 8 | steps: 9 | - name: Checkout sources 10 | uses: actions/checkout@v2 11 | 12 | - name: Run cargo fmt 13 | uses: actions-rs/cargo@v1 14 | with: 15 | command: fmt 16 | args: --all -- --check 17 | 18 | clippy: 19 | name: Clippy 20 | runs-on: ubuntu-latest 21 | steps: 22 | - name: Checkout sources 23 | uses: actions/checkout@v2 24 | 25 | - name: Cache Cargo 26 | uses: actions/cache@v3 27 | with: 28 | path: | 29 | ~/.cargo/registry 30 | ~/.cargo/git 31 | key: ${{ runner.os }}-cargo-${{ hashFiles('**/Cargo.lock') }} 32 | restore-keys: | 33 | ${{ runner.os }}-cargo- 34 | 35 | - name: Cache target 36 | uses: actions/cache@v3 37 | with: 38 | path: target 39 | key: ${{ runner.os }}-clippy-${{ hashFiles('**/Cargo.lock') }}-${{ hashFiles('**/*.rs') }} 40 | restore-keys: | 41 | ${{ runner.os }}-clippy-${{ hashFiles('**/Cargo.lock') }}- 42 | ${{ runner.os }}-clippy- 43 | 44 | - name: Run cargo clippy 45 | uses: actions-rs/cargo@v1 46 | with: 47 | command: clippy 48 | args: -- -D warnings 49 | -------------------------------------------------------------------------------- /.github/workflows/deploy.yml: -------------------------------------------------------------------------------- 1 | on: 2 | push: 3 | branches: 4 | - master 5 | 6 | name: Deploy 7 | 8 | jobs: 9 | deploy: 10 | name: Deploy 11 | runs-on: ubuntu-latest 12 | steps: 13 | - name: Checkout sources 14 | uses: actions/checkout@v2 15 | 16 | - name: Cache Cargo 17 | uses: actions/cache@v3 18 | with: 19 | path: | 20 | ~/.cargo/registry 21 | ~/.cargo/git 22 | key: ${{ runner.os }}-cargo-${{ hashFiles('**/Cargo.lock') }} 23 | restore-keys: | 24 | ${{ runner.os }}-cargo- 25 | 26 | - name: Cache target 27 | uses: actions/cache@v3 28 | with: 29 | path: target 30 | key: ${{ runner.os }}-build-${{ hashFiles('**/Cargo.lock') }}-${{ hashFiles('**/*.rs') }} 31 | restore-keys: | 32 | ${{ runner.os }}-build-${{ hashFiles('**/Cargo.lock') }}- 33 | ${{ runner.os }}-build- 34 | 35 | - name: Build page 36 | uses: actions-rs/cargo@v1 37 | with: 38 | command: run 39 | 40 | - name: Deploy 41 | uses: peaceiris/actions-gh-pages@v3 42 | with: 43 | github_token: ${{ secrets.GITHUB_TOKEN }} 44 | publish_dir: ./out 45 | -------------------------------------------------------------------------------- /.gitignore: -------------------------------------------------------------------------------- 1 | /target 2 | /out 3 | -------------------------------------------------------------------------------- /Cargo.lock: -------------------------------------------------------------------------------- 1 | # This file is automatically @generated by Cargo. 2 | # It is not intended for manual editing. 3 | version = 3 4 | 5 | [[package]] 6 | name = "adler" 7 | version = "1.0.2" 8 | source = "registry+https://github.com/rust-lang/crates.io-index" 9 | checksum = "f26201604c87b1e01bd3d98f8d5d9a8fcbb815e8cedb41ffccbeb4bf593a35fe" 10 | 11 | [[package]] 12 | name = "anyhow" 13 | version = "1.0.71" 14 | source = "registry+https://github.com/rust-lang/crates.io-index" 15 | checksum = "9c7d0618f0e0b7e8ff11427422b64564d5fb0be1940354bfe2e0529b18a9d9b8" 16 | 17 | [[package]] 18 | name = "autocfg" 19 | version = "1.1.0" 20 | source = "registry+https://github.com/rust-lang/crates.io-index" 21 | checksum = "d468802bab17cbc0cc575e9b053f41e72aa36bfa6b7f55e3529ffa43161b97fa" 22 | 23 | [[package]] 24 | name = "base64" 25 | version = "0.21.2" 26 | source = "registry+https://github.com/rust-lang/crates.io-index" 27 | checksum = "604178f6c5c21f02dc555784810edfb88d34ac2c73b2eae109655649ee73ce3d" 28 | 29 | [[package]] 30 | name = "bincode" 31 | version = "1.3.3" 32 | source = "registry+https://github.com/rust-lang/crates.io-index" 33 | checksum = "b1f45e9417d87227c7a56d22e471c6206462cba514c7590c09aff4cf6d1ddcad" 34 | dependencies = [ 35 | "serde", 36 | ] 37 | 38 | [[package]] 39 | name = "bitflags" 40 | version = "1.3.2" 41 | source = "registry+https://github.com/rust-lang/crates.io-index" 42 | checksum = "bef38d45163c2f1dde094a7dfd33ccf595c92905c8f8f4fdc18d06fb1037718a" 43 | 44 | [[package]] 45 | name = "block-buffer" 46 | version = "0.10.4" 47 | source = "registry+https://github.com/rust-lang/crates.io-index" 48 | checksum = "3078c7629b62d3f0439517fa394996acacc5cbc91c5a20d8c658e77abd503a71" 49 | dependencies = [ 50 | "generic-array", 51 | ] 52 | 53 | [[package]] 54 | name = "cc" 55 | version = "1.0.79" 56 | source = "registry+https://github.com/rust-lang/crates.io-index" 57 | checksum = "50d30906286121d95be3d479533b458f87493b30a4b5f79a607db8f5d11aa91f" 58 | 59 | [[package]] 60 | name = "cfg-if" 61 | version = "1.0.0" 62 | source = "registry+https://github.com/rust-lang/crates.io-index" 63 | checksum = "baf1de4339761588bc0619e3cbc0120ee582ebb74b53b4efbf79117bd2da40fd" 64 | 65 | [[package]] 66 | name = "cpufeatures" 67 | version = "0.2.7" 68 | source = "registry+https://github.com/rust-lang/crates.io-index" 69 | checksum = "3e4c1eaa2012c47becbbad2ab175484c2a84d1185b566fb2cc5b8707343dfe58" 70 | dependencies = [ 71 | "libc", 72 | ] 73 | 74 | [[package]] 75 | name = "crc32fast" 76 | version = "1.3.2" 77 | source = "registry+https://github.com/rust-lang/crates.io-index" 78 | checksum = "b540bd8bc810d3885c6ea91e2018302f68baba2129ab3e88f32389ee9370880d" 79 | dependencies = [ 80 | "cfg-if", 81 | ] 82 | 83 | [[package]] 84 | name = "crypto-common" 85 | version = "0.1.6" 86 | source = "registry+https://github.com/rust-lang/crates.io-index" 87 | checksum = "1bfb12502f3fc46cca1bb51ac28df9d618d813cdc3d2f25b9fe775a34af26bb3" 88 | dependencies = [ 89 | "generic-array", 90 | "typenum", 91 | ] 92 | 93 | [[package]] 94 | name = "digest" 95 | version = "0.10.7" 96 | source = "registry+https://github.com/rust-lang/crates.io-index" 97 | checksum = "9ed9a281f7bc9b7576e61468ba615a66a5c8cfdff42420a70aa82701a3b1e292" 98 | dependencies = [ 99 | "block-buffer", 100 | "crypto-common", 101 | ] 102 | 103 | [[package]] 104 | name = "flate2" 105 | version = "1.0.26" 106 | source = "registry+https://github.com/rust-lang/crates.io-index" 107 | checksum = "3b9429470923de8e8cbd4d2dc513535400b4b3fef0319fb5c4e1f520a7bef743" 108 | dependencies = [ 109 | "crc32fast", 110 | "miniz_oxide", 111 | ] 112 | 113 | [[package]] 114 | name = "fnv" 115 | version = "1.0.7" 116 | source = "registry+https://github.com/rust-lang/crates.io-index" 117 | checksum = "3f9eec918d3f24069decb9af1554cad7c880e2da24a9afd88aca000531ab82c1" 118 | 119 | [[package]] 120 | name = "generic-array" 121 | version = "0.14.7" 122 | source = "registry+https://github.com/rust-lang/crates.io-index" 123 | checksum = "85649ca51fd72272d7821adaf274ad91c288277713d9c18820d8499a7ff69e9a" 124 | dependencies = [ 125 | "typenum", 126 | "version_check", 127 | ] 128 | 129 | [[package]] 130 | name = "getopts" 131 | version = "0.2.21" 132 | source = "registry+https://github.com/rust-lang/crates.io-index" 133 | checksum = "14dbbfd5c71d70241ecf9e6f13737f7b5ce823821063188d7e46c41d371eebd5" 134 | dependencies = [ 135 | "unicode-width", 136 | ] 137 | 138 | [[package]] 139 | name = "glob" 140 | version = "0.3.1" 141 | source = "registry+https://github.com/rust-lang/crates.io-index" 142 | checksum = "d2fabcfbdc87f4758337ca535fb41a6d701b65693ce38287d856d1674551ec9b" 143 | 144 | [[package]] 145 | name = "handlebars" 146 | version = "4.3.7" 147 | source = "registry+https://github.com/rust-lang/crates.io-index" 148 | checksum = "83c3372087601b532857d332f5957cbae686da52bb7810bf038c3e3c3cc2fa0d" 149 | dependencies = [ 150 | "log", 151 | "pest", 152 | "pest_derive", 153 | "serde", 154 | "serde_json", 155 | "thiserror", 156 | ] 157 | 158 | [[package]] 159 | name = "hashbrown" 160 | version = "0.12.3" 161 | source = "registry+https://github.com/rust-lang/crates.io-index" 162 | checksum = "8a9ee70c43aaf417c914396645a0fa852624801b24ebb7ae78fe8272889ac888" 163 | 164 | [[package]] 165 | name = "indexmap" 166 | version = "1.9.3" 167 | source = "registry+https://github.com/rust-lang/crates.io-index" 168 | checksum = "bd070e393353796e801d209ad339e89596eb4c8d430d18ede6a1cced8fafbd99" 169 | dependencies = [ 170 | "autocfg", 171 | "hashbrown", 172 | ] 173 | 174 | [[package]] 175 | name = "itoa" 176 | version = "1.0.6" 177 | source = "registry+https://github.com/rust-lang/crates.io-index" 178 | checksum = "453ad9f582a441959e5f0d088b02ce04cfe8d51a8eaf077f12ac6d3e94164ca6" 179 | 180 | [[package]] 181 | name = "lazy_static" 182 | version = "1.4.0" 183 | source = "registry+https://github.com/rust-lang/crates.io-index" 184 | checksum = "e2abad23fbc42b3700f2f279844dc832adb2b2eb069b2df918f455c4e18cc646" 185 | 186 | [[package]] 187 | name = "libc" 188 | version = "0.2.144" 189 | source = "registry+https://github.com/rust-lang/crates.io-index" 190 | checksum = "2b00cc1c228a6782d0f076e7b232802e0c5689d41bb5df366f2a6b6621cfdfe1" 191 | 192 | [[package]] 193 | name = "line-wrap" 194 | version = "0.1.1" 195 | source = "registry+https://github.com/rust-lang/crates.io-index" 196 | checksum = "f30344350a2a51da54c1d53be93fade8a237e545dbcc4bdbe635413f2117cab9" 197 | dependencies = [ 198 | "safemem", 199 | ] 200 | 201 | [[package]] 202 | name = "linked-hash-map" 203 | version = "0.5.6" 204 | source = "registry+https://github.com/rust-lang/crates.io-index" 205 | checksum = "0717cef1bc8b636c6e1c1bbdefc09e6322da8a9321966e8928ef80d20f7f770f" 206 | 207 | [[package]] 208 | name = "log" 209 | version = "0.4.18" 210 | source = "registry+https://github.com/rust-lang/crates.io-index" 211 | checksum = "518ef76f2f87365916b142844c16d8fefd85039bc5699050210a7778ee1cd1de" 212 | 213 | [[package]] 214 | name = "memchr" 215 | version = "2.5.0" 216 | source = "registry+https://github.com/rust-lang/crates.io-index" 217 | checksum = "2dffe52ecf27772e601905b7522cb4ef790d2cc203488bbd0e2fe85fcb74566d" 218 | 219 | [[package]] 220 | name = "miniz_oxide" 221 | version = "0.7.1" 222 | source = "registry+https://github.com/rust-lang/crates.io-index" 223 | checksum = "e7810e0be55b428ada41041c41f32c9f1a42817901b4ccf45fa3d4b6561e74c7" 224 | dependencies = [ 225 | "adler", 226 | ] 227 | 228 | [[package]] 229 | name = "once_cell" 230 | version = "1.17.2" 231 | source = "registry+https://github.com/rust-lang/crates.io-index" 232 | checksum = "9670a07f94779e00908f3e686eab508878ebb390ba6e604d3a284c00e8d0487b" 233 | 234 | [[package]] 235 | name = "onig" 236 | version = "6.4.0" 237 | source = "registry+https://github.com/rust-lang/crates.io-index" 238 | checksum = "8c4b31c8722ad9171c6d77d3557db078cab2bd50afcc9d09c8b315c59df8ca4f" 239 | dependencies = [ 240 | "bitflags", 241 | "libc", 242 | "once_cell", 243 | "onig_sys", 244 | ] 245 | 246 | [[package]] 247 | name = "onig_sys" 248 | version = "69.8.1" 249 | source = "registry+https://github.com/rust-lang/crates.io-index" 250 | checksum = "7b829e3d7e9cc74c7e315ee8edb185bf4190da5acde74afd7fc59c35b1f086e7" 251 | dependencies = [ 252 | "cc", 253 | "pkg-config", 254 | ] 255 | 256 | [[package]] 257 | name = "pest" 258 | version = "2.6.0" 259 | source = "registry+https://github.com/rust-lang/crates.io-index" 260 | checksum = "e68e84bfb01f0507134eac1e9b410a12ba379d064eab48c50ba4ce329a527b70" 261 | dependencies = [ 262 | "thiserror", 263 | "ucd-trie", 264 | ] 265 | 266 | [[package]] 267 | name = "pest_derive" 268 | version = "2.6.0" 269 | source = "registry+https://github.com/rust-lang/crates.io-index" 270 | checksum = "6b79d4c71c865a25a4322296122e3924d30bc8ee0834c8bfc8b95f7f054afbfb" 271 | dependencies = [ 272 | "pest", 273 | "pest_generator", 274 | ] 275 | 276 | [[package]] 277 | name = "pest_generator" 278 | version = "2.6.0" 279 | source = "registry+https://github.com/rust-lang/crates.io-index" 280 | checksum = "6c435bf1076437b851ebc8edc3a18442796b30f1728ffea6262d59bbe28b077e" 281 | dependencies = [ 282 | "pest", 283 | "pest_meta", 284 | "proc-macro2", 285 | "quote", 286 | "syn", 287 | ] 288 | 289 | [[package]] 290 | name = "pest_meta" 291 | version = "2.6.0" 292 | source = "registry+https://github.com/rust-lang/crates.io-index" 293 | checksum = "745a452f8eb71e39ffd8ee32b3c5f51d03845f99786fa9b68db6ff509c505411" 294 | dependencies = [ 295 | "once_cell", 296 | "pest", 297 | "sha2", 298 | ] 299 | 300 | [[package]] 301 | name = "pkg-config" 302 | version = "0.3.27" 303 | source = "registry+https://github.com/rust-lang/crates.io-index" 304 | checksum = "26072860ba924cbfa98ea39c8c19b4dd6a4a25423dbdf219c1eca91aa0cf6964" 305 | 306 | [[package]] 307 | name = "plist" 308 | version = "1.4.3" 309 | source = "registry+https://github.com/rust-lang/crates.io-index" 310 | checksum = "9bd9647b268a3d3e14ff09c23201133a62589c658db02bb7388c7246aafe0590" 311 | dependencies = [ 312 | "base64", 313 | "indexmap", 314 | "line-wrap", 315 | "quick-xml", 316 | "serde", 317 | "time", 318 | ] 319 | 320 | [[package]] 321 | name = "proc-macro2" 322 | version = "1.0.59" 323 | source = "registry+https://github.com/rust-lang/crates.io-index" 324 | checksum = "6aeca18b86b413c660b781aa319e4e2648a3e6f9eadc9b47e9038e6fe9f3451b" 325 | dependencies = [ 326 | "unicode-ident", 327 | ] 328 | 329 | [[package]] 330 | name = "pulldown-cmark" 331 | version = "0.9.3" 332 | source = "registry+https://github.com/rust-lang/crates.io-index" 333 | checksum = "77a1a2f1f0a7ecff9c31abbe177637be0e97a0aef46cf8738ece09327985d998" 334 | dependencies = [ 335 | "bitflags", 336 | "getopts", 337 | "memchr", 338 | "unicase", 339 | ] 340 | 341 | [[package]] 342 | name = "quick-xml" 343 | version = "0.28.2" 344 | source = "registry+https://github.com/rust-lang/crates.io-index" 345 | checksum = "0ce5e73202a820a31f8a0ee32ada5e21029c81fd9e3ebf668a40832e4219d9d1" 346 | dependencies = [ 347 | "memchr", 348 | ] 349 | 350 | [[package]] 351 | name = "quote" 352 | version = "1.0.28" 353 | source = "registry+https://github.com/rust-lang/crates.io-index" 354 | checksum = "1b9ab9c7eadfd8df19006f1cf1a4aed13540ed5cbc047010ece5826e10825488" 355 | dependencies = [ 356 | "proc-macro2", 357 | ] 358 | 359 | [[package]] 360 | name = "regex-syntax" 361 | version = "0.6.29" 362 | source = "registry+https://github.com/rust-lang/crates.io-index" 363 | checksum = "f162c6dd7b008981e4d40210aca20b4bd0f9b60ca9271061b07f78537722f2e1" 364 | 365 | [[package]] 366 | name = "rust-zh-faq" 367 | version = "0.1.0" 368 | dependencies = [ 369 | "anyhow", 370 | "glob", 371 | "handlebars", 372 | "once_cell", 373 | "pulldown-cmark", 374 | "serde", 375 | "syntect", 376 | "toml", 377 | "v_htmlescape", 378 | ] 379 | 380 | [[package]] 381 | name = "ryu" 382 | version = "1.0.13" 383 | source = "registry+https://github.com/rust-lang/crates.io-index" 384 | checksum = "f91339c0467de62360649f8d3e185ca8de4224ff281f66000de5eb2a77a79041" 385 | 386 | [[package]] 387 | name = "safemem" 388 | version = "0.3.3" 389 | source = "registry+https://github.com/rust-lang/crates.io-index" 390 | checksum = "ef703b7cb59335eae2eb93ceb664c0eb7ea6bf567079d843e09420219668e072" 391 | 392 | [[package]] 393 | name = "same-file" 394 | version = "1.0.6" 395 | source = "registry+https://github.com/rust-lang/crates.io-index" 396 | checksum = "93fc1dc3aaa9bfed95e02e6eadabb4baf7e3078b0bd1b4d7b6b0b68378900502" 397 | dependencies = [ 398 | "winapi-util", 399 | ] 400 | 401 | [[package]] 402 | name = "serde" 403 | version = "1.0.163" 404 | source = "registry+https://github.com/rust-lang/crates.io-index" 405 | checksum = "2113ab51b87a539ae008b5c6c02dc020ffa39afd2d83cffcb3f4eb2722cebec2" 406 | dependencies = [ 407 | "serde_derive", 408 | ] 409 | 410 | [[package]] 411 | name = "serde_derive" 412 | version = "1.0.163" 413 | source = "registry+https://github.com/rust-lang/crates.io-index" 414 | checksum = "8c805777e3930c8883389c602315a24224bcc738b63905ef87cd1420353ea93e" 415 | dependencies = [ 416 | "proc-macro2", 417 | "quote", 418 | "syn", 419 | ] 420 | 421 | [[package]] 422 | name = "serde_json" 423 | version = "1.0.96" 424 | source = "registry+https://github.com/rust-lang/crates.io-index" 425 | checksum = "057d394a50403bcac12672b2b18fb387ab6d289d957dab67dd201875391e52f1" 426 | dependencies = [ 427 | "itoa", 428 | "ryu", 429 | "serde", 430 | ] 431 | 432 | [[package]] 433 | name = "serde_spanned" 434 | version = "0.6.2" 435 | source = "registry+https://github.com/rust-lang/crates.io-index" 436 | checksum = "93107647184f6027e3b7dcb2e11034cf95ffa1e3a682c67951963ac69c1c007d" 437 | dependencies = [ 438 | "serde", 439 | ] 440 | 441 | [[package]] 442 | name = "sha2" 443 | version = "0.10.6" 444 | source = "registry+https://github.com/rust-lang/crates.io-index" 445 | checksum = "82e6b795fe2e3b1e845bafcb27aa35405c4d47cdfc92af5fc8d3002f76cebdc0" 446 | dependencies = [ 447 | "cfg-if", 448 | "cpufeatures", 449 | "digest", 450 | ] 451 | 452 | [[package]] 453 | name = "syn" 454 | version = "2.0.18" 455 | source = "registry+https://github.com/rust-lang/crates.io-index" 456 | checksum = "32d41677bcbe24c20c52e7c70b0d8db04134c5d1066bf98662e2871ad200ea3e" 457 | dependencies = [ 458 | "proc-macro2", 459 | "quote", 460 | "unicode-ident", 461 | ] 462 | 463 | [[package]] 464 | name = "syntect" 465 | version = "5.0.0" 466 | source = "registry+https://github.com/rust-lang/crates.io-index" 467 | checksum = "c6c454c27d9d7d9a84c7803aaa3c50cd088d2906fe3c6e42da3209aa623576a8" 468 | dependencies = [ 469 | "bincode", 470 | "bitflags", 471 | "flate2", 472 | "fnv", 473 | "lazy_static", 474 | "once_cell", 475 | "onig", 476 | "plist", 477 | "regex-syntax", 478 | "serde", 479 | "serde_derive", 480 | "serde_json", 481 | "thiserror", 482 | "walkdir", 483 | "yaml-rust", 484 | ] 485 | 486 | [[package]] 487 | name = "thiserror" 488 | version = "1.0.40" 489 | source = "registry+https://github.com/rust-lang/crates.io-index" 490 | checksum = "978c9a314bd8dc99be594bc3c175faaa9794be04a5a5e153caba6915336cebac" 491 | dependencies = [ 492 | "thiserror-impl", 493 | ] 494 | 495 | [[package]] 496 | name = "thiserror-impl" 497 | version = "1.0.40" 498 | source = "registry+https://github.com/rust-lang/crates.io-index" 499 | checksum = "f9456a42c5b0d803c8cd86e73dd7cc9edd429499f37a3550d286d5e86720569f" 500 | dependencies = [ 501 | "proc-macro2", 502 | "quote", 503 | "syn", 504 | ] 505 | 506 | [[package]] 507 | name = "time" 508 | version = "0.3.21" 509 | source = "registry+https://github.com/rust-lang/crates.io-index" 510 | checksum = "8f3403384eaacbca9923fa06940178ac13e4edb725486d70e8e15881d0c836cc" 511 | dependencies = [ 512 | "itoa", 513 | "serde", 514 | "time-core", 515 | "time-macros", 516 | ] 517 | 518 | [[package]] 519 | name = "time-core" 520 | version = "0.1.1" 521 | source = "registry+https://github.com/rust-lang/crates.io-index" 522 | checksum = "7300fbefb4dadc1af235a9cef3737cea692a9d97e1b9cbcd4ebdae6f8868e6fb" 523 | 524 | [[package]] 525 | name = "time-macros" 526 | version = "0.2.9" 527 | source = "registry+https://github.com/rust-lang/crates.io-index" 528 | checksum = "372950940a5f07bf38dbe211d7283c9e6d7327df53794992d293e534c733d09b" 529 | dependencies = [ 530 | "time-core", 531 | ] 532 | 533 | [[package]] 534 | name = "toml" 535 | version = "0.7.4" 536 | source = "registry+https://github.com/rust-lang/crates.io-index" 537 | checksum = "d6135d499e69981f9ff0ef2167955a5333c35e36f6937d382974566b3d5b94ec" 538 | dependencies = [ 539 | "serde", 540 | "serde_spanned", 541 | "toml_datetime", 542 | "toml_edit", 543 | ] 544 | 545 | [[package]] 546 | name = "toml_datetime" 547 | version = "0.6.2" 548 | source = "registry+https://github.com/rust-lang/crates.io-index" 549 | checksum = "5a76a9312f5ba4c2dec6b9161fdf25d87ad8a09256ccea5a556fef03c706a10f" 550 | dependencies = [ 551 | "serde", 552 | ] 553 | 554 | [[package]] 555 | name = "toml_edit" 556 | version = "0.19.10" 557 | source = "registry+https://github.com/rust-lang/crates.io-index" 558 | checksum = "2380d56e8670370eee6566b0bfd4265f65b3f432e8c6d85623f728d4fa31f739" 559 | dependencies = [ 560 | "indexmap", 561 | "serde", 562 | "serde_spanned", 563 | "toml_datetime", 564 | "winnow", 565 | ] 566 | 567 | [[package]] 568 | name = "typenum" 569 | version = "1.16.0" 570 | source = "registry+https://github.com/rust-lang/crates.io-index" 571 | checksum = "497961ef93d974e23eb6f433eb5fe1b7930b659f06d12dec6fc44a8f554c0bba" 572 | 573 | [[package]] 574 | name = "ucd-trie" 575 | version = "0.1.5" 576 | source = "registry+https://github.com/rust-lang/crates.io-index" 577 | checksum = "9e79c4d996edb816c91e4308506774452e55e95c3c9de07b6729e17e15a5ef81" 578 | 579 | [[package]] 580 | name = "unicase" 581 | version = "2.6.0" 582 | source = "registry+https://github.com/rust-lang/crates.io-index" 583 | checksum = "50f37be617794602aabbeee0be4f259dc1778fabe05e2d67ee8f79326d5cb4f6" 584 | dependencies = [ 585 | "version_check", 586 | ] 587 | 588 | [[package]] 589 | name = "unicode-ident" 590 | version = "1.0.9" 591 | source = "registry+https://github.com/rust-lang/crates.io-index" 592 | checksum = "b15811caf2415fb889178633e7724bad2509101cde276048e013b9def5e51fa0" 593 | 594 | [[package]] 595 | name = "unicode-width" 596 | version = "0.1.10" 597 | source = "registry+https://github.com/rust-lang/crates.io-index" 598 | checksum = "c0edd1e5b14653f783770bce4a4dabb4a5108a5370a5f5d8cfe8710c361f6c8b" 599 | 600 | [[package]] 601 | name = "v_htmlescape" 602 | version = "0.15.8" 603 | source = "registry+https://github.com/rust-lang/crates.io-index" 604 | checksum = "4e8257fbc510f0a46eb602c10215901938b5c2a7d5e70fc11483b1d3c9b5b18c" 605 | 606 | [[package]] 607 | name = "version_check" 608 | version = "0.9.4" 609 | source = "registry+https://github.com/rust-lang/crates.io-index" 610 | checksum = "49874b5167b65d7193b8aba1567f5c7d93d001cafc34600cee003eda787e483f" 611 | 612 | [[package]] 613 | name = "walkdir" 614 | version = "2.3.3" 615 | source = "registry+https://github.com/rust-lang/crates.io-index" 616 | checksum = "36df944cda56c7d8d8b7496af378e6b16de9284591917d307c9b4d313c44e698" 617 | dependencies = [ 618 | "same-file", 619 | "winapi-util", 620 | ] 621 | 622 | [[package]] 623 | name = "winapi" 624 | version = "0.3.9" 625 | source = "registry+https://github.com/rust-lang/crates.io-index" 626 | checksum = "5c839a674fcd7a98952e593242ea400abe93992746761e38641405d28b00f419" 627 | dependencies = [ 628 | "winapi-i686-pc-windows-gnu", 629 | "winapi-x86_64-pc-windows-gnu", 630 | ] 631 | 632 | [[package]] 633 | name = "winapi-i686-pc-windows-gnu" 634 | version = "0.4.0" 635 | source = "registry+https://github.com/rust-lang/crates.io-index" 636 | checksum = "ac3b87c63620426dd9b991e5ce0329eff545bccbbb34f3be09ff6fb6ab51b7b6" 637 | 638 | [[package]] 639 | name = "winapi-util" 640 | version = "0.1.5" 641 | source = "registry+https://github.com/rust-lang/crates.io-index" 642 | checksum = "70ec6ce85bb158151cae5e5c87f95a8e97d2c0c4b001223f33a334e3ce5de178" 643 | dependencies = [ 644 | "winapi", 645 | ] 646 | 647 | [[package]] 648 | name = "winapi-x86_64-pc-windows-gnu" 649 | version = "0.4.0" 650 | source = "registry+https://github.com/rust-lang/crates.io-index" 651 | checksum = "712e227841d057c1ee1cd2fb22fa7e5a5461ae8e48fa2ca79ec42cfc1931183f" 652 | 653 | [[package]] 654 | name = "winnow" 655 | version = "0.4.6" 656 | source = "registry+https://github.com/rust-lang/crates.io-index" 657 | checksum = "61de7bac303dc551fe038e2b3cef0f571087a47571ea6e79a87692ac99b99699" 658 | dependencies = [ 659 | "memchr", 660 | ] 661 | 662 | [[package]] 663 | name = "yaml-rust" 664 | version = "0.4.5" 665 | source = "registry+https://github.com/rust-lang/crates.io-index" 666 | checksum = "56c1936c4cc7a1c9ab21a1ebb602eb942ba868cbd44a99cb7cdc5892335e1c85" 667 | dependencies = [ 668 | "linked-hash-map", 669 | ] 670 | -------------------------------------------------------------------------------- /Cargo.toml: -------------------------------------------------------------------------------- 1 | [package] 2 | name = "rust-zh-faq" 3 | version = "0.1.0" 4 | authors = ["Xidorn Quan "] 5 | edition = "2021" 6 | license = "GPL-3.0-only" 7 | publish = false 8 | 9 | [dependencies] 10 | anyhow = "1.0.32" 11 | glob = "0.3.0" 12 | handlebars = "4.0.1" 13 | pulldown-cmark = "0.9" 14 | serde = { version = "1.0.115", features = ["derive"] } 15 | v_htmlescape = "0.15" 16 | syntect = "5" 17 | once_cell = "1.4.1" 18 | toml = "0.7" 19 | -------------------------------------------------------------------------------- /LICENSE: -------------------------------------------------------------------------------- 1 | GNU GENERAL PUBLIC LICENSE 2 | Version 3, 29 June 2007 3 | 4 | Copyright (C) 2007 Free Software Foundation, Inc. 5 | Everyone is permitted to copy and distribute verbatim copies 6 | of this license document, but changing it is not allowed. 7 | 8 | Preamble 9 | 10 | The GNU General Public License is a free, copyleft license for 11 | software and other kinds of works. 12 | 13 | The licenses for most software and other practical works are designed 14 | to take away your freedom to share and change the works. By contrast, 15 | the GNU General Public License is intended to guarantee your freedom to 16 | share and change all versions of a program--to make sure it remains free 17 | software for all its users. We, the Free Software Foundation, use the 18 | GNU General Public License for most of our software; it applies also to 19 | any other work released this way by its authors. You can apply it to 20 | your programs, too. 21 | 22 | When we speak of free software, we are referring to freedom, not 23 | price. Our General Public Licenses are designed to make sure that you 24 | have the freedom to distribute copies of free software (and charge for 25 | them if you wish), that you receive source code or can get it if you 26 | want it, that you can change the software or use pieces of it in new 27 | free programs, and that you know you can do these things. 28 | 29 | To protect your rights, we need to prevent others from denying you 30 | these rights or asking you to surrender the rights. Therefore, you have 31 | certain responsibilities if you distribute copies of the software, or if 32 | you modify it: responsibilities to respect the freedom of others. 33 | 34 | For example, if you distribute copies of such a program, whether 35 | gratis or for a fee, you must pass on to the recipients the same 36 | freedoms that you received. You must make sure that they, too, receive 37 | or can get the source code. And you must show them these terms so they 38 | know their rights. 39 | 40 | Developers that use the GNU GPL protect your rights with two steps: 41 | (1) assert copyright on the software, and (2) offer you this License 42 | giving you legal permission to copy, distribute and/or modify it. 43 | 44 | For the developers' and authors' protection, the GPL clearly explains 45 | that there is no warranty for this free software. For both users' and 46 | authors' sake, the GPL requires that modified versions be marked as 47 | changed, so that their problems will not be attributed erroneously to 48 | authors of previous versions. 49 | 50 | Some devices are designed to deny users access to install or run 51 | modified versions of the software inside them, although the manufacturer 52 | can do so. This is fundamentally incompatible with the aim of 53 | protecting users' freedom to change the software. The systematic 54 | pattern of such abuse occurs in the area of products for individuals to 55 | use, which is precisely where it is most unacceptable. Therefore, we 56 | have designed this version of the GPL to prohibit the practice for those 57 | products. If such problems arise substantially in other domains, we 58 | stand ready to extend this provision to those domains in future versions 59 | of the GPL, as needed to protect the freedom of users. 60 | 61 | Finally, every program is threatened constantly by software patents. 62 | States should not allow patents to restrict development and use of 63 | software on general-purpose computers, but in those that do, we wish to 64 | avoid the special danger that patents applied to a free program could 65 | make it effectively proprietary. To prevent this, the GPL assures that 66 | patents cannot be used to render the program non-free. 67 | 68 | The precise terms and conditions for copying, distribution and 69 | modification follow. 70 | 71 | TERMS AND CONDITIONS 72 | 73 | 0. Definitions. 74 | 75 | "This License" refers to version 3 of the GNU General Public License. 76 | 77 | "Copyright" also means copyright-like laws that apply to other kinds of 78 | works, such as semiconductor masks. 79 | 80 | "The Program" refers to any copyrightable work licensed under this 81 | License. Each licensee is addressed as "you". "Licensees" and 82 | "recipients" may be individuals or organizations. 83 | 84 | To "modify" a work means to copy from or adapt all or part of the work 85 | in a fashion requiring copyright permission, other than the making of an 86 | exact copy. The resulting work is called a "modified version" of the 87 | earlier work or a work "based on" the earlier work. 88 | 89 | A "covered work" means either the unmodified Program or a work based 90 | on the Program. 91 | 92 | To "propagate" a work means to do anything with it that, without 93 | permission, would make you directly or secondarily liable for 94 | infringement under applicable copyright law, except executing it on a 95 | computer or modifying a private copy. Propagation includes copying, 96 | distribution (with or without modification), making available to the 97 | public, and in some countries other activities as well. 98 | 99 | To "convey" a work means any kind of propagation that enables other 100 | parties to make or receive copies. Mere interaction with a user through 101 | a computer network, with no transfer of a copy, is not conveying. 102 | 103 | An interactive user interface displays "Appropriate Legal Notices" 104 | to the extent that it includes a convenient and prominently visible 105 | feature that (1) displays an appropriate copyright notice, and (2) 106 | tells the user that there is no warranty for the work (except to the 107 | extent that warranties are provided), that licensees may convey the 108 | work under this License, and how to view a copy of this License. If 109 | the interface presents a list of user commands or options, such as a 110 | menu, a prominent item in the list meets this criterion. 111 | 112 | 1. Source Code. 113 | 114 | The "source code" for a work means the preferred form of the work 115 | for making modifications to it. "Object code" means any non-source 116 | form of a work. 117 | 118 | A "Standard Interface" means an interface that either is an official 119 | standard defined by a recognized standards body, or, in the case of 120 | interfaces specified for a particular programming language, one that 121 | is widely used among developers working in that language. 122 | 123 | The "System Libraries" of an executable work include anything, other 124 | than the work as a whole, that (a) is included in the normal form of 125 | packaging a Major Component, but which is not part of that Major 126 | Component, and (b) serves only to enable use of the work with that 127 | Major Component, or to implement a Standard Interface for which an 128 | implementation is available to the public in source code form. A 129 | "Major Component", in this context, means a major essential component 130 | (kernel, window system, and so on) of the specific operating system 131 | (if any) on which the executable work runs, or a compiler used to 132 | produce the work, or an object code interpreter used to run it. 133 | 134 | The "Corresponding Source" for a work in object code form means all 135 | the source code needed to generate, install, and (for an executable 136 | work) run the object code and to modify the work, including scripts to 137 | control those activities. However, it does not include the work's 138 | System Libraries, or general-purpose tools or generally available free 139 | programs which are used unmodified in performing those activities but 140 | which are not part of the work. For example, Corresponding Source 141 | includes interface definition files associated with source files for 142 | the work, and the source code for shared libraries and dynamically 143 | linked subprograms that the work is specifically designed to require, 144 | such as by intimate data communication or control flow between those 145 | subprograms and other parts of the work. 146 | 147 | The Corresponding Source need not include anything that users 148 | can regenerate automatically from other parts of the Corresponding 149 | Source. 150 | 151 | The Corresponding Source for a work in source code form is that 152 | same work. 153 | 154 | 2. Basic Permissions. 155 | 156 | All rights granted under this License are granted for the term of 157 | copyright on the Program, and are irrevocable provided the stated 158 | conditions are met. This License explicitly affirms your unlimited 159 | permission to run the unmodified Program. The output from running a 160 | covered work is covered by this License only if the output, given its 161 | content, constitutes a covered work. This License acknowledges your 162 | rights of fair use or other equivalent, as provided by copyright law. 163 | 164 | You may make, run and propagate covered works that you do not 165 | convey, without conditions so long as your license otherwise remains 166 | in force. You may convey covered works to others for the sole purpose 167 | of having them make modifications exclusively for you, or provide you 168 | with facilities for running those works, provided that you comply with 169 | the terms of this License in conveying all material for which you do 170 | not control copyright. Those thus making or running the covered works 171 | for you must do so exclusively on your behalf, under your direction 172 | and control, on terms that prohibit them from making any copies of 173 | your copyrighted material outside their relationship with you. 174 | 175 | Conveying under any other circumstances is permitted solely under 176 | the conditions stated below. Sublicensing is not allowed; section 10 177 | makes it unnecessary. 178 | 179 | 3. Protecting Users' Legal Rights From Anti-Circumvention Law. 180 | 181 | No covered work shall be deemed part of an effective technological 182 | measure under any applicable law fulfilling obligations under article 183 | 11 of the WIPO copyright treaty adopted on 20 December 1996, or 184 | similar laws prohibiting or restricting circumvention of such 185 | measures. 186 | 187 | When you convey a covered work, you waive any legal power to forbid 188 | circumvention of technological measures to the extent such circumvention 189 | is effected by exercising rights under this License with respect to 190 | the covered work, and you disclaim any intention to limit operation or 191 | modification of the work as a means of enforcing, against the work's 192 | users, your or third parties' legal rights to forbid circumvention of 193 | technological measures. 194 | 195 | 4. Conveying Verbatim Copies. 196 | 197 | You may convey verbatim copies of the Program's source code as you 198 | receive it, in any medium, provided that you conspicuously and 199 | appropriately publish on each copy an appropriate copyright notice; 200 | keep intact all notices stating that this License and any 201 | non-permissive terms added in accord with section 7 apply to the code; 202 | keep intact all notices of the absence of any warranty; and give all 203 | recipients a copy of this License along with the Program. 204 | 205 | You may charge any price or no price for each copy that you convey, 206 | and you may offer support or warranty protection for a fee. 207 | 208 | 5. Conveying Modified Source Versions. 209 | 210 | You may convey a work based on the Program, or the modifications to 211 | produce it from the Program, in the form of source code under the 212 | terms of section 4, provided that you also meet all of these conditions: 213 | 214 | a) The work must carry prominent notices stating that you modified 215 | it, and giving a relevant date. 216 | 217 | b) The work must carry prominent notices stating that it is 218 | released under this License and any conditions added under section 219 | 7. This requirement modifies the requirement in section 4 to 220 | "keep intact all notices". 221 | 222 | c) You must license the entire work, as a whole, under this 223 | License to anyone who comes into possession of a copy. This 224 | License will therefore apply, along with any applicable section 7 225 | additional terms, to the whole of the work, and all its parts, 226 | regardless of how they are packaged. This License gives no 227 | permission to license the work in any other way, but it does not 228 | invalidate such permission if you have separately received it. 229 | 230 | d) If the work has interactive user interfaces, each must display 231 | Appropriate Legal Notices; however, if the Program has interactive 232 | interfaces that do not display Appropriate Legal Notices, your 233 | work need not make them do so. 234 | 235 | A compilation of a covered work with other separate and independent 236 | works, which are not by their nature extensions of the covered work, 237 | and which are not combined with it such as to form a larger program, 238 | in or on a volume of a storage or distribution medium, is called an 239 | "aggregate" if the compilation and its resulting copyright are not 240 | used to limit the access or legal rights of the compilation's users 241 | beyond what the individual works permit. Inclusion of a covered work 242 | in an aggregate does not cause this License to apply to the other 243 | parts of the aggregate. 244 | 245 | 6. Conveying Non-Source Forms. 246 | 247 | You may convey a covered work in object code form under the terms 248 | of sections 4 and 5, provided that you also convey the 249 | machine-readable Corresponding Source under the terms of this License, 250 | in one of these ways: 251 | 252 | a) Convey the object code in, or embodied in, a physical product 253 | (including a physical distribution medium), accompanied by the 254 | Corresponding Source fixed on a durable physical medium 255 | customarily used for software interchange. 256 | 257 | b) Convey the object code in, or embodied in, a physical product 258 | (including a physical distribution medium), accompanied by a 259 | written offer, valid for at least three years and valid for as 260 | long as you offer spare parts or customer support for that product 261 | model, to give anyone who possesses the object code either (1) a 262 | copy of the Corresponding Source for all the software in the 263 | product that is covered by this License, on a durable physical 264 | medium customarily used for software interchange, for a price no 265 | more than your reasonable cost of physically performing this 266 | conveying of source, or (2) access to copy the 267 | Corresponding Source from a network server at no charge. 268 | 269 | c) Convey individual copies of the object code with a copy of the 270 | written offer to provide the Corresponding Source. This 271 | alternative is allowed only occasionally and noncommercially, and 272 | only if you received the object code with such an offer, in accord 273 | with subsection 6b. 274 | 275 | d) Convey the object code by offering access from a designated 276 | place (gratis or for a charge), and offer equivalent access to the 277 | Corresponding Source in the same way through the same place at no 278 | further charge. You need not require recipients to copy the 279 | Corresponding Source along with the object code. If the place to 280 | copy the object code is a network server, the Corresponding Source 281 | may be on a different server (operated by you or a third party) 282 | that supports equivalent copying facilities, provided you maintain 283 | clear directions next to the object code saying where to find the 284 | Corresponding Source. Regardless of what server hosts the 285 | Corresponding Source, you remain obligated to ensure that it is 286 | available for as long as needed to satisfy these requirements. 287 | 288 | e) Convey the object code using peer-to-peer transmission, provided 289 | you inform other peers where the object code and Corresponding 290 | Source of the work are being offered to the general public at no 291 | charge under subsection 6d. 292 | 293 | A separable portion of the object code, whose source code is excluded 294 | from the Corresponding Source as a System Library, need not be 295 | included in conveying the object code work. 296 | 297 | A "User Product" is either (1) a "consumer product", which means any 298 | tangible personal property which is normally used for personal, family, 299 | or household purposes, or (2) anything designed or sold for incorporation 300 | into a dwelling. In determining whether a product is a consumer product, 301 | doubtful cases shall be resolved in favor of coverage. For a particular 302 | product received by a particular user, "normally used" refers to a 303 | typical or common use of that class of product, regardless of the status 304 | of the particular user or of the way in which the particular user 305 | actually uses, or expects or is expected to use, the product. A product 306 | is a consumer product regardless of whether the product has substantial 307 | commercial, industrial or non-consumer uses, unless such uses represent 308 | the only significant mode of use of the product. 309 | 310 | "Installation Information" for a User Product means any methods, 311 | procedures, authorization keys, or other information required to install 312 | and execute modified versions of a covered work in that User Product from 313 | a modified version of its Corresponding Source. The information must 314 | suffice to ensure that the continued functioning of the modified object 315 | code is in no case prevented or interfered with solely because 316 | modification has been made. 317 | 318 | If you convey an object code work under this section in, or with, or 319 | specifically for use in, a User Product, and the conveying occurs as 320 | part of a transaction in which the right of possession and use of the 321 | User Product is transferred to the recipient in perpetuity or for a 322 | fixed term (regardless of how the transaction is characterized), the 323 | Corresponding Source conveyed under this section must be accompanied 324 | by the Installation Information. But this requirement does not apply 325 | if neither you nor any third party retains the ability to install 326 | modified object code on the User Product (for example, the work has 327 | been installed in ROM). 328 | 329 | The requirement to provide Installation Information does not include a 330 | requirement to continue to provide support service, warranty, or updates 331 | for a work that has been modified or installed by the recipient, or for 332 | the User Product in which it has been modified or installed. Access to a 333 | network may be denied when the modification itself materially and 334 | adversely affects the operation of the network or violates the rules and 335 | protocols for communication across the network. 336 | 337 | Corresponding Source conveyed, and Installation Information provided, 338 | in accord with this section must be in a format that is publicly 339 | documented (and with an implementation available to the public in 340 | source code form), and must require no special password or key for 341 | unpacking, reading or copying. 342 | 343 | 7. Additional Terms. 344 | 345 | "Additional permissions" are terms that supplement the terms of this 346 | License by making exceptions from one or more of its conditions. 347 | Additional permissions that are applicable to the entire Program shall 348 | be treated as though they were included in this License, to the extent 349 | that they are valid under applicable law. If additional permissions 350 | apply only to part of the Program, that part may be used separately 351 | under those permissions, but the entire Program remains governed by 352 | this License without regard to the additional permissions. 353 | 354 | When you convey a copy of a covered work, you may at your option 355 | remove any additional permissions from that copy, or from any part of 356 | it. (Additional permissions may be written to require their own 357 | removal in certain cases when you modify the work.) You may place 358 | additional permissions on material, added by you to a covered work, 359 | for which you have or can give appropriate copyright permission. 360 | 361 | Notwithstanding any other provision of this License, for material you 362 | add to a covered work, you may (if authorized by the copyright holders of 363 | that material) supplement the terms of this License with terms: 364 | 365 | a) Disclaiming warranty or limiting liability differently from the 366 | terms of sections 15 and 16 of this License; or 367 | 368 | b) Requiring preservation of specified reasonable legal notices or 369 | author attributions in that material or in the Appropriate Legal 370 | Notices displayed by works containing it; or 371 | 372 | c) Prohibiting misrepresentation of the origin of that material, or 373 | requiring that modified versions of such material be marked in 374 | reasonable ways as different from the original version; or 375 | 376 | d) Limiting the use for publicity purposes of names of licensors or 377 | authors of the material; or 378 | 379 | e) Declining to grant rights under trademark law for use of some 380 | trade names, trademarks, or service marks; or 381 | 382 | f) Requiring indemnification of licensors and authors of that 383 | material by anyone who conveys the material (or modified versions of 384 | it) with contractual assumptions of liability to the recipient, for 385 | any liability that these contractual assumptions directly impose on 386 | those licensors and authors. 387 | 388 | All other non-permissive additional terms are considered "further 389 | restrictions" within the meaning of section 10. If the Program as you 390 | received it, or any part of it, contains a notice stating that it is 391 | governed by this License along with a term that is a further 392 | restriction, you may remove that term. If a license document contains 393 | a further restriction but permits relicensing or conveying under this 394 | License, you may add to a covered work material governed by the terms 395 | of that license document, provided that the further restriction does 396 | not survive such relicensing or conveying. 397 | 398 | If you add terms to a covered work in accord with this section, you 399 | must place, in the relevant source files, a statement of the 400 | additional terms that apply to those files, or a notice indicating 401 | where to find the applicable terms. 402 | 403 | Additional terms, permissive or non-permissive, may be stated in the 404 | form of a separately written license, or stated as exceptions; 405 | the above requirements apply either way. 406 | 407 | 8. Termination. 408 | 409 | You may not propagate or modify a covered work except as expressly 410 | provided under this License. Any attempt otherwise to propagate or 411 | modify it is void, and will automatically terminate your rights under 412 | this License (including any patent licenses granted under the third 413 | paragraph of section 11). 414 | 415 | However, if you cease all violation of this License, then your 416 | license from a particular copyright holder is reinstated (a) 417 | provisionally, unless and until the copyright holder explicitly and 418 | finally terminates your license, and (b) permanently, if the copyright 419 | holder fails to notify you of the violation by some reasonable means 420 | prior to 60 days after the cessation. 421 | 422 | Moreover, your license from a particular copyright holder is 423 | reinstated permanently if the copyright holder notifies you of the 424 | violation by some reasonable means, this is the first time you have 425 | received notice of violation of this License (for any work) from that 426 | copyright holder, and you cure the violation prior to 30 days after 427 | your receipt of the notice. 428 | 429 | Termination of your rights under this section does not terminate the 430 | licenses of parties who have received copies or rights from you under 431 | this License. If your rights have been terminated and not permanently 432 | reinstated, you do not qualify to receive new licenses for the same 433 | material under section 10. 434 | 435 | 9. Acceptance Not Required for Having Copies. 436 | 437 | You are not required to accept this License in order to receive or 438 | run a copy of the Program. Ancillary propagation of a covered work 439 | occurring solely as a consequence of using peer-to-peer transmission 440 | to receive a copy likewise does not require acceptance. However, 441 | nothing other than this License grants you permission to propagate or 442 | modify any covered work. These actions infringe copyright if you do 443 | not accept this License. Therefore, by modifying or propagating a 444 | covered work, you indicate your acceptance of this License to do so. 445 | 446 | 10. Automatic Licensing of Downstream Recipients. 447 | 448 | Each time you convey a covered work, the recipient automatically 449 | receives a license from the original licensors, to run, modify and 450 | propagate that work, subject to this License. You are not responsible 451 | for enforcing compliance by third parties with this License. 452 | 453 | An "entity transaction" is a transaction transferring control of an 454 | organization, or substantially all assets of one, or subdividing an 455 | organization, or merging organizations. If propagation of a covered 456 | work results from an entity transaction, each party to that 457 | transaction who receives a copy of the work also receives whatever 458 | licenses to the work the party's predecessor in interest had or could 459 | give under the previous paragraph, plus a right to possession of the 460 | Corresponding Source of the work from the predecessor in interest, if 461 | the predecessor has it or can get it with reasonable efforts. 462 | 463 | You may not impose any further restrictions on the exercise of the 464 | rights granted or affirmed under this License. For example, you may 465 | not impose a license fee, royalty, or other charge for exercise of 466 | rights granted under this License, and you may not initiate litigation 467 | (including a cross-claim or counterclaim in a lawsuit) alleging that 468 | any patent claim is infringed by making, using, selling, offering for 469 | sale, or importing the Program or any portion of it. 470 | 471 | 11. Patents. 472 | 473 | A "contributor" is a copyright holder who authorizes use under this 474 | License of the Program or a work on which the Program is based. The 475 | work thus licensed is called the contributor's "contributor version". 476 | 477 | A contributor's "essential patent claims" are all patent claims 478 | owned or controlled by the contributor, whether already acquired or 479 | hereafter acquired, that would be infringed by some manner, permitted 480 | by this License, of making, using, or selling its contributor version, 481 | but do not include claims that would be infringed only as a 482 | consequence of further modification of the contributor version. For 483 | purposes of this definition, "control" includes the right to grant 484 | patent sublicenses in a manner consistent with the requirements of 485 | this License. 486 | 487 | Each contributor grants you a non-exclusive, worldwide, royalty-free 488 | patent license under the contributor's essential patent claims, to 489 | make, use, sell, offer for sale, import and otherwise run, modify and 490 | propagate the contents of its contributor version. 491 | 492 | In the following three paragraphs, a "patent license" is any express 493 | agreement or commitment, however denominated, not to enforce a patent 494 | (such as an express permission to practice a patent or covenant not to 495 | sue for patent infringement). To "grant" such a patent license to a 496 | party means to make such an agreement or commitment not to enforce a 497 | patent against the party. 498 | 499 | If you convey a covered work, knowingly relying on a patent license, 500 | and the Corresponding Source of the work is not available for anyone 501 | to copy, free of charge and under the terms of this License, through a 502 | publicly available network server or other readily accessible means, 503 | then you must either (1) cause the Corresponding Source to be so 504 | available, or (2) arrange to deprive yourself of the benefit of the 505 | patent license for this particular work, or (3) arrange, in a manner 506 | consistent with the requirements of this License, to extend the patent 507 | license to downstream recipients. "Knowingly relying" means you have 508 | actual knowledge that, but for the patent license, your conveying the 509 | covered work in a country, or your recipient's use of the covered work 510 | in a country, would infringe one or more identifiable patents in that 511 | country that you have reason to believe are valid. 512 | 513 | If, pursuant to or in connection with a single transaction or 514 | arrangement, you convey, or propagate by procuring conveyance of, a 515 | covered work, and grant a patent license to some of the parties 516 | receiving the covered work authorizing them to use, propagate, modify 517 | or convey a specific copy of the covered work, then the patent license 518 | you grant is automatically extended to all recipients of the covered 519 | work and works based on it. 520 | 521 | A patent license is "discriminatory" if it does not include within 522 | the scope of its coverage, prohibits the exercise of, or is 523 | conditioned on the non-exercise of one or more of the rights that are 524 | specifically granted under this License. You may not convey a covered 525 | work if you are a party to an arrangement with a third party that is 526 | in the business of distributing software, under which you make payment 527 | to the third party based on the extent of your activity of conveying 528 | the work, and under which the third party grants, to any of the 529 | parties who would receive the covered work from you, a discriminatory 530 | patent license (a) in connection with copies of the covered work 531 | conveyed by you (or copies made from those copies), or (b) primarily 532 | for and in connection with specific products or compilations that 533 | contain the covered work, unless you entered into that arrangement, 534 | or that patent license was granted, prior to 28 March 2007. 535 | 536 | Nothing in this License shall be construed as excluding or limiting 537 | any implied license or other defenses to infringement that may 538 | otherwise be available to you under applicable patent law. 539 | 540 | 12. No Surrender of Others' Freedom. 541 | 542 | If conditions are imposed on you (whether by court order, agreement or 543 | otherwise) that contradict the conditions of this License, they do not 544 | excuse you from the conditions of this License. If you cannot convey a 545 | covered work so as to satisfy simultaneously your obligations under this 546 | License and any other pertinent obligations, then as a consequence you may 547 | not convey it at all. For example, if you agree to terms that obligate you 548 | to collect a royalty for further conveying from those to whom you convey 549 | the Program, the only way you could satisfy both those terms and this 550 | License would be to refrain entirely from conveying the Program. 551 | 552 | 13. Use with the GNU Affero General Public License. 553 | 554 | Notwithstanding any other provision of this License, you have 555 | permission to link or combine any covered work with a work licensed 556 | under version 3 of the GNU Affero General Public License into a single 557 | combined work, and to convey the resulting work. The terms of this 558 | License will continue to apply to the part which is the covered work, 559 | but the special requirements of the GNU Affero General Public License, 560 | section 13, concerning interaction through a network will apply to the 561 | combination as such. 562 | 563 | 14. Revised Versions of this License. 564 | 565 | The Free Software Foundation may publish revised and/or new versions of 566 | the GNU General Public License from time to time. Such new versions will 567 | be similar in spirit to the present version, but may differ in detail to 568 | address new problems or concerns. 569 | 570 | Each version is given a distinguishing version number. If the 571 | Program specifies that a certain numbered version of the GNU General 572 | Public License "or any later version" applies to it, you have the 573 | option of following the terms and conditions either of that numbered 574 | version or of any later version published by the Free Software 575 | Foundation. If the Program does not specify a version number of the 576 | GNU General Public License, you may choose any version ever published 577 | by the Free Software Foundation. 578 | 579 | If the Program specifies that a proxy can decide which future 580 | versions of the GNU General Public License can be used, that proxy's 581 | public statement of acceptance of a version permanently authorizes you 582 | to choose that version for the Program. 583 | 584 | Later license versions may give you additional or different 585 | permissions. However, no additional obligations are imposed on any 586 | author or copyright holder as a result of your choosing to follow a 587 | later version. 588 | 589 | 15. Disclaimer of Warranty. 590 | 591 | THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY 592 | APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT 593 | HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY 594 | OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, 595 | THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR 596 | PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM 597 | IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF 598 | ALL NECESSARY SERVICING, REPAIR OR CORRECTION. 599 | 600 | 16. Limitation of Liability. 601 | 602 | IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING 603 | WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS 604 | THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY 605 | GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE 606 | USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF 607 | DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD 608 | PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), 609 | EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF 610 | SUCH DAMAGES. 611 | 612 | 17. Interpretation of Sections 15 and 16. 613 | 614 | If the disclaimer of warranty and limitation of liability provided 615 | above cannot be given local legal effect according to their terms, 616 | reviewing courts shall apply local law that most closely approximates 617 | an absolute waiver of all civil liability in connection with the 618 | Program, unless a warranty or assumption of liability accompanies a 619 | copy of the Program in return for a fee. 620 | 621 | END OF TERMS AND CONDITIONS 622 | 623 | How to Apply These Terms to Your New Programs 624 | 625 | If you develop a new program, and you want it to be of the greatest 626 | possible use to the public, the best way to achieve this is to make it 627 | free software which everyone can redistribute and change under these terms. 628 | 629 | To do so, attach the following notices to the program. It is safest 630 | to attach them to the start of each source file to most effectively 631 | state the exclusion of warranty; and each file should have at least 632 | the "copyright" line and a pointer to where the full notice is found. 633 | 634 | 635 | Copyright (C) 636 | 637 | This program is free software: you can redistribute it and/or modify 638 | it under the terms of the GNU General Public License as published by 639 | the Free Software Foundation, either version 3 of the License, or 640 | (at your option) any later version. 641 | 642 | This program is distributed in the hope that it will be useful, 643 | but WITHOUT ANY WARRANTY; without even the implied warranty of 644 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 645 | GNU General Public License for more details. 646 | 647 | You should have received a copy of the GNU General Public License 648 | along with this program. If not, see . 649 | 650 | Also add information on how to contact you by electronic and paper mail. 651 | 652 | If the program does terminal interaction, make it output a short 653 | notice like this when it starts in an interactive mode: 654 | 655 | Copyright (C) 656 | This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'. 657 | This is free software, and you are welcome to redistribute it 658 | under certain conditions; type `show c' for details. 659 | 660 | The hypothetical commands `show w' and `show c' should show the appropriate 661 | parts of the General Public License. Of course, your program's commands 662 | might be different; for a GUI interface, you would use an "about box". 663 | 664 | You should also get your employer (if you work as a programmer) or school, 665 | if any, to sign a "copyright disclaimer" for the program, if necessary. 666 | For more information on this, and how to apply and follow the GNU GPL, see 667 | . 668 | 669 | The GNU General Public License does not permit incorporating your program 670 | into proprietary programs. If your program is a subroutine library, you 671 | may consider it more useful to permit linking proprietary applications with 672 | the library. If this is what you want to do, use the GNU Lesser General 673 | Public License instead of this License. But first, please read 674 | . 675 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | # Rust 常见疑问汇总 2 | 3 | 在中文 Telegram 讨论群 [Rust 众][telegram]的讨论中常见疑问及相关解答的汇总。 4 | 5 | ## 贡献 6 | 7 | 本仓库的代码主要是一个 Rust 编写的页面生成器，内容在 `content` 目录中，每个问题一个 Markdown 文件。欢迎贡献。 8 | 9 | ## 授权 10 | 11 | `content` 目录下的内容采用 [CC0] 授权，其他代码采用 [GPLv3] 授权。 12 | 13 | ### GPLv3 14 | 15 | Copyright (C) 2020-2021 Xidorn Quan 16 | 17 | This program is free software: you can redistribute it and/or modify 18 | it under the terms of the GNU General Public License as published by 19 | the Free Software Foundation, version 3. 20 | 21 | This program is distributed in the hope that it will be useful, 22 | but WITHOUT ANY WARRANTY; without even the implied warranty of 23 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 24 | GNU General Public License for more details. 25 | 26 | You should have received a copy of the GNU General Public License 27 | along with this program. If not, see . 28 | 29 | 30 | [telegram]: https://t.me/rust_zh1 31 | [CC0]: https://creativecommons.org/publicdomain/zero/1.0/deed.zh 32 | [GPLv3]: https://www.gnu.org/licenses/gpl-3.0.zh-cn.html 33 | -------------------------------------------------------------------------------- /content/async-fn-in-trait.md: -------------------------------------------------------------------------------- 1 | # 如何在特质里添加异步函数？ 2 | 3 | 目前 Rust 不支持在[特质]里直接添加[异步函数]，但可以使用 [async-trait] 这个库来实现。这个库会将异步函数改写为返回 `Pin>` 的普通函数以绕过目前语言层面的限制，但也因此有堆分配以及[动态分发]这两个额外的代价，所以不会被直接添加到 Rust 语言中。 4 | 5 | 在特质里不支持使用异步函数是由于异步函数本质上是一个返回 `impl Future` 的函数，而目前 Rust 的类型系统还无法表达在特质的方法的返回类型上使用 `impl Trait`。有两个已经通过的 RFC 旨在解决这一问题：[RFC 1598][rfc1598] 泛型关联类型和 [RFC 2071][rfc2071] `impl Trait` [存在类型]，但它们的编译器支持还在实现中，实现进度可以参考 [impl Trait 计划][impl-trait-initiative]的页面。 6 | 7 | 8 | [async-trait]: https://crates.io/crates/async-trait 9 | 10 | [rfc1598]: https://rust-lang.github.io/rfcs/1598-generic_associated_types.html 11 | [rfc2071]: https://rust-lang.github.io/rfcs/2071-impl-trait-existential-types.html 12 | [impl-trait-initiative]: https://rust-lang.github.io/impl-trait-initiative/ 13 | -------------------------------------------------------------------------------- /content/await-multiple-futures.md: -------------------------------------------------------------------------------- 1 | # 如何同时等待多个 `Future`？ 2 | 3 | 如果想要等待多个 `Future` 都完成后返回，对于固定数量的 `Future` 可以使用 [futures] 所提供的 [`join`][join]、[`join3`][join3]、[`join4`][join4] 等函数，或者 [tokio] 所提供的 [`join!`][join-macro] 宏，将多个 `Future` 合并为一个进行等待。对于不定数量的 `Future`，比如有一个 `Vec`，则可以使用 futures 的 [`join_all`][join_all] 函数。 4 | 5 | 若要在数个 `Future` 中第一个错误发生时就返回，则可以使用它们对应的 [`try_join`][try_join]、[`try_join3`][try_join3]、[`try_join4`][try_join4]、[`try_join_all`][try_join_all] 等函数以及 [`try_join!`][try_join-macro] 宏。 6 | 7 | 如果想要在多个 `Future` 中的第一个完成后就返回，可以使用 futures 的 [`select`][select]、[`select_all`][select_all] 和 [`select_ok`][select_ok] 函数或 tokio 的 [`select!`][select-macro] 宏。 8 | 9 | 此外，futures 还提供了 [`FuturesOrdered`][FuturesOrdered] 和 [`FuturesUnordered`][FuturesUnordered] 两个结构，它们将这些 `Future` 聚合成一个 [`Stream`][Stream] 逐个返回里面 `Future` 的结果。其中前者会按照输入的 `Future` 的顺序返回，而后者则是以任意顺序（可以近似看作按照完成顺序）返回。这两个结构额外提供了 `push` 方法来动态插入新的 `Future`，而且它们只会 `poll` 被唤醒的 `Future`，在 `Future` 数量较多时可能更高效。前面提到的 `join_all` 也会在一些情况下会自动使用 `FuturesOrdered` 来优化。 10 | 11 | 12 | [futures]: https://crates.io/crates/futures 13 | [join]: https://docs.rs/futures/0.3/futures/future/fn.join.html 14 | [join3]: https://docs.rs/futures/0.3/futures/future/fn.join3.html 15 | [join4]: https://docs.rs/futures/0.3/futures/future/fn.join4.html 16 | [join_all]: https://docs.rs/futures/0.3/futures/future/fn.join_all.html 17 | [try_join]: https://docs.rs/futures/0.3/futures/future/fn.try_join.html 18 | [try_join3]: https://docs.rs/futures/0.3/futures/future/fn.try_join3.html 19 | [try_join4]: https://docs.rs/futures/0.3/futures/future/fn.try_join4.html 20 | [try_join_all]: https://docs.rs/futures/0.3/futures/future/fn.try_join_all.html 21 | [select]: https://docs.rs/futures/0.3/futures/future/fn.select.html 22 | [select_all]: https://docs.rs/futures/0.3/futures/future/fn.select_all.html 23 | [select_ok]: https://docs.rs/futures/0.3/futures/future/fn.select_ok.html 24 | [FuturesOrdered]: https://docs.rs/futures/0.3/futures/stream/struct.FuturesOrdered.html 25 | [FuturesUnordered]: https://docs.rs/futures/0.3/futures/stream/struct.FuturesUnordered.html 26 | [Stream]: https://docs.rs/futures/0.3/futures/stream/trait.Stream.html 27 | 28 | [tokio]: https://crates.io/crates/tokio 29 | [join-macro]: https://docs.rs/tokio/1/tokio/macro.join.html 30 | [try_join-macro]: https://docs.rs/tokio/1/tokio/macro.try_join.html 31 | [select-macro]: https://docs.rs/tokio/1/tokio/macro.select.html 32 | -------------------------------------------------------------------------------- /content/binary-size.md: -------------------------------------------------------------------------------- 1 | # 为什么 Rust 生成的程序体积比较大？如何最小化程序体积？ 2 | 3 | 有多个因素使得 Rust 在默认情况下有着相对较大的程序体积，包括了[单态化]、调试符号、标准库等。一般来说，Rust 偏向于为性能优化而非更小的体积。 4 | 5 | 通常使用发布模式编译（`--release`），以及（在 Linux 和 macOS 下）使用 `strip` 删除符号信息可以在一定程度上缩小程序体积。更多方法可以参考 [Minimizing Rust Binary Size](https://github.com/johnthagen/min-sized-rust)，对这一问题有较完整的介绍。 6 | -------------------------------------------------------------------------------- /content/common-ide.md: -------------------------------------------------------------------------------- 1 | # 写 Rust 有哪些常用的开发环境？ 2 | 3 | 目前来看，最流行的 Rust 开发环境是 [Visual Studio Code][vscode] 配合 [rust-analyzer][rust-analyzer]，其次是在 [CLion][clion] 或其他 [IntelliJ][intellij] 平台的 IDE 上安装 [Intellij Rust][intellij-rust] 插件。使用 [Vim][vim] 或 [Emacs][emacs] 进行开发的也不在少数，此外也有人使用其他编辑器。 4 | 5 | Rust 群关于这一问题有定期调查： 6 | * 2020年：[5月][2020-05]、[8月][2020-08]、[11月][2020-11] 7 | * 2021年：[2月][2021-02]、[6月][2021-06]、[9月][2021-09]、[12月][2021-12] 8 | * 2022年：[3月][2022-03]、[6月][2022-06]、[9月][2022-09]、[12月][2022-12] 9 | * 2023年：[3月][2023-03] 10 | 11 | 12 | [vscode]: https://code.visualstudio.com/ 13 | [rust-analyzer]: https://rust-analyzer.github.io/ 14 | [clion]: https://www.jetbrains.com/clion/ 15 | [intellij]: https://www.jetbrains.com/products.html#type=ide 16 | [intellij-rust]: https://intellij-rust.github.io/ 17 | [vim]: https://www.vim.org/ 18 | [emacs]: https://www.gnu.org/software/emacs/ 19 | 20 | [2020-05]: https://t.me/c/1264662201/96391 21 | [2020-08]: https://t.me/c/1264662201/116314 22 | [2020-11]: https://t.me/c/1264662201/130996 23 | [2021-02]: https://t.me/c/1264662201/147028 24 | [2021-06]: https://t.me/c/1264662201/172603 25 | [2021-09]: https://t.me/c/1264662201/187446 26 | [2021-12]: https://t.me/c/1264662201/208793 27 | [2022-03]: https://t.me/c/1264662201/229789 28 | [2022-06]: https://t.me/c/1264662201/254624 29 | [2022-09]: https://t.me/c/1264662201/289597 30 | [2022-12]: https://t.me/c/1264662201/319656 31 | [2023-03]: https://t.me/c/1264662201/354506 32 | -------------------------------------------------------------------------------- /content/debug-build-slow.md: -------------------------------------------------------------------------------- 1 | # 为什么使用调试模式构建的 Rust 程序运行速度很慢？ 2 | 3 | 当不指定任何标志时使用 `cargo build` 或 `cargo run` 来构建或运行 Rust 程序，会默认使用调试模式来进行构建，这时编译出的 Rust 程序运行速度很慢，有时甚至不及等效的 Python 代码。加上 `--release` 标志时会使用发布模式来构建，这样编译出的程序运行速度会快得多。造成这种现象的原因主要有两点： 4 | 5 | 一是调试模式构建主要是针对编译速度而非运行速度进行优化，因为在开发过程中我们常需要反复编辑、编译和调试，加速编译可以加快总体开发速度。但当为编译速度优化时，一方面，很多为加快运行速度但会拖慢编译的编译器优化会被禁用。由于 Rust 的库和程序通常有很多抽象设施，它们虽然给编写程序带来便利，但在调试模式下却可能无法被完全优化掉，进而拖慢运行速度。另一方面，调试模式下默认会启用一些额外的机制加快编译速度，如[增量编译](<> "incremental compilation")和[并发代码生成](<> "parallel codegen")，这些优化虽然加快了编译速度，但同时也牺牲了编译结果的质量，降低了运行速度。 6 | 7 | 二是调试模式下会启用一些额外的检测，而这些检测会增加运行时间。在调试模式下，编译器默认会为内置整数类型的算数运算插入溢出检查，在溢出发生时 panic 以帮助发现潜在的逻辑问题，而在发布模式下则没有这一检查。此外还有提供如 [`debug_assert!`][debug_assert] 宏和 [`debug_assertions`][debug_assertions] 条件编译选项等设施让库和应用可以根据需要在调试模式下额外执行一些较为昂贵的运行时检查。 8 | 9 | 10 | [debug_assert]: https://doc.rust-lang.org/std/macro.debug_assert.html 11 | [debug_assertions]: https://doc.rust-lang.org/reference/conditional-compilation.html#debug_assertions 12 | -------------------------------------------------------------------------------- /content/error-handling.md: -------------------------------------------------------------------------------- 1 | # 错误处理推荐使用什么库？ 2 | 3 | 目前一般认为对于应用程序推荐使用 [anyhow]，而对于库推荐使用 [thiserror]。 4 | 5 | anyhow 提供了一个基于[特质对象]的错误类型，可以很容易地将不同来源的错误统一到单一类型，并可以方便地为错误添加上下文，以及就地创建新的错误。 6 | 7 | thiserror 则提供了一个 derive 宏，方便为自定义的错误类型实现 [`Error` 特质][error-trait]。 8 | 9 | 10 | [anyhow]: https://crates.io/crates/anyhow 11 | [thiserror]: https://crates.io/crates/thiserror 12 | [error-trait]: https://doc.rust-lang.org/std/error/trait.Error.html 13 | -------------------------------------------------------------------------------- /content/fn-pointer-fn-trait.md: -------------------------------------------------------------------------------- 1 | # `fn()` 类型与 `Fn()` 等特质的关系和区别是什么？ 2 | 3 | 在 Rust 中，每一个函数，无论是由 `fn` 关键字定义的一般函数，还是由闭包表达式定义的闭包，都有一个各自独立的匿名类型。为了能间接地使用函数，Rust 准备了两种方式，即 [`fn()`][fn] 类型与 [`Fn()`][Fn-trait]、[`FnMut()`][FnMut-trait] 和 [`FnOnce()`][FnOnce-trait] 等[特质]。 4 | 5 | 要表达不同的类型，最常见的方法即是使用特质（作为类型约束，即 `T: Fn()` 和 `impl Fn()`，或者使用[特质对象]，即 `dyn Fn()`），`Fn()` 一族就是用于表达函数类型的特质。 6 | 7 | `fn()` 不是一个特质，而是一个具体的类型，表示一个函数指针。功能上它与特质对象类似，可以近似地看作 `&'static dyn Fn()`。但 `fn()` 与 `Fn()` 不同，它不包含对上下文的引用，因而只有一般函数或没有捕获任何上下文的闭包能够被转换成 `fn()`。因此它也与 `&dyn Fn()` 不同，不需要使用[胖指针]。它的大小与普通的指针一致。 8 | 9 | 因为 `fn()` 是一个函数指针，通过它调用函数与通过特质对象一样是间接调用，而使用 `Fn()` 等特质约束的泛型则是通过[单态化]来直接调用的。 10 | 11 | 12 | [fn]: https://doc.rust-lang.org/std/primitive.fn.html 13 | [Fn-trait]: https://doc.rust-lang.org/std/ops/trait.Fn.html 14 | [FnMut-trait]: https://doc.rust-lang.org/std/ops/trait.FnMut.html 15 | [FnOnce-trait]: https://doc.rust-lang.org/std/ops/trait.FnOnce.html 16 | -------------------------------------------------------------------------------- /content/format-macro.md: -------------------------------------------------------------------------------- 1 | # 格式化字符串的方法，如 `println`、`info` 等一般通过宏来实现，这是为什么？ 2 | 3 | 因为 Rust 里函数不支持变长参数，因而如果要做编译期类型检查，就必须通过宏来实现。 4 | -------------------------------------------------------------------------------- /content/future-poll-perf.md: -------------------------------------------------------------------------------- 1 | # Rust 的 `Future` 是基于轮询的，这种方式不会有性能问题吗？ 2 | 3 | `Future` 的轮询是带通知机制的轮询，与传统意义上的轮询不完全一样。 4 | 5 | 当[执行器](<> "executor")调用 `Future` 的 [`poll`][poll] 方法时会传入一个 [`Waker`][waker]，而 `Future` 可以将这个 `Waker` 保存起来，当自己的状态有所变化时，通过其通知执行器可以再次对自己进行轮询。通过这个机制，执行器可以避免反复轮询一个未准备好的 `Future`，避免了传统轮询带来的性能问题。 6 | 7 | 8 | [poll]: https://doc.rust-lang.org/std/future/trait.Future.html#tymethod.poll 9 | [waker]: https://doc.rust-lang.org/std/task/struct.Waker.html 10 | -------------------------------------------------------------------------------- /content/futures-rel.md: -------------------------------------------------------------------------------- 1 | # 标准库的 `Future`、futures crate、tokio 和 async-std 等之间的关系是什么？ 2 | 3 | 标准库的 [`Future`][future] [特质]以及相关的 [`Context`][context]、[`Pin`][pin]、[`Waker`][waker] 等是核心。由于编译器编译[异步函数]需要依赖它们的定义，因而它们必须被包含在标准库里。 4 | 5 | [futures] 是 `Future` 的扩展，提供了许多虽不必进入标准库但依然重要的基础性的东西，比如 [`FutureExt`][future-ext]、[`StreamExt`][stream-ext] 等扩展特质和基础的[通道][channel]、[执行器][executor]实现等。 6 | 7 | [tokio] 和 [async-std] 是同一个层次的，主要提供异步运行时的实现，都依赖 futures 提供的元语，但因为处理的层次不同，所以可以看到一些自定义的与 futures 差不多的模块。 8 | 9 | 此外，虽然目前 [`Stream`][stream] 是由 futures 提供的，但未来如果编译器要实现[异步生成器][generator]，这个特质也很可能会进入标准库，因而对其的扩展也依然放进了独立的 `StreamExt` 里。 10 | 11 | 12 | [future]: https://doc.rust-lang.org/std/future/trait.Future.html 13 | [context]: https://doc.rust-lang.org/std/task/struct.Context.html 14 | [pin]: https://doc.rust-lang.org/std/pin/struct.Pin.html 15 | [waker]: https://doc.rust-lang.org/std/task/struct.Waker.html 16 | 17 | [futures]: https://crates.io/crates/futures 18 | [future-ext]: https://docs.rs/futures/0.3/futures/future/trait.FutureExt.html 19 | [stream]: https://docs.rs/futures/0.3/futures/stream/trait.Stream.html 20 | [stream-ext]: https://docs.rs/futures/0.3/futures/stream/trait.StreamExt.html 21 | [channel]: https://docs.rs/futures/0.3/futures/channel/index.html 22 | [executor]: https://docs.rs/futures/0.3/futures/executor/index.html 23 | 24 | [tokio]: https://crates.io/crates/tokio 25 | [async-std]: https://crates.io/crates/async-std 26 | 27 | [generator]: https://rust-lang.github.io/rfcs/2394-async_await.html#generators-and-streams "async generator" 28 | -------------------------------------------------------------------------------- /content/generic-primitive-num.md: -------------------------------------------------------------------------------- 1 | # 如何约束一个泛型参数为基本数值类型？ 2 | 3 | 可以使用由 [num-traits] 所提供的 [`PrimInt`][prim-int] 和 [`Float`][float] 两个[特质]来约束泛型参数为基本整数类型和浮点数类型。 4 | 5 | 6 | [num-traits]: https://crates.io/crates/num-traits 7 | [prim-int]: https://docs.rs/num-traits/0.2/num_traits/int/trait.PrimInt.html 8 | [float]: https://docs.rs/num-traits/0.2/num_traits/float/trait.Float.html 9 | -------------------------------------------------------------------------------- /content/glossary.toml: -------------------------------------------------------------------------------- 1 | "对齐" = "alignment" 2 | "异步函数" = "async function" 3 | "动态分发" = "dynamic dispatch" 4 | "存在类型" = "existential type" 5 | "胖指针" = "fat pointer" 6 | "生命周期" = "lifetime" 7 | "字面量" = "literal" 8 | "单态化" = "monomorphization" 9 | "空指针优化" = "null pointer optimization" 10 | "空指针安全" = "null safety" 11 | "所有权" = "ownership" 12 | "切片" = "slice" 13 | "静态变量" = "static variable" 14 | "特质" = "trait" 15 | "特质对象" = "trait object" 16 | "虚表" = "vtable" 17 | "零开销抽象" = "zero-cost abstractions" 18 | -------------------------------------------------------------------------------- /content/heap-new.md: -------------------------------------------------------------------------------- 1 | # 如何直接在堆上分配新的对象或数组？ 2 | 3 | 目前 Rust 语言本身没有提供稳定且不使用 `unsafe` 的方式能保证将一个对象或数组直接分配到堆上。 4 | 5 | `Box::new([0; 4096])` 等方式在语义上是在栈上创建数组，然后再移动到堆上。[`Vec`][vec] 等容器类型的内容会直接分配在堆上，因而也可以通过 [`Vec::into_boxed_slice`][into-boxed-slice] 从一个 `Vec` 得到堆上切片 `Box<[T]>`，再通过 [`TryFrom`][try-from-boxed-slice] 获得堆上数组 `Box<[T; N]>`。不过添加每个元素从语义上依然是在栈上分配再移入容器的。 6 | 7 | 有一些第三方的库，如 [copyless]、[boxext] 和 [default-boxed] 等，通过依赖编译器优化或包装 `unsafe` 的功能来提供安全的接口进行直接分配。 8 | 9 | 使用 `unsafe` 的话可以通过调用 [`alloc`][alloc] 函数直接分配堆内存并取得指针，但需要手动初始化和管理分配的内存。`Box` 及其他智能指针类型未来很可能会提供 [`new_uninit`][box-new-uninit]、[`new_uninit_slice`][box-new-uninit-slice] 等方法在堆上直接创建 [`MaybeUninit`][maybe-uninit]，但你仍将需要使用 `unsafe` 的方式来初始化其内容。 10 | 11 | 未稳定的 [`box` 语法][box-syntax]在一些情况下可以直接分配到堆上并创建一个 `Box`，但当有嵌套表达式，如 `box Wrapper([0; 4096])`，时则依然会有先分配在栈上再移入堆的问题。而且 `box` 语法目前也没有稳定化的计划。 12 | 13 | 此外，有一些提案，如 [RFC 2884][rfc-2884]，试图提供新的接口来解决这一问题，但目前还没有足够的共识。 14 | 15 | 16 | [vec]: https://doc.rust-lang.org/std/vec/struct.Vec.html 17 | [into-boxed-slice]: https://doc.rust-lang.org/std/vec/struct.Vec.html#method.into_boxed_slice 18 | [try-from-boxed-slice]: https://doc.rust-lang.org/std/boxed/struct.Box.html#impl-TryFrom%3CBox%3C%5BT%5D%3E%3E 19 | [alloc]: https://doc.rust-lang.org/std/alloc/fn.alloc.html 20 | [box-new-uninit]: https://doc.rust-lang.org/std/boxed/struct.Box.html#method.new_uninit 21 | [box-new-uninit-slice]: https://doc.rust-lang.org/std/boxed/struct.Box.html#method.new_uninit_slice 22 | [maybe-uninit]: https://doc.rust-lang.org/std/mem/union.MaybeUninit.html 23 | 24 | [box-syntax]: https://doc.rust-lang.org/nightly/unstable-book/language-features/box-syntax.html 25 | [rfc-2884]: https://github.com/rust-lang/rfcs/pull/2884 26 | 27 | [copyless]: https://crates.io/crates/copyless 28 | [boxext]: https://crates.io/crates/boxext 29 | [default-boxed]: https://crates.io/crates/default-boxed 30 | -------------------------------------------------------------------------------- /content/static-lifetime-bound-var.md: -------------------------------------------------------------------------------- 1 | # `&'static T`、`T: 'static`、`static` 关键字分别表示什么？它们之间有什么联系？ 2 | 3 | ## `&'static T` 4 | 5 | `&'static T` 表示的是一个指向类型为 `T` 的值的引用，它的[生命周期]为 `'static`。这里的生命周期 `'static` 在语义上表示这个引用所指向的值在程序的整个运行期间都不会被释放（但可以使用 `unsafe` 构造违反这一语义的情况）。 6 | 7 | 这样的引用最常来自于[字面量]和对字面量的引用（如字符串字面量 `"hello world"` 的类型为 `&'static str`，`&[1i32, 2, 3]` 的类型为 `&'static [i32; 3]`），但它也可以来自于对常量或静态变量的引用，以及通过如 [`Vec::leak`][vec-leak] 等方法放弃[所有权]来获得。 8 | 9 | 由于 `'static` 生命周期长于任何其他生命周期，一个 `&'static T` 类型的引用可以安全地[强制转换](<> "coerce")为一个标注为任何生命周期的引用 `&'a T`。 10 | 11 | ## `T: 'static` 12 | 13 | `T: 'static` 表示的是一个类型约束，它表明类型 `T` 可以在程序的整个运行期间有效，也即 `T` 中不包含引用，或包含的所有引用的生命周期都为 `'static`，举例来说： 14 | * `struct Alpha(String, Vec);` 有 `Alpha: 'static`，因为类型中不包含引用； 15 | * `struct Beta(&'static str);` 也有 `Beta: 'static`，因为类型中的所有引用都是 `'static` 的； 16 | * `struct Gamma<'a>(&'a [usize]);` 仅当在 `'a` 为 `'static` 时有 `Gamma<'a>: 'static`，否则不满足； 17 | * `struct Delta(T);` 仅当 `T: 'static` 时有 `Delta: 'static`，否则不满足； 18 | 19 | 如果一个值的类型不满足 `T: 'static`，则这个值必须在类型上所标注的生命周期结束之前被释放掉。如果满足，则这个值可以存在任意长时间。显然一个值的生命周期不能超越约束其类型的生命周期，因此任何 `&'static T` 引用中的 `T` 必然要满足 `T: 'static`。 20 | 21 | ## `static` 关键字 22 | 23 | 以 [`static` 关键字][static-kw]声明的，形如 `static FOO: [i32; 5] = [1, 2, 3, 4, 5];` 的变量是[静态变量]。 24 | 25 | 一个静态变量在程序的整个运行期间是唯一的，有唯一的地址，而且不会被释放。它可以被看作是 Rust 里的全局变量。显然如果一个静态变量的类型为 `T`，这个类型必须满足 `T: 'static`，如此一来，这个类型的引用才是 `&'static T`。 26 | 27 | 28 | [vec-leak]: https://doc.rust-lang.org/std/vec/struct.Vec.html#method.leak 29 | [static-kw]: https://doc.rust-lang.org/stable/std/keyword.static.html 30 | -------------------------------------------------------------------------------- /content/trait-obj-upcast.md: -------------------------------------------------------------------------------- 1 | # 如果有一个 `trait Foo: Base`，如何将一个 `&dyn Foo` 转换到 `&dyn Base`？ 2 | 3 | Rust 目前不直接提供这种转换，如果需要转换可以使用一个中间[特质]来实现，如 4 | ```rust 5 | trait Base { 6 | // ... 7 | } 8 | 9 | trait AsBase { 10 | fn as_base(&self) -> &dyn Base; 11 | } 12 | 13 | impl AsBase for T { 14 | fn as_base(&self) -> &dyn Base { self } 15 | } 16 | 17 | trait Foo: AsBase { 18 | // ... 19 | } 20 | ``` 21 | 22 | 不支持的主要原因是在[特质对象]的[虚表]中没有相应的数据指向另一个特质的虚表，而不提供相应数据的原因可能是由于这很容易产生过多无用的虚表，进而导致二进制体积的膨胀。 23 | 24 | 更多关于这一话题的讨论可以参考 [RFC 2765][rfc2765] 以及 [Traits, dynamic dispatch and upcasting][bchlr]。 25 | 26 | 27 | [rfc2765]: https://github.com/rust-lang/rfcs/issues/2765 28 | [bchlr]: https://articles.bchlr.de/traits-dynamic-dispatch-upcasting 29 | -------------------------------------------------------------------------------- /content/vec-new-ptr.md: -------------------------------------------------------------------------------- 1 | # 新创建的空 `Vec` 的指针为何指向`1`、`2`、`4`、`8`等地址？ 2 | 3 | 当 `Vec` 的容量为0时，没有合法的操作会向其指针指向的位置进行读取和写入，进行任何读写之前都必然会有一次内存分配，因此这个初始的指针并不需要是一个有效的指针。这也使得创建 `Vec` 本身没有进行实际内存分配的必要，既省去了内存分配的开销，也让创建容器的操作可以在常量上下文中使用。 4 | 5 | 而因为 `Vec` 需要能被作为[切片]使用，由于切片对数据指针的[要求][slice-safety]，它的指针的地址需要是非空并且正确对齐的，因而简单起见便选择了类型的对齐的大小作为这个无效指针指向的地址。 6 | 7 | 8 | [slice-safety]: https://doc.rust-lang.org/std/slice/fn.from_raw_parts.html#safety 9 | -------------------------------------------------------------------------------- /content/where-to-find-crates.md: -------------------------------------------------------------------------------- 1 | # 有什么 crate 可以…？在哪找到它们？ 2 | 3 | 有很多 crates 列表，这里是其中的一些： 4 | 5 | - [rust-unofficial/awesome-rust](https://github.com/rust-unofficial/awesome-rust) 6 | - [blessed.rs](https://blessed.rs/crates) 7 | -------------------------------------------------------------------------------- /res/cc0.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/rust-zh/faq/8bab8e5a1572cabda2d99ded73b231a464132fe4/res/cc0.png -------------------------------------------------------------------------------- /res/edit.svg: -------------------------------------------------------------------------------- 1 | 2 | 3 | -------------------------------------------------------------------------------- /res/index.html.hbs: -------------------------------------------------------------------------------- 1 | 2 | 3 | 4 | 5 | Rust 常见疑问汇总 6 | 7 | 8 |
9 |

Rust 常见疑问汇总

10 |
11 |
12 | {{#each entries as |entry|~}} 13 |
14 | {{render_entry entry}} 15 | 编辑 16 |
17 | {{/each~}} 18 |
19 | + 贡献新条目 20 |
21 |
22 | 26 | 27 | -------------------------------------------------------------------------------- /res/style.css: -------------------------------------------------------------------------------- 1 | body { 2 | margin: 0 auto; 3 | padding: 1em; 4 | max-width: 750px; 5 | } 6 | 7 | h1 { 8 | font-size: 140%; 9 | } 10 | 11 | article { 12 | position: relative; 13 | margin: 2em 0; 14 | border-bottom: 1px solid lightgray; 15 | padding-bottom: 1em; 16 | } 17 | 18 | h2 { 19 | font-size: 100%; 20 | padding-right: calc(24px + .5em); 21 | } 22 | 23 | h2:target { 24 | background-color: #FDFFD3; 25 | } 26 | 27 | h2 > a { 28 | position: relative; 29 | } 30 | 31 | h2 > a:hover::before { 32 | position: absolute; 33 | left: -3ex; 34 | content: '\2002\00a7\2002'; 35 | } 36 | 37 | a { 38 | color: #3873AD; 39 | text-decoration: none; 40 | } 41 | 42 | a:hover { 43 | text-decoration: underline; 44 | } 45 | 46 | a:not([href]) { 47 | color: inherit; 48 | text-decoration: underline dashed; 49 | } 50 | 51 | code { 52 | background-color: #F5F5F5; 53 | padding: 0 0.1em; 54 | border-radius: 3px; 55 | } 56 | 57 | pre.code { 58 | background-color: #F5F5F5; 59 | padding: 1em; 60 | overflow: auto; 61 | } 62 | 63 | .edit { 64 | position: absolute; 65 | top: 0; 66 | right: 0; 67 | padding-left: 1.5em; 68 | text-indent: -10em; 69 | overflow: hidden; 70 | background: center / 1em no-repeat url(edit.svg); 71 | opacity: .1; 72 | } 73 | 74 | h2:hover ~ .edit, .edit:hover { 75 | opacity: 1; 76 | } 77 | 78 | h3 { 79 | font-size: 100%; 80 | } 81 | 82 | li { 83 | margin: 0.5em 0; 84 | } 85 | 86 | .add-container { 87 | margin: -1em 0 2em; 88 | } 89 | 90 | .add { 91 | font-size: 80%; 92 | color: #666; 93 | opacity: .3; 94 | } 95 | 96 | .add:hover { 97 | text-decoration: none; 98 | opacity: 1; 99 | } 100 | 101 | footer { 102 | font-size: 15px; 103 | line-height: 1; 104 | display: flex; 105 | } 106 | 107 | .cc0, .telegram { 108 | display: inline-block; 109 | color: transparent; 110 | } 111 | 112 | .cc0 { 113 | width: 80px; 114 | height: 15px; 115 | background-image: url(cc0.png); 116 | } 117 | 118 | .telegram { 119 | width: 60px; 120 | height: 15px; 121 | margin-right: .5em; 122 | background: 0 0 / 100% 100% url(telegram.png); 123 | } 124 | 125 | @media (prefers-reduced-motion: no-preference) { 126 | .edit, .add { 127 | transition: opacity 250ms; 128 | } 129 | } 130 | -------------------------------------------------------------------------------- /res/telegram.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/rust-zh/faq/8bab8e5a1572cabda2d99ded73b231a464132fe4/res/telegram.png -------------------------------------------------------------------------------- /src/entry_writer.rs: -------------------------------------------------------------------------------- 1 | use crate::CODE_HIGHLIGHT_CLASS_STYLE; 2 | use once_cell::sync::Lazy; 3 | use pulldown_cmark::{BrokenLink, CodeBlockKind, Event, HeadingLevel, Options, Parser, Tag}; 4 | use std::collections::HashMap; 5 | use std::io::{self, Write}; 6 | use syntect::html::ClassedHTMLGenerator; 7 | use syntect::parsing::{SyntaxReference, SyntaxSet}; 8 | use v_htmlescape::escape; 9 | 10 | pub struct EntryWriter<'a, W> { 11 | output: W, 12 | name: &'a str, 13 | content: &'a str, 14 | glossary: &'a HashMap, 15 | current_syntax: Option<&'static SyntaxReference>, 16 | } 17 | 18 | static SYNTAX_SET: Lazy = Lazy::new(SyntaxSet::load_defaults_newlines); 19 | 20 | impl<'a, W> EntryWriter<'a, W> 21 | where 22 | W: Write, 23 | { 24 | pub fn new( 25 | output: W, 26 | name: &'a str, 27 | content: &'a str, 28 | glossary: &'a HashMap, 29 | ) -> Self { 30 | EntryWriter { 31 | output, 32 | name, 33 | content, 34 | glossary, 35 | current_syntax: None, 36 | } 37 | } 38 | 39 | pub fn run(mut self) -> io::Result<()> { 40 | let glossary = self.glossary; 41 | let mut broken_link_callback = move |link: BrokenLink<'_>| { 42 | glossary 43 | .get(&*link.reference) 44 | .map(|title| ("".into(), title.as_str().into())) 45 | }; 46 | Parser::new_with_broken_link_callback( 47 | self.content, 48 | Options::empty(), 49 | Some(&mut broken_link_callback), 50 | ) 51 | .try_for_each(|event| self.handle_event(event))?; 52 | Ok(()) 53 | } 54 | 55 | fn handle_event(&mut self, event: Event<'_>) -> io::Result<()> { 56 | let output = &mut self.output; 57 | match event { 58 | Event::Start(tag) => self.start_tag(tag), 59 | Event::End(tag) => self.end_tag(tag), 60 | Event::Text(text) => { 61 | if let Some(syntax) = self.current_syntax { 62 | let mut generator = ClassedHTMLGenerator::new_with_class_style( 63 | syntax, 64 | &SYNTAX_SET, 65 | CODE_HIGHLIGHT_CLASS_STYLE, 66 | ); 67 | for line in text.split_inclusive('\n') { 68 | generator 69 | .parse_html_for_line_which_includes_newline(line) 70 | .map_err(|e| io::Error::new(io::ErrorKind::Other, e))?; 71 | } 72 | write!(output, "{}", generator.finalize()) 73 | } else { 74 | write!(output, "{}", escape(&text)) 75 | } 76 | } 77 | Event::Code(code) => write!(output, "{}", escape(&code)), 78 | Event::Html(html) => write!(output, "{}", html), 79 | Event::SoftBreak => todo!(), 80 | Event::HardBreak => write!(output, "
"), 81 | Event::Rule => unimplemented!("rule not supported"), 82 | Event::FootnoteReference(_) => unimplemented!("footnote not supported"), 83 | Event::TaskListMarker(_) => unimplemented!("task list marker not supported"), 84 | } 85 | } 86 | 87 | fn start_tag(&mut self, tag: Tag<'_>) -> io::Result<()> { 88 | let output = &mut self.output; 89 | match tag { 90 | Tag::Paragraph => write!(output, "

"), 91 | Tag::Heading(HeadingLevel::H1, _, _) => { 92 | write!(output, r##"

"##, self.name) 93 | } 94 | Tag::Heading(level, _, _) => write!(output, "", level as i32 + 1), 95 | Tag::Link(_, dest, title) => { 96 | write!(output, "") 104 | } 105 | Tag::CodeBlock(CodeBlockKind::Fenced(lang)) => { 106 | assert!(self.current_syntax.is_none()); 107 | self.current_syntax = match SYNTAX_SET.find_syntax_by_token(&lang) { 108 | None => panic!("unknown language `{}`", lang), 109 | Some(syntax) => Some(syntax), 110 | }; 111 | write!(output, r#"
"#)
112 |             }
113 |             Tag::List(None) => write!(output, "

"), 124 | Tag::Heading(level, _, _) => write!(output, "", level as i32 + 1), 125 | Tag::Link(_, _, _) => write!(output, ""), 126 | Tag::CodeBlock(CodeBlockKind::Fenced(_)) => { 127 | self.current_syntax = None; 128 | write!(output, "") 129 | } 130 | Tag::List(None) => write!(output, ""), 131 | Tag::Item => write!(output, ""), 132 | tag => unimplemented!("tag {:?} not supported", tag), 133 | } 134 | } 135 | } 136 | -------------------------------------------------------------------------------- /src/main.rs: -------------------------------------------------------------------------------- 1 | use crate::entry_writer::EntryWriter; 2 | use anyhow::{anyhow, Context as _, Result}; 3 | use glob::glob; 4 | use handlebars::Handlebars; 5 | use serde::Serialize; 6 | use std::collections::HashMap; 7 | use std::env; 8 | use std::ffi::OsStr; 9 | use std::fs::{self, File}; 10 | use std::io::{self, BufWriter}; 11 | use std::path::Path; 12 | use std::str; 13 | use syntect::highlighting::ThemeSet; 14 | use syntect::html::{css_for_theme_with_class_style, ClassStyle}; 15 | 16 | mod entry_writer; 17 | 18 | #[derive(Serialize)] 19 | struct Data { 20 | entries: Vec, 21 | } 22 | 23 | const CODE_HIGHLIGHT_CLASS_STYLE: ClassStyle = ClassStyle::SpacedPrefixed { prefix: "s-" }; 24 | 25 | fn main() -> Result<()> { 26 | env::set_current_dir(env::var("CARGO_MANIFEST_DIR")?)?; 27 | 28 | let glossary = 29 | fs::read_to_string("content/glossary.toml").context("failed to read glossary file")?; 30 | let glossary: HashMap = 31 | toml::from_str(&glossary).context("failed to parse glossary file")?; 32 | 33 | let mut handlebars = Handlebars::new(); 34 | handlebars.register_helper( 35 | "render_entry", 36 | Box::new( 37 | |helper: &handlebars::Helper, 38 | _: &Handlebars, 39 | _: &handlebars::Context, 40 | _: &mut handlebars::RenderContext, 41 | out: &mut dyn handlebars::Output| 42 | -> handlebars::HelperResult { 43 | let name = helper 44 | .param(0) 45 | .and_then(|param| param.value().as_str()) 46 | .ok_or_else(|| handlebars::RenderError::new("name invalid"))?; 47 | let content = fs::read_to_string(format!("content/{}.md", name))?; 48 | EntryWriter::new(OutputWriter(out), name, &content, &glossary).run()?; 49 | Ok(()) 50 | }, 51 | ), 52 | ); 53 | 54 | let entries = glob("content/*.md") 55 | .unwrap() 56 | .map(|entry| -> Result { 57 | let path = entry?; 58 | let name = path 59 | .file_stem() 60 | .and_then(OsStr::to_str) 61 | .ok_or_else(|| anyhow!("invalid file name: {:?}", path.file_name()))?; 62 | Ok(name.to_owned()) 63 | }) 64 | .collect::>()?; 65 | let data = Data { entries }; 66 | 67 | let out = Path::new("out"); 68 | let _ = fs::remove_dir_all(out); 69 | fs::create_dir_all(out)?; 70 | 71 | for entry in fs::read_dir("res")? { 72 | let entry = entry?; 73 | let path = entry.path(); 74 | if path.extension() == Some(OsStr::new("hbs")) { 75 | let template = fs::read_to_string(&path)?; 76 | let output = File::create(out.join(path.file_stem().unwrap()))?; 77 | let mut output = BufWriter::new(output); 78 | handlebars.render_template_to_write(&template, &data, &mut output)?; 79 | } else { 80 | fs::hard_link(entry.path(), out.join(entry.file_name())) 81 | .with_context(|| format!("failed to link {:?}", entry.file_name()))?; 82 | } 83 | } 84 | 85 | // Write style sheet for code highlight. 86 | let theme_set = ThemeSet::load_defaults(); 87 | let theme = theme_set.themes.get("Solarized (light)").unwrap(); 88 | fs::write( 89 | out.join("highlight.css"), 90 | css_for_theme_with_class_style(theme, CODE_HIGHLIGHT_CLASS_STYLE)?, 91 | )?; 92 | 93 | Ok(()) 94 | } 95 | 96 | struct OutputWriter<'a, T: ?Sized>(&'a mut T); 97 | 98 | impl<'a, T: ?Sized> io::Write for OutputWriter<'a, T> 99 | where 100 | T: handlebars::Output, 101 | { 102 | fn write(&mut self, buf: &[u8]) -> io::Result { 103 | self.0.write(str::from_utf8(buf).unwrap())?; 104 | Ok(buf.len()) 105 | } 106 | 107 | fn flush(&mut self) -> io::Result<()> { 108 | Ok(()) 109 | } 110 | } 111 | --------------------------------------------------------------------------------