Struct Config

pub struct Config {
    pub namespace: String,
    pub api_lib_name: String,
    pub parent_crate: String,
    pub rustdoc_crates: Vec<String>,
    pub file_prefix: Option<String>,
    pub copyright_header: Option<String>,
    pub generated_by_header: Option<String>,
    pub crate_feature_flags: Option<Vec<String>>,
    pub rustdoc_flags: Option<Vec<String>>,
}

A Config object that provides information for the generation of C/C++ code

Fields

namespace: String

The namespace that should be used in the C++ code (required)

api_lib_name: String

The name of the API library that is built (important for Rustdoc, required)

parent_crate: String

The name of your API crate (important for Rustdoc, required)

rustdoc_crates: Vec<String>

All crates that include the types you use in your API, needs to at least include your API crate (required)

file_prefix: Option<String>

In case the file names of the generated C/C++ should have a prefix, put this here

copyright_header: Option<String>

Copyright header to be included in every C/C++ file

generated_by_header: Option<String>

Generated-by header to be included in every C/C++ file

crate_feature_flags: Option<Vec<String>>

In case you need to set any feature flags for build process of Rustdoc, add them here

rustdoc_flags: Option<Vec<String>>

Add some additional rustdoc flags here, can be useful for debugging

Implementations

impl Config

pub fn new( namespace: String, api_lib_name: String, parent_crate: String, rustdoc_crates: Vec<String>, ) -> Self

Create a new config object by only setting required fields

pub fn extend_rustdoc_flags(&mut self, flags: Vec<String>)

Add some additional flags that should be passed when creating the rustdocs

Trait Implementations

impl Debug for Config

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for Config

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Serialize for Config

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.