This is a combine rust + C++ crate (using CXX) that will bind directly into libwebrtc using C++ and then use the tools in CXX to expose all that back into rust.
This package relies on tooling from the build/libwebrtc/ folder to have been run. That tooling will create a static build for libwebrtc which is pulled in here. This crate will not build libwebrtc.
See cxx.rs for brief primer on how CXX works as familiarity is required to bind anything.
We include all c++ files in src/ and header files in include/ by default the build.rs will pick up any new header and c++ (.cc) files in those directories (but not subdirectories).
There are a couple of important files that have special functionality:
-
include/alias.h: We expose aliases that CXX can find and we bind those into rust. This is to work around issues where we cannot (yet) bind enums in class static. -
include/rust_shared.h: Empty markers for all shared structs (or rust structs) that cxx exports. The only way to getextern "Rust"exposed types into C++ is by adding a empty struct here and using them elsewhere. -
The bridges are split up roughly one per c++ file but they are primarily designed to be compilation units so some will include multiple c++ files.
-
Never include the main cxx header file (lib.rs.h) in include/ header files. This will result in cycles in the header files. To expose common functionality see
rust_shared.h. -
There are multiple instances of functios named
gen_*something or other. These are purely to generate rust code and are not intended to be used directly.