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>>,
}

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::read_from(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()]
);

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.

Implementations

impl ConfigFile

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

Read ConfigFile from the given toml configuration file.

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