1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38

//! Functions to spawn a [`neovim`](crate::neovim::Neovim) session.
//!
//! This implements various possibilities to connect to neovim, including
//! spawning an own child process. Available capabilities might depend on your
//! OS and choice of features.
//!
//! Supported features: `use_tokio` and `use_async-std`.
//!
//! **IMPORTANT**: Due to incompatibilities of the rust async ecosystem,  you
//! might not be able to use types from one lib with the runtime of another lib.
//! E.g. when using the features `use_tokio`, you will need to run all the
//! API functions from inside the tokio runtime.
#[cfg(feature = "use_tokio")]
pub mod tokio;

#[cfg(feature = "use_async-std")]
pub mod async_std;

use core::future::Future;

use crate::rpc::handler::Handler;

/// A task to generalize spawning a future that returns `()`.
///
/// If you use one of the features `use_tokio` or `use_async-std`, this will
/// automatically be implemented on you
/// [`Handler`](crate::rpc::handler::Handler) using the appropriate runtime.
///
/// If you have a runtime that brings appropriate types, you can implement this
/// on your `[`Handler`](crate::rpc::handler::Handler) and use
/// [`Neovim::new`](crate::neovim::Neovim::new) to connect to neovim.
pub trait Spawner: Handler {
  type Handle;

  fn spawn<Fut>(&self, future: Fut) -> Self::Handle
  where
    Fut: Future<Output = ()> + Send + 'static;
}