Struct OpaqueTypes 

pub struct OpaqueTypes { /* private fields */ }

Builder for generating layout-compatible opaque structs.

See the crate-level documentation for exact parameter formats and workspace setup.

Implementations

impl OpaqueTypes

pub fn new(source_manifest_dir: impl Into<PathBuf>) -> Self

Creates a generator for the package whose Cargo.toml is inside source_manifest_dir.

pub fn features<I, S>(self, features: I) -> Self

where I: IntoIterator<Item = S>, S: Into<String>,

Sets explicit, unqualified Cargo feature names for the source dependency.

Each item must match a key in the source package’s [features] table. This setting is independent of Self::default_features.

pub fn default_features(self, enabled: bool) -> Self

Controls whether the source dependency’s default features are enabled. Defaults to true.

pub fn add(self, rust_type: Type, opaque_type: Type) -> Self

Adds a source Rust type and its generated opaque struct type.

rust_type must be resolvable from the probe crate. opaque_type must contain one unqualified Rust identifier.

pub fn cargo_lock(self, path: impl Into<PathBuf>) -> Self

Override the Cargo.lock copied into the probe crate (default: the destination workspace’s lock, located via get-cargo-lock).

pub fn build_dir(self, path: impl Into<PathBuf>) -> Self

Override the probe build directory (default: $OUT_DIR/opaque_probe).

pub fn generate(&self, destination: impl AsRef<Path>) -> Result<()>

Probes every requested type and writes the generated Rust source to destination.

The destination is written only after every requested type’s size and alignment has been read successfully. Failure to build or inspect any requested type returns an error and leaves an existing destination file unchanged.

Trait Implementations

impl Clone for OpaqueTypes

fn clone(&self) -> OpaqueTypes

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for OpaqueTypes

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.