Trait InputTextPlugin

pub trait InputTextPlugin: Sync + Send {
    // Required methods
    fn set_up(
        &mut self,
        settings: &Value,
        config: &Config,
        grammar: &Grammar<'_>,
    ) -> SudachiResult<()>;
    fn rewrite_impl<'a>(
        &'a self,
        input: &InputBuffer,
        edit: InputEditor<'a>,
    ) -> SudachiResult<InputEditor<'a>>;

    // Provided methods
    fn uses_chars(&self) -> bool { ... }
    fn rewrite(&self, input: &mut InputBuffer) -> SudachiResult<()> { ... }
}

Trait of plugin to modify the input text before tokenization

Required Methods

fn set_up( &mut self, settings: &Value, config: &Config, grammar: &Grammar<'_>, ) -> SudachiResult<()>

Loads necessary information for the plugin

fn rewrite_impl<'a>( &'a self, input: &InputBuffer, edit: InputEditor<'a>, ) -> SudachiResult<InputEditor<'a>>

👎Deprecated: call rewrite instead

Actual implementation of rewriting. Call apply_rewrite instead.

Provided Methods

fn uses_chars(&self) -> bool

Whether the rewrite process uses chars

fn rewrite(&self, input: &mut InputBuffer) -> SudachiResult<()>

Perform rewrites

Trait Implementations

impl PluginCategory for dyn InputTextPlugin

type BoxType = Box<dyn InputTextPlugin + Send + Sync>

Boxed type of the plugin. Should be Box.

type InitFnType = unsafe fn() -> Result<<dyn InputTextPlugin as PluginCategory>::BoxType, SudachiError>

Type of the initialization function. It must take 0 arguments and return SudachiResult<Self::BoxType>.

fn configurations(cfg: &Config) -> &[Value]

Extract plugin configurations from the config

fn bundled_impl(name: &str) -> Option<Self::BoxType>

Create bundled plugin for plugin name Instead of full name like com.worksap.nlp.sudachi.ProlongedSoundMarkPlugin should handle only the short one: ProlongedSoundMarkPlugin

fn do_setup( ptr: &mut Self::BoxType, settings: &Value, config: &Config, grammar: &mut Grammar<'_>, ) -> SudachiResult<()>

Perform initial setup. We can’t call set_up of the plugin directly in the default implementation of this method because we do not know the specific type yet

Implementors

impl InputTextPlugin for DefaultInputTextPlugin