Struct gdnative_doc::ConfigFile

pub struct ConfigFile {
    pub url_overrides: Option<HashMap<String, String>>,
    pub rename_classes: Option<HashMap<String, String>>,
    pub markdown_options: Option<Vec<String>>,
    pub opening_comment: Option<bool>,
}

Structure that holds user configuration settings.

Should be obtained via a toml configuration file.

Example

const CONFIG_FILE_CONTENT: &str = r#"
rename_classes = { RustName = "GDScriptName" }
markdown_options = ["STRIKETHROUGH", "TABLES"]
"#;

let config_file = ConfigFile::load_from_str(CONFIG_FILE_CONTENT)?;
assert!(config_file.url_overrides.is_none());
assert_eq!(config_file.rename_classes.unwrap()["RustName"], "GDScriptName");
assert_eq!(
    config_file.markdown_options.unwrap(),
    &["STRIKETHROUGH".to_string(), "TABLES".to_string()]
);

Note that if you are reading the configuration file from an on-disk file, you should prefer load_from_path.

Fields

url_overrides: Option<HashMap<String, String>>

List of items for which the linking url should be overriden.

rename_classes: Option<HashMap<String, String>>

Renaming of types when going from Rust to Godot.

This is useful because GDNative allows defining a script_class_name in the .gdns file.

markdown_options: Option<Vec<String>>

Optional markdown options.

Valid options

• FOOTNOTES
• SMART_PUNCTUATION
• STRIKETHROUGH
• TABLES
• TASKLISTS

Default

No option enabled.

opening_comment: Option<bool>

Control whether or not to include a comment in the generated files.

The comment includes information such that the file was automatically generated, the name of the source file it originated from…

Default

true

Implementations

impl ConfigFile

pub fn load_from_path(path: PathBuf) -> Result<Self>

Load the config file from the given path.

pub fn load_from_str(config: &str) -> Result<Self>

Load the config file from the given config string.

Trait Implementations

impl Clone for ConfigFile

fn clone(&self) -> ConfigFile

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for ConfigFile

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for ConfigFile

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error> where
    __D: Deserializer<'de>, 

Deserialize this value from the given Serde deserializer.

impl Eq for ConfigFile

impl PartialEq<ConfigFile> for ConfigFile

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

This method tests for self and other values to be equal, and is used by ==.

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

This method tests for !=.

impl StructuralEq for ConfigFile

impl StructuralPartialEq for ConfigFile