Struct Builder 

pub struct Builder { /* private fields */ }

Generate Rust code for the VPP handling of APIs of from a .api file

Examples

Example of use from a build script:

use std::{env, path::PathBuf};

let output_dir = PathBuf::from(env::var("OUT_DIR").unwrap()).join("src");
vpp_plugin_api_gen::Builder::new("example.api", &output_dir.to_string_lossy())
    .expect("unable to generate API binding")
    .generate()
    .expect("unable to generate API binding");

This can then be include in the plugin as follows:

mod example_api {
    include!(concat!(env!("OUT_DIR"), "/src/example_api.rs"));
}

Implementations

impl Builder

pub fn new(input_file: &str, output_dir: &str) -> Result<Self, Error>

Construct a new Builder for the given input file and outputting to the given directory

Both a <api-module>_api.rs and a <api-module>.api.json file will be generated in the output directory.

pub fn generate(self) -> Result<(), Error>

Generate Rust code for the API file

Both a <api-module>_api.rs and a <api-module>.api.json file will be generated in the output directory.

Trait Implementations

impl Debug for Builder

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

Formats the value using the given formatter.