Struct Session

pub struct Session { /* private fields */ }

An active Neovim session.

Implementations

impl Session

pub fn new_tcp(addr: &str) -> Result<Session>

Connect to nvim instance via tcp

pub fn new_unix_socket<P: AsRef<Path>>(path: P) -> Result<Session>

Connect to nvim instance via unix socket

pub fn new_child() -> Result<Session>

Connect to a Neovim instance by spawning a new one.

pub fn new_child_path<S: AsRef<Path>>(program: S) -> Result<Session>

Connect to a Neovim instance by spawning a new one

pub fn new_child_cmd(cmd: &mut Command) -> Result<Session>

Connect to a Neovim instance by spawning a new one

stdin/stdout settings will be rewrited to Stdio::piped()

pub fn new_parent() -> Result<Session>

Connect to a Neovim instance that spawned this process over stdin/stdout.

pub fn set_timeout(&mut self, timeout: Duration)

Set call timeout

pub fn set_infinity_timeout(&mut self)

pub fn start_event_loop_channel_handler<H>( &mut self, request_handler: H, ) -> Receiver<(String, Vec<Value>)>

where H: RequestHandler + Send + 'static,

Start processing rpc response and notifications

pub fn start_event_loop_channel(&mut self) -> Receiver<(String, Vec<Value>)>

Start processing rpc response and notifications

pub fn start_event_loop_handler<H>(&mut self, handler: H)

where H: Handler + Send + 'static,

Start processing rpc response and notifications

pub fn start_event_loop(&mut self)

Start processing rpc response and notifications

pub fn call(&mut self, method: &str, args: Vec<Value>) -> Result<Value, Value>

Sync call. Call can be made only after event loop begin processing

pub fn call_async<R: FromVal<Value>>( &mut self, method: &str, args: Vec<Value>, ) -> AsyncCall<'_, R>

Create async call will be executed when only after call() function.

pub fn take_dispatch_guard(&mut self) -> JoinHandle<()>

Wait dispatch thread to finish.

This can happens in case child process connection is lost for some reason.