Enum CommunicationMode

pub enum CommunicationMode {
    Stdio,
    LocalSocket(OsString),
}

The type of communication used between the plugin and the engine.

Stdio is required to be supported by all plugins, and is attempted initially. If the local-socket feature is enabled and the plugin supports it, LocalSocket may be attempted.

Local socket communication has the benefit of not tying up stdio, so it’s more compatible with plugins that want to take user input from the terminal in some way.

Variants

Stdio

Communicate using stdin and stdout.

LocalSocket(OsString)

Communicate using an operating system-specific local socket.

Implementations

impl CommunicationMode

pub fn local_socket(plugin_exe: &Path) -> CommunicationMode

Generate a new local socket communication mode based on the given plugin exe path.

pub fn args(&self) -> Vec<&OsStr>

pub fn setup_command_io(&self, command: &mut Command)

pub fn serve(&self) -> Result<PreparedServerCommunication, ShellError>

pub fn connect_as_client(&self) -> Result<ClientCommunicationIo, ShellError>

Trait Implementations

impl Clone for CommunicationMode

fn clone(&self) -> CommunicationMode

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for CommunicationMode

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

Formats the value using the given formatter.