keremet/rpm-ostree
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity

rust: Add a bit more info on cxx, move up StringMapping

Browse Source 
Docs are good, and move up `StringMapping` since multiple things
are likely to use it.
This commit is contained in:
Colin Walters 2021-01-21 23:29:40 +00:00 committed by OpenShift Merge Robot
parent a4487578a7
commit 71496c0958
1 changed files with 17 additions and 9 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

26
rust/src/lib.rs
View File

@ -16,6 +16,12 @@ pub(crate) use cxxrsutil::*;
mod includes;
/// APIs defined here are automatically bridged between Rust and C++ using https://cxx.rs/
///
/// Usage guidelines:
///
/// - Keep this content roughly ordered alphabetically
/// - While the return type here will be `Result<T>` on the implementation
/// side you currently *should* use `CxxResult`; see the docs of that for more information.
#[cxx::bridge(namespace = "rpmostreecxx")]
mod ffi {
// Types that are defined by gtk-rs generated bindings that
@ -30,6 +36,17 @@ mod ffi {
type GCancellable = crate::FFIGCancellable;
}
/// Currently cxx-rs doesn't support mappings; like probably most projects,
/// by far our most common case is a mapping from string -> string and since
/// our data sizes aren't large, we serialize this as a vector of strings pairs.
/// In the future it's also likely that cxx-rs will support a C++ string_view
/// so we could avoid duplicating in that direction.
#[derive(Clone, Debug)]
struct StringMapping {
k: String,
v: String,
}
// client.rs
extern "Rust" {
fn client_handle_fd_argument(arg: &str, arch: &str) -> Result<Vec<i32>>;
@ -120,15 +137,6 @@ mod ffi {
fn testutils_entrypoint(argv: Vec<String>) -> Result<()>;
}
/// Currently cxx-rs doesn't support mappings; like probably most projects,
/// by far our most common case is a mapping from string -> string and since
/// our data sizes aren't large, we serialize this as a vector of strings pairs.
#[derive(Clone, Debug)]
struct StringMapping {
k: String,
v: String,
}
// utils.rs
extern "Rust" {
fn varsubstitute(s: &str, vars: &Vec<StringMapping>) -> Result<String>;