Как добавить примеры к документации макросов в rust?

Question

При написании макроса я хотел бы документально оформить его, и это включает в себя примеры.
Но когда я пытаюсь сделать это так же, как обычную функцию, я получаю:

[E0468]: an `extern crate` loading macros must be at the crate root 

я бегу cargo test на ночь, чтобы проверить следующее:

// src/lib.rs in crate with name advent9

/// this macro essentialy appends .as_bytes()
/// `b!("bla")` -> `"bla".as_bytes()`
///
/// # Examples
/// ```
/// #[macro_use]
/// extern crate advent9;
///
/// let bytes : &[u8] = b!("this is a bytestring");
///
/// println!("{:?}", bytes);
/// // prints:
/// // [116, 104, 105, 115, 32, 105, 115, 32, 97, 32, 98, 121, 116, 101, 115, 116, 114, 105, 110, 103]
/// ```
// I don't need this exported, but perhaps the example does?
#[macro_export] 
macro_rules! b {
    ($string:expr) => {
        $string.as_bytes()
    }

Насколько я понимаю, doctests заключается в том, что каждый из них обернут в свои main функция. Как это:

fn main() {
    #[macro_use]
    extern crate advent9;

    let bytes : &[u8] = b!("this is a bytestring");

    println!("{:?}", bytes);
    // prints:
    // [116, 104, 105, 115, 32, 105, 115, 32, 97, 32, 98, 121, 116, 101, 115, 116, 114, 105, 110, 103]
}

Если это правильно, это объяснит ошибку.

Есть ли способ добавить примеры в макросы?

Answer 1

Это возможно, хотя и немного запутанно; вам нужно сделать это следующим образом:

/// # Example
/// ```
/// # #[macro_use] extern crate crate_name;
/// # fn main() {
/// use crate_name::module::object;
///
/// <example code>
/// # }
/// ```
#[macro_export]
macro_rules! some_macro {
    <macro code>
}