Come disattivare l'esecuzione di un test doc?

Question

Sto scrivendo una libreria Ruggine e voglio fornire esempi nella mia documentazione

1. compilare come parte della corsa cargo test
2. fanno non corsa.

È possibile?

Sto scrivendo una libreria client di database e gli esempi utilizzano un server di database ipotetico, non esistente. Di conseguenza, gli esempi falliscono sempre durante l'esecuzione, ma è importante che gli esempi siano validi sintatticamente. Da qui le mie esigenze sopra.

Se non c'è modo di fare ciò che voglio, allora come si fa a rinunciare allo cargo test per eseguire un test doc specifico? Ad esempio, avere cargo run compilare ed eseguire alcuni test di documentazione ma ignorarne completamente altri?

Answer 1

Questo è documentato in The Rust Programming Language, in particolare lo chapter about documentation.

vostra apertura delimitatore codeblock dovrebbe essere simile:

/// ```rust,no_run 

Dal libro:

/// ```rust,no_run 
/// loop { 
///  println!("Hello, world"); 
/// } 
/// ``` 

L'attributo no_run sarà compilare il codice, ma non eseguirlo. Questo è importante per esempi come "Ecco come recuperare una pagina web", , che si desidera garantire compila, ma potrebbe essere eseguito in un ambiente di prova che non ha accesso alla rete.