Struct ApiVersion 

#[repr(C)]
pub struct ApiVersion {
    pub major: u32,
    pub minor: u32,
    pub patch: u32,
}

Version of openstranded-common-wasmcontract baked at compile time.

Each WASM plugin exports this via plugin_api_version(). The engine reads it on load to check compatibility.

The version is automatically derived from the Cargo.toml of the openstranded-common-wasmcontract crate. Plugin authors never set it manually.

WASM ABI

#[repr(C)] ensures a stable layout when passing across the WASM boundary.

Fields

major: u32

Major version — breaking changes.

minor: u32

Minor version — backwards-compatible additions.

patch: u32

Patch version — backwards-compatible bug fixes.

Implementations

impl ApiVersion

pub const fn current() -> Self

Current API version, baked from CARGO_PKG_VERSION_* environment variables.

env!() evaluates at compile time, so the version is statically embedded.

Example

use openstranded_common_wasmcontract::ApiVersion;

let v = ApiVersion::current();
println!("API version: {v}");

pub fn compatible_with( &self, engine_version: &ApiVersion, ) -> Result<(), VersionMismatch>

Check compatibility with an engine version.

Returns Ok(()) if major versions match. Returns a warning string if only the minor differs. Returns an error if major versions differ.

Errors

Returns VersionMismatch::Incompatible if self.major != engine_version.major. Minor version mismatches are accepted with a logged warning (the caller is expected to handle the log, not this function).

Trait Implementations

impl Clone for ApiVersion

fn clone(&self) -> ApiVersion

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for ApiVersion

impl Debug for ApiVersion

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

Formats the value using the given formatter.

impl Display for ApiVersion

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

Formats the value using the given formatter.

impl Eq for ApiVersion

impl PartialEq for ApiVersion

fn eq(&self, other: &ApiVersion) -> bool

Equality operator ==.

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=.

impl StructuralPartialEq for ApiVersion