docs/devel/rust.rst

9 Right now, the focus is on making it possible to write devices that inherit
10 from ``SysBusDevice`` in `*safe*`__ Rust.  Later, it may become possible
31 * it is also possible to use ``cargo`` for common Rust-specific coding
35 generated sources from QEMU's build directory and puts it in Cargo's
37 of Cargo will complain that it cannot find the generated sources,
91   crate, which is planned for inclusion in QEMU, but it can be easily patched
97   it is hard to place the ``VMStateField`` definitions in traits.
100   inclusion as ``#![feature(location_file_nul)]``, but it will be a while
106   replaces it.
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
231 it *cannot* be casted to ``&mut`` unless the value was stored to the ``*mut``
232 from a mutable reference.  Furthermore, it is undefined behavior if any
273 Whenever C code provides you with an opaque ``void *``, avoid converting it
289 a raw pointer, for use in calls to C functions.  It can be used for
316   ``Owned<T>`` for those that need it.
320   (either a builtin one or a user-defined one) in order to pass it to C
321   functions.  Put them in a trait and access it through generic parameters.
334   supported set of Rust versions, document it in the source and in this
335   file.  This ensures that it can be fixed when the minimum supported
339   When marking a type ``Sync``, be careful of whether it needs the big
343 **Don't be afraid of complexity, but document and isolate it**
344   It's okay to be tricky; device code is written more often than bindings
345   code and it's important that it is idiomatic.  However, you should strive
347   or a macro) where it can be documented and tested.  If needed, include
358 or less fixed; it follows the following template, which is fixed apart
392   implementation of ``TryFrom``, and it uses the ``#[repr(...)]`` attribute
396 exceeds a few lines of code, it may be worthwhile to delegate work to
410 It is expected that ``qemu_api`` provides full ``rustdoc`` documentation for
417 adding a new external crate, especially if it comes with a large set of
424 files, it is still highly experimental and is therefore not used.
459 It's important to specify the right compiler options.  These include:
473 Also, after every change to the ``meson.build`` file it is strongly suggested to