Struct arma_rs::Extension

pub struct Extension { /* private fields */ }

Contains all the information about your extension This is used by the generated code to interface with Arma

Implementations

impl Extension

pub fn build() -> ExtensionBuilder

Creates a new extension.

Examples found in repository

examples/hello_world.rs (line 5)

fn init() -> Extension {
    Extension::build()
        .version("1.0.0".to_string())
        .command("hello", hello)
        .command("welcome", welcome)
        .finish()
}

pub fn version(&self) -> &str

Returns the version of the extension.

pub const fn allow_no_args(&self) -> bool

Returns if the extension can be called without any arguments. Example:

"my_ext" callExtension "my_func"

pub fn register_callback(&mut self, callback: Callback)

Called by generated code, do not call directly.

pub fn context(&self) -> Context

Get a context for interacting with Arma

pub unsafe fn handle(
    &self,
    function: *mut c_char,
    output: *mut c_char,
    size: size_t,
    args: Option<*mut *mut i8>,
    count: Option<c_int>
) -> c_int

Called by generated code, do not call directly.

Safety

This function is unsafe because it interacts with the C API.

pub fn testing(self) -> Extension

Create a version of the extension that can be used in tests.

pub fn run_callbacks(&self)

Called by generated code, do not call directly.