Struct Config

pub struct Config {
    pub file_associations: Option<HashMap<String, String>>,
    pub formatting: RenderConfig,
    pub grammar: GrammarConfig,
    pub input_processing: TreeSitterProcessor,
    pub fallback_cmd: Option<String>,
}

The config struct for the application

Fields

file_associations: Option<HashMap<String, String>>

Custom file extension mappings between a file extension and a language

These will be merged with the existing defaults, with the user-defined mappings taking precedence. The existing mappings are available at: parse::FILE_EXTS and the user can list all available langauges with diffsitter --cmd list

formatting: RenderConfig

Formatting options for display

grammar: GrammarConfig

Options for loading

input_processing: TreeSitterProcessor

Options for processing tree-sitter input.

fallback_cmd: Option<String>

The program to invoke if the given files can not be parsed by the available tree-sitter parsers.

This will invoke the program with with the old and new file as arguments, like so:

${FALLBACK_PROGRAM} ${OLD} ${NEW}

Implementations

impl Config

pub fn try_from_file<P: AsRef<Path>>( path: Option<&P>, ) -> Result<Self, ReadError>

Read a config from a given filepath, or fall back to the default file paths

If a path is supplied, this method will attempt to read the contents of that path and parse it to a string. If a path isn’t supplied, the function will attempt to figure out what the default config file path is supposed to be (based on OS conventions, see [default_config_file_path]).

Errors

This method will return an error if the config cannot be parsed or if no default config exists.

Trait Implementations

impl Clone for Config

fn clone(&self) -> Config

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Config

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

Formats the value using the given formatter.

impl Default for Config

fn default() -> Config

Returns the “default value” for a type.

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

where Config: Default,

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for Config

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

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

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.

impl Eq for Config

impl StructuralPartialEq for Config