docs/devel/rust.rst

14 __ https://doc.rust-lang.org/nomicon/meet-safe-and-unsafe.html
17 ------------------------------
25 are accustomed to the more "normal" Cargo-based development workflow.
31 * it is also possible to use ``cargo`` for common Rust-specific coding
53     pyvenv/bin/meson devenv -w ../rust cargo clippy --tests
54     pyvenv/bin/meson devenv -w ../rust cargo fmt
62   tree.  This third method is useful if you are using ``rust-analyzer``;
64   ``rust-analyzer.cargo.extraEnv`` setting.
66 As shown above, you can use the ``--tests`` option as usual to operate on test
71    make check-rust
99 * NUL-terminated file names with ``#[track_caller]`` are scheduled for
102   ``util/error.c`` to support non-NUL-terminated file names.
108 __ https://github.com/rust-lang/rust/pull/125258
111 ``--generate-cstr``.  This option requires version 0.66.x and will
116 -------------------------
141 - *complete*: ready for use in new devices; if applicable, the API supports the
144 - *stable*: ready for production use, the API is safe and should not undergo
147 - *proof of concept*: the API is subject to change but allows working with safe
150 - *initial*: the API is in its initial stages; it requires large amount of
151   unsafe code; it might have soundness or type-safety issues
217 provide extra compile-time checking; the basic *realize* functionality
252 __ https://github.com/rust-lang/miri
277 also be provided for ``AioContext``-based locking as well.
282 crate, which is able to "look inside" them when building an in-memory
298 the wrapper to be declared thread-safe::
319   (either a builtin one or a user-defined one) in order to pass it to C
361     pub fn derive_object(input: TokenStream) -> TokenStream {
373     fn derive_object_or_error(input: DeriveInput) ->
407 ``cargo fmt --check``, maintainers can fix this for you when applying patches.
410 bindings that are in their final shape or close.
413 -------------------
431 __ https://doc.rust-lang.org/cargo/reference/workspaces.html#virtual-workspace
437 crate.  The wrap file must be named ``NAME-SEMVER-rs.wrap``, where ``NAME``
439 first non-zero number.  For example, a crate with version ``0.2.3`` will use
443 ``subprojects/NAME-SEMVER-rs/meson.build``.  Generally this includes:
456 non-native versions of the crate.
462 * the ``--cfg`` (which have to be "reverse engineered" from the ``build.rs``
465 * usually, a ``--cap-lints allow`` argument to hide warnings from rustc
469 version with ``meson subprojects update --reset ``NAME-SEMVER-rs``.  This might
476 As a last step, add the new subproject to ``scripts/archive-source.sh``,
477 ``scripts/make-release`` and ``subprojects/.gitignore``.