rpm-ostree/rust/cbindgen.toml

autogen_warning = "/* Warning, this file is autogenerated by cbindgen. Don't modify this manually. */"
language = "C"
header = "#pragma once\n#include \"rpmostree-rust-prelude.h\""
trailer = """
G_DEFINE_AUTOPTR_CLEANUP_FUNC(RORTreefile, ror_treefile_free)
G_DEFINE_AUTOPTR_CLEANUP_FUNC(RORHistoryCtx, ror_history_ctx_free)
G_DEFINE_AUTO_CLEANUP_CLEAR_FUNC(RORHistoryEntry, ror_history_entry_clear)
"""

[export]
prefix = "ROR"
# Here we exclude entries belonging to the C side which we use on the Rust side and so
# doesn't make sense to re-export.
exclude = ["RpmOstreeOrigin",
           "rpmostree_get_repodata_chksum_repr",
           "rpmostree_origin_get_live_state" ]

[parse]
# We don't want cbindgen to parse libdnf-sys, since we're clients of the library, not
# providers. This should already be guaranteed by `parse_deps` being `false`, but include
# this here too to be explicit.
exclude = ["libdnf-sys"]
Use cbindgen If we're going to scale out our oxidation, let's follow the path of Firefox (and other projects) further and use cbindgen: https://github.com/eqrion/cbindgen It's actually nice that `cbindgen` is packaged today in Fedora, but I doubt it is elsewhere; we may end up needing to push that forward, or just vendor it via a `build.rs` script and Cargo. I chose to rename things to `ROR`/`ror_` since it's shorter. I am tempted a bit to rename our internal functions to just `ro_` to or so. Closes: #1516 Approved by: jlebon 2018-08-24 17:42:31 +03:00			`autogen_warning = "/* Warning, this file is autogenerated by cbindgen. Don't modify this manually. */"`
			`language = "C"`
Move the "cbindgen typedefs" to their own file I'm going to add more and they would get unwieldly inlined in the TOML. 2020-08-28 17:25:36 +03:00			`header = "#pragma once\n#include \"rpmostree-rust-prelude.h\""`
rust/bindgen: Add an autoptr cleanup for our struct I'm going to add a new user soon. This should probably be a best practice. Ideally...cbindgen would have a way to add some wrapper bits around any types it defines or something? Closes: #1559 Approved by: jlebon 2018-09-13 23:11:48 +03:00			`trailer = """`
			`G_DEFINE_AUTOPTR_CLEANUP_FUNC(RORTreefile, ror_treefile_free)`
Add new `ex history` command This is the rpm-ostree equivalent of `dnf history`. As opposed to the history of the refspec (i.e. `ostree log`), this shows the history of the system, i.e. the refspecs the host deployed, checksums, versions, layered packages, etc... The amount of details remembered is similar to what shows up in `status`. There's definitely some further enhancements possible (e.g. printing package diffs, displaying rollbacks), though this seems in good enough shape as a first cut. Closes: #1489 Closes: #1813 Approved by: cgwalters 2019-04-25 18:18:33 +03:00			`G_DEFINE_AUTOPTR_CLEANUP_FUNC(RORHistoryCtx, ror_history_ctx_free)`
			`G_DEFINE_AUTO_CLEANUP_CLEAR_FUNC(RORHistoryEntry, ror_history_entry_clear)`
rust/bindgen: Add an autoptr cleanup for our struct I'm going to add a new user soon. This should probably be a best practice. Ideally...cbindgen would have a way to add some wrapper bits around any types it defines or something? Closes: #1559 Approved by: jlebon 2018-09-13 23:11:48 +03:00			`"""`

Use cbindgen If we're going to scale out our oxidation, let's follow the path of Firefox (and other projects) further and use cbindgen: https://github.com/eqrion/cbindgen It's actually nice that `cbindgen` is packaged today in Fedora, but I doubt it is elsewhere; we may end up needing to push that forward, or just vendor it via a `build.rs` script and Cargo. I chose to rename things to `ROR`/`ror_` since it's shorter. I am tempted a bit to rename our internal functions to just `ro_` to or so. Closes: #1516 Approved by: jlebon 2018-08-24 17:42:31 +03:00			`[export]`
			`prefix = "ROR"`
daemon/syscore: push livefs introspection to Rust This starts bridging parts of the daemon syscore logic to Rust plumbing, moving the livefs detection logic over there as a first consumer. That was the simplest logic available for wiring, and mostly meant as a sanity check. 2020-10-29 13:24:41 +03:00			`# Here we exclude entries belonging to the C side which we use on the Rust side and so`
rust: move libdnf-sys module to its own crate This is just a cleaner arrangement to make the separation more explicit. It also matches what most other wrapper crates do. One advantage of this is that we can tell cbindgen directly that we don't want it to ever export symbols from `libdnf-sys`. Related discussions in: https://github.com/coreos/rpm-ostree/pull/2047 2020-04-07 18:09:17 +03:00			`# doesn't make sense to re-export.`
daemon/syscore: push livefs introspection to Rust This starts bridging parts of the daemon syscore logic to Rust plumbing, moving the livefs detection logic over there as a first consumer. That was the simplest logic available for wiring, and mostly meant as a sanity check. 2020-10-29 13:24:41 +03:00			`exclude = ["RpmOstreeOrigin",`
			`"rpmostree_get_repodata_chksum_repr",`
			`"rpmostree_origin_get_live_state" ]`
rust: move libdnf-sys module to its own crate This is just a cleaner arrangement to make the separation more explicit. It also matches what most other wrapper crates do. One advantage of this is that we can tell cbindgen directly that we don't want it to ever export symbols from `libdnf-sys`. Related discussions in: https://github.com/coreos/rpm-ostree/pull/2047 2020-04-07 18:09:17 +03:00
			`[parse]`
			`# We don't want cbindgen to parse libdnf-sys, since we're clients of the library, not`
			# providers. This should already be guaranteed by `parse_deps` being `false`, but include
			`# this here too to be explicit.`
			`exclude = ["libdnf-sys"]`