Struct MacroResult 

pub struct MacroResult {
    pub runtime_patches: Vec<Patch>,
    pub type_patches: Vec<Patch>,
    pub diagnostics: Vec<Diagnostic>,
    pub tokens: Option<String>,
    pub debug: Option<String>,
}

The result returned by a macro function.

MacroResult is the standard return type for all macro functions. It contains patches to apply to the code, diagnostic messages, and optional debug information.

Patch Separation

Patches are separated into two categories:

• runtime_patches: Applied to the .js/.ts runtime code
• type_patches: Applied to .d.ts type declaration files

This separation allows macros to generate different code for runtime and type-checking contexts.

Example

use macroforge_ts_syn::{MacroResult, Patch, Diagnostic, DiagnosticLevel};

fn my_macro() -> MacroResult {
    // Success with patches
    MacroResult {
        runtime_patches: vec![/* ... */],
        type_patches: vec![],
        diagnostics: vec![],
        tokens: None,
        debug: Some("Generated 2 methods".to_string()),
    }
}

fn my_macro_error() -> MacroResult {
    // Error result
    MacroResult {
        diagnostics: vec![Diagnostic {
            level: DiagnosticLevel::Error,
            message: "Invalid input".to_string(),
            span: None,
            notes: vec![],
            help: Some("Try using @derive(Debug) instead".to_string()),
        }],
        ..Default::default()
    }
}

Fields

runtime_patches: Vec<Patch>

Patches to apply to the runtime JS/TS code.

type_patches: Vec<Patch>

Patches to apply to the .d.ts type declarations.

diagnostics: Vec<Diagnostic>

Diagnostic messages (errors, warnings, info). If any error diagnostics are present, the macro expansion is considered failed.

tokens: Option<String>

Optional raw token stream (source code) returned by the macro. Used for macros that generate complete output rather than patches.

debug: Option<String>

Optional debug information for development. Can be displayed in verbose mode or logged for debugging.

Trait Implementations

impl Clone for MacroResult

fn clone(&self) -> MacroResult

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for MacroResult

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

Formats the value using the given formatter.

impl Default for MacroResult

fn default() -> MacroResult

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for MacroResult

fn deserialize<__D>( __deserializer: __D, ) -> Result<MacroResult, <__D as Deserializer<'de>>::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl From<MacroforgeError> for MacroResult

fn from(err: MacroforgeError) -> MacroResult

Converts to this type from the input type.

impl From<MacroforgeErrors> for MacroResult

fn from(err: MacroforgeErrors) -> MacroResult

Converts to this type from the input type.

impl Serialize for MacroResult

fn serialize<__S>( &self, __serializer: __S, ) -> Result<<__S as Serializer>::Ok, <__S as Serializer>::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.