language-servers/rust-analyzer
1
0
Fork 0
mirror of https://github.com/rust-lang/rust-analyzer.git synced 2025-10-28 18:43:01 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions 5

Merge pull request #19329 from Shourya742/2025-03-10-add-proc-macro-api-doc

Browse source 
doc: add doc to proc-macro-api
This commit is contained in:
Lukas Wirth 2025-03-17 09:17:35 +00:00 • committed by GitHub
commit 64d39c1abc
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
4 changed files with 71 additions and 1 deletions
Download patch file Download diff file Expand all files Collapse all files

12
crates/proc-macro-api/src/lib.rs
View file

@ -24,9 +24,12 @@ use crate::{
process::ProcMacroServerProcess,
};
/// Represents different kinds of procedural macros that can be expanded by the external server.
#[derive(Copy, Clone, Eq, PartialEq, Debug, serde_derive::Serialize, serde_derive::Deserialize)]
pub enum ProcMacroKind {
/// A macro that derives implementations for a struct or enum.
CustomDerive,
/// An attribute-like procedural macro.
Attr,
// This used to be called FuncLike, so that's what the server expects currently.
#[serde(alias = "Bang")]
@ -46,11 +49,13 @@ pub struct ProcMacroClient {
path: AbsPathBuf,
}
/// Represents a dynamically loaded library containing procedural macros.
pub struct MacroDylib {
path: AbsPathBuf,
}
impl MacroDylib {
/// Creates a new MacroDylib instance with the given path.
pub fn new(path: AbsPathBuf) -> MacroDylib {
MacroDylib { path }
}
@ -80,6 +85,7 @@ impl PartialEq for ProcMacro {
}
}
/// Represents errors encountered when communicating with the proc-macro server.
#[derive(Clone, Debug)]
pub struct ServerError {
pub message: String,
@ -108,6 +114,7 @@ impl ProcMacroClient {
Ok(ProcMacroClient { process: Arc::new(process), path: process_path.to_owned() })
}
/// Returns the absolute path to the proc-macro server.
pub fn server_path(&self) -> &AbsPath {
&self.path
}
@ -136,20 +143,25 @@ impl ProcMacroClient {
}
}
/// Checks if the proc-macro server has exited.
pub fn exited(&self) -> Option<&ServerError> {
self.process.exited()
}
}
impl ProcMacro {
/// Returns the name of the procedural macro.
pub fn name(&self) -> &str {
&self.name
}
/// Returns the type of procedural macro.
pub fn kind(&self) -> ProcMacroKind {
self.kind
}
/// Expands the procedural macro by sending an expansion request to the server.
/// This includes span information and environmental context.
pub fn expand(
&self,
subtree: tt::SubtreeView<'_, Span>,