Struct ProcMacroClient 

pub struct ProcMacroClient {
    pub(crate) pool: Arc<ProcMacroServerPool>,
    pub(crate) path: AbsPathBuf,
}

A handle to an external process which load dylibs with macros (.so or .dll) and runs actual macro expansion functions.

Fields

pool: Arc<ProcMacroServerPool>

Currently, the proc macro process expands all procedural macros sequentially.

That means that concurrent salsa requests may block each other when expanding proc macros, which is unfortunate, but simple and good enough for the time being.

path: AbsPathBuf

Implementations

impl ProcMacroClient

pub fn spawn<'a>( process_path: &AbsPath, env: impl IntoIterator<Item = (impl AsRef<OsStr>, &'a Option<impl 'a + AsRef<OsStr>>)> + Clone, version: Option<&Version>, num_process: usize, ) -> Result<ProcMacroClient>

Spawns an external process as the proc macro server and returns a client connected to it.

pub fn with_io_channels( process_path: &AbsPath, spawn: impl Fn(Option<ProtocolFormat>) -> Result<(Box<dyn ProcessExit>, Box<dyn Write + Send + Sync>, Box<dyn BufRead + Send + Sync>)> + Clone, version: Option<&Version>, num_process: usize, ) -> Result<ProcMacroClient>

Invokes spawn and returns a client connected to the resulting read and write handles.

The process_path is used for Self::server_path. This function is mainly used for testing.

pub fn server_path(&self) -> &AbsPath

Returns the absolute path to the proc-macro server.

pub fn load_dylib( &self, dylib: MacroDylib, callback: Option<SubCallback<'_>>, ) -> Result<Vec<ProcMacro>, ServerError>

Loads a proc-macro dylib into the server process returning a list of ProcMacros loaded.

pub fn exited(&self) -> Option<&ServerError>

Checks if the proc-macro server has exited.

Trait Implementations

impl Debug for ProcMacroClient

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

Formats the value using the given formatter.