Struct Config 

pub struct Config {
    pub resolver: PathResolver,
    pub system_dict: Option<PathBuf>,
    pub user_dicts: Vec<PathBuf>,
    pub character_definition_file: PathBuf,
    pub connection_cost_plugins: Vec<Value>,
    pub input_text_plugins: Vec<Value>,
    pub oov_provider_plugins: Vec<Value>,
    pub path_rewrite_plugins: Vec<Value>,
    pub projection: SurfaceProjection,
}

Setting data loaded from config file

Fields

resolver: PathResolver

Paths will be resolved against these roots, until a file will be found

system_dict: Option<PathBuf>

user_dicts: Vec<PathBuf>

character_definition_file: PathBuf

connection_cost_plugins: Vec<Value>

input_text_plugins: Vec<Value>

oov_provider_plugins: Vec<Value>

path_rewrite_plugins: Vec<Value>

projection: SurfaceProjection

Implementations

impl Config

pub fn new( config_file: Option<PathBuf>, resource_dir: Option<PathBuf>, dictionary_path: Option<PathBuf>, ) -> Result<Self, ConfigError>

Creates a config from optional config, resource, and dictionary paths.

Resolution precedence is:

1. resource_dir (if given).
2. The path field in the config_file (if set).
3. The parent directory of the config_file (if given).
4. The default (embedded) resources.

When config_file is None, the embedded default sudachi.json is used as config data.

pub fn empty() -> Self

pub fn new_embedded() -> Result<Self, ConfigError>

pub fn minimal_at(resolver: PathResolver) -> Config

Creates a minimal config with the provided path resolver

pub fn with_system_dic(self, system: impl Into<PathBuf>) -> Config

Sets the system dictionary to the provided path

pub fn resolve_paths(&self, path: String) -> Vec<String>

pub fn complete_path<P: AsRef<Path> + Into<PathBuf>>( &self, file_path: P, ) -> Result<PathBuf, ConfigError>

Resolves a possibly relative path with regards to all possible anchors:

1. Absolute paths stay as they are
2. Paths are resolved wrt to anchors, returning the first existing one
3. Path are checked wrt to CWD
4. If all fail, return an error with all candidate paths listed

pub fn resolved_system_dict(&self) -> Result<PathBuf, ConfigError>

pub fn resolved_user_dicts(&self) -> Result<Vec<PathBuf>, ConfigError>

Trait Implementations

impl Clone for Config

fn clone(&self) -> Config

Returns a duplicate of the value.

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.