Struct Configuration 

pub struct Configuration { /* private fields */ }

The configuration of the Topiary.

Contains information on how to format every language the user is interested in, modulo what is supported. It can be provided by the user of the library, or alternatively, Topiary ships with default configuration that can be accessed using Configuration::default.

Implementations

impl Configuration

pub fn fetch( merge: bool, file: &Option<PathBuf>, ) -> TopiaryConfigResult<(Self, RichTerm)>

Consume the configuration from the usual sources. Which sources exactly can be read in the documentation of Source.

Errors

If the configuration file does not exist, this function will return a TopiaryConfigError with the path that was not found. If the configuration file exists, but cannot be parsed, this function will return a TopiaryConfigError with the error that occurred.

pub fn get_language<T>(&self, name: T) -> TopiaryConfigResult<&Language>

where T: AsRef<str> + Display,

Gets a language configuration from the entire configuration.

Errors

If the provided language name cannot be found in the Configuration, this function returns a TopiaryConfigError

pub fn prefetch_language<T>( &self, language: T, force: bool, ) -> TopiaryConfigResult<()>

where T: AsRef<str> + Display,

Prefetches and builds the desired language. This can be beneficial to speed up future startup time.

Errors

If the language could not be found or the Grammar could not be build, a TopiaryConfigError is returned.

pub fn prefetch_languages(&self, force: bool) -> TopiaryConfigResult<()>

Prefetches and builds all known languages. This can be beneficial to speed up future startup time.

Errors

If any Grammar could not be build, a TopiaryConfigError is returned.

pub fn detect<P: AsRef<Path>>(&self, path: P) -> TopiaryConfigResult<&Language>

Convenience alias to detect the Language from a Path-like value’s extension.

Errors

If the file extension is not supported, a FormatterError will be returned.

Trait Implementations

impl Debug for Configuration

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

Formats the value using the given formatter.

impl Default for Configuration

fn default() -> Self

Return the built-in configuration

impl From<&Configuration> for HashMap<String, Language>

Convert Serialisation values into HashMaps, keyed on Language::name

fn from(config: &Configuration) -> Self

Converts to this type from the input type.

impl PartialEq for Configuration

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

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

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

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