Struct ProcessPluginCommunicator

Source
pub struct ProcessPluginCommunicator { /* private fields */ }
Expand description

Communicates with a process plugin.

Implementations§

Source§

impl ProcessPluginCommunicator

Source

pub async fn new( executable_file_path: &Path, on_std_err: impl Fn(String) + Clone + Send + Sync + 'static, ) -> Result<Self>

Source

pub async fn new_with_init( executable_file_path: &Path, on_std_err: impl Fn(String) + Clone + Send + Sync + 'static, ) -> Result<Self>

Provides the --init CLI flag to tell the process plugin to do any initialization necessary

Source

pub async fn shutdown(&self)

Perform a graceful shutdown.

Source

pub fn kill(&self)

Source

pub async fn register_config( &self, config_id: FormatConfigId, global_config: &GlobalConfiguration, plugin_config: &ConfigKeyMap, ) -> Result<()>

Source

pub async fn release_config(&self, config_id: FormatConfigId) -> Result<()>

Source

pub async fn ask_is_alive(&self) -> bool

Source

pub async fn plugin_info(&self) -> Result<PluginInfo>

Source

pub async fn license_text(&self) -> Result<String>

Source

pub async fn resolved_config(&self, config_id: FormatConfigId) -> Result<String>

Source

pub async fn file_matching_info( &self, config_id: FormatConfigId, ) -> Result<FileMatchingInfo>

Source

pub async fn config_diagnostics( &self, config_id: FormatConfigId, ) -> Result<Vec<ConfigurationDiagnostic>>

Source

pub async fn check_config_updates( &self, message: &CheckConfigUpdatesMessage, ) -> Result<Vec<ConfigChange>>

Source

pub async fn format_text( &self, request: ProcessPluginCommunicatorFormatRequest, ) -> FormatResult

Source

pub async fn is_process_alive(&self) -> bool

Checks if the process is functioning.

Trait Implementations§

Source§

impl Drop for ProcessPluginCommunicator

Source§

fn drop(&mut self)

Executes the destructor for this type. Read more

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.