Struct EditorConfigHandle

pub struct EditorConfigHandle { /* private fields */ }

EditorConfig handle

Implementations

impl EditorConfigHandle

pub fn new() -> Result<Self, &'static str>

Creates a new EditorConfigHandle

Example

let handle = editorconfig_rs::EditorConfigHandle::new();

pub fn get_version(&self) -> Version<c_int>

TODO: Add comment

Example

let handle = editorconfig_rs::EditorConfigHandle::new().unwrap();
let version = handle.get_version();

pub fn set_version<T: Into<c_int>>(&self, version: Version<T>)

TODO: Add comment

Example

use editorconfig_rs::Version;

let handle = editorconfig_rs::EditorConfigHandle::new().unwrap();
handle.set_version(Version::new(0, 12, 5));

pub fn get_config_filename(&self) -> Option<String>

Returns the configuration filename iff it was previously set by calling EditorConfigHandle::set_config_filename; otherwise None

Note: None just means the default filename ".editorconfig" is used

pub fn set_config_filename(&mut self, filename: &str)

Sets a custom EditorConfig configuration filename

Allows you to change the default configuration filename “.editorconfig”.

Example

let mut handle = editorconfig_rs::EditorConfigHandle::new().unwrap();
handle.set_config_filename(".myeditorconfig")

pub fn parse<P: AsRef<Path>>(&self, absolute_path: P) -> Option<ParseError>

Searches an absolute path for the corresponding EditorConfig rules

After parsing, you can get the rules by calling EditorConfigHandle::get_rules.

Example

let handle = editorconfig_rs::EditorConfigHandle::new().unwrap();
let test_file_path = std::fs::canonicalize("tests/🦀🚀").unwrap();
let err = handle.parse(test_file_path);

pub fn get_error_file(&self) -> Option<PathBuf>

Returns the path of the invalid configuration file when parse returned an error

Returns

The path of the invalid configuration file or None if there was no error

pub fn get_rule_count(&self) -> c_int

Returns the number of rules found after parsing

Example

let handle = editorconfig_rs::EditorConfigHandle::new().unwrap();
// Parse a file or directory; otherwise `get_rule_count()` returns 0
let rule_count = handle.get_rule_count();

pub fn get_rules(&self) -> HashMap<String, String>

Returns a map of all rules found after parsing

Example

let handle = editorconfig_rs::EditorConfigHandle::new().unwrap();
let test_file_path = std::fs::canonicalize("tests/🦀🚀").unwrap();
let err = handle.parse(test_file_path);
let rules = handle.get_rules();

Trait Implementations

impl Drop for EditorConfigHandle

fn drop(&mut self)

Executes the destructor for this type.