Skip to content

Rust: update docs for public preview #19280

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 28 commits into from
Jun 23, 2025
Merged

Rust: update docs for public preview #19280

Show file tree
Hide file tree
Changes from 3 commits
Commits
Show all changes
28 commits
Select commit Hold shift + click to select a range
00f6d9b
Rust: start preparing documentation changes
Apr 10, 2025
df427f7
Rust: add supported frameworks file
Apr 11, 2025
33c857c
Rust: update supported languages footnote
Apr 11, 2025
e2a86aa
Rust: update supported libraries
redsun82 May 2, 2025
00f4bfd
Rust: add some more supported libraries
redsun82 May 2, 2025
779d06f
Merge branch 'main' into redsun82/rust-doc
redsun82 Jun 6, 2025
c70decb
Rust: add `Callable::getParam` and `CallExprBase::getArg` shortcuts
redsun82 Jun 6, 2025
f3e4f94
Rust: add documentation
redsun82 Jun 6, 2025
9c2fea9
Rust: accept test changes
redsun82 Jun 10, 2025
f647b33
Rust: rerun codegen
redsun82 Jun 10, 2025
48721dc
Merge branch 'main' into redsun82/rust-doc
redsun82 Jun 10, 2025
3fe6ba6
Revert "Rust: add `Callable::getParam` and `CallExprBase::getArg` sho…
redsun82 Jun 10, 2025
b6aa692
Revert "Rust: accept test changes"
redsun82 Jun 10, 2025
02c11b1
Revert "Rust: rerun codegen"
redsun82 Jun 10, 2025
902a421
Rust: fix docs with `getArgList` and `getParamList`
redsun82 Jun 10, 2025
e1e34df
Merge branch 'main' into redsun82/rust-doc
redsun82 Jun 12, 2025
c56a325
Rust: remove now unneeded `get(Arg|Param)List` in the dataflow guide
redsun82 Jun 12, 2025
cae4a04
Rust: update `supported-frameworks.rst`
redsun82 Jun 13, 2025
ad3a5d7
Rust: add public preview change notes
redsun82 Jun 13, 2025
e9a0710
Rust: address review on docs
redsun82 Jun 17, 2025
494d192
Merge branch 'main' into redsun82/rust-doc
redsun82 Jun 18, 2025
e011475
Rust: fix formatting in doc snippet
redsun82 Jun 18, 2025
7a9f23c
Rust: fix `sphinx` error
redsun82 Jun 19, 2025
11af770
Merge branch 'main' into redsun82/rust-doc
redsun82 Jun 19, 2025
f812b64
Rust: address review
redsun82 Jun 19, 2025
9c06a82
Rust: apply suggestions from code review
redsun82 Jun 20, 2025
bd0d996
Merge branch 'main' into redsun82/rust-doc
redsun82 Jun 23, 2025
915b0b3
Update docs/codeql/codeql-language-guides/analyzing-data-flow-in-rust…
redsun82 Jun 23, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
33 changes: 33 additions & 0 deletions docs/codeql/reusables/supported-frameworks.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -306,6 +306,39 @@ and the CodeQL library pack ``codeql/ruby-all`` (`changelog <https://github.com/
rubyzip, Compression library
typhoeus, HTTP client

Rust built-in support
====================================

Provided by the current versions of the
CodeQL query pack ``codeql/rust-queries`` (`changelog <https://github.com/github/codeql/tree/codeql-cli/latest/rust/ql/src/CHANGELOG.md>`__, `source <https://github.com/github/codeql/tree/codeql-cli/latest/rust/ql/src>`__)
and the CodeQL library pack ``codeql/rust-all`` (`changelog <https://github.com/github/codeql/tree/codeql-cli/latest/rust/ql/lib/CHANGELOG.md>`__, `source <https://github.com/github/codeql/tree/codeql-cli/latest/rust/ql/lib>`__).
All support is experimental.

.. csv-table::
:header-rows: 1
:class: fullWidthTable
:widths: auto
:align: left

Name, Category
alloc, Standard library
core, Standard library
`digest <https://crates.io/crates/digest>`__, Cryptography library
`futures-executor <https://crates.io/crates/futures-executor>`__, Utility library
`hyper <https://crates.io/crates/hyper>`__, HTTP library
`hyper-util <https://crates.io/crates/hyper-util>`__, HTTP library
`libc <https://crates.io/crates/libc>`__, Utility library
`log <https://crates.io/crates/log>`__, Logging library
`md5 <https://crates.io/crates/md5>`__, Utility library
`postgres <https://crates.io/crates/postgres>`__, Database
proc_macro, Standard library
`regex <https://crates.io/crates/regex>`__, Utility library
`reqwest <https://crates.io/crates/reqwest>`__, HTTP client
`rusqlite <https://crates.io/crates/rusqlite>`__, Database
std, Standard library
`tokio-postgres <https://crates.io/crates/tokio-postgres>`__, Database
`url <https://crates.io/crates/url>`__, Utility library

Swift built-in support
================================

Expand Down
2 changes: 2 additions & 0 deletions docs/codeql/reusables/supported-versions-compilers.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -25,6 +25,7 @@
JavaScript,ECMAScript 2022 or lower,Not applicable,"``.js``, ``.jsx``, ``.mjs``, ``.es``, ``.es6``, ``.htm``, ``.html``, ``.xhtm``, ``.xhtml``, ``.vue``, ``.hbs``, ``.ejs``, ``.njk``, ``.json``, ``.yaml``, ``.yml``, ``.raml``, ``.xml`` [7]_"
Python [8]_,"2.7, 3.5, 3.6, 3.7, 3.8, 3.9, 3.10, 3.11, 3.12, 3.13",Not applicable,``.py``
Ruby [9]_,"up to 3.3",Not applicable,"``.rb``, ``.erb``, ``.gemspec``, ``Gemfile``"
Rust [13]_,"Rust editions 2021 and 2024","Rust compiler","``.rs``, ``Cargo.toml``"
Swift [10]_,"Swift 5.4-6.0","Swift compiler","``.swift``"
TypeScript [11]_,"2.6-5.8",Standard TypeScript compiler,"``.ts``, ``.tsx``, ``.mts``, ``.cts``"

Expand All @@ -42,3 +43,4 @@
.. [10] Support for the analysis of Swift requires macOS.
.. [11] TypeScript analysis is performed by running the JavaScript extractor with TypeScript enabled. This is the default.
.. [12] Support for GitHub Actions is in public preview.
.. [13] Support for Rust is experimental and requires ``rustup`` and ``cargo`` to be installed, as well as `CODEQL_ENABLE_EXPERIMENTAL_FEATURES=true` set in the environment. Features from nightly toolchains are not supported.