Struct DocBuilder 

pub struct DocBuilder { /* private fields */ }

Runs docs builds in a separate process with a minimal environment.

The build compiles untrusted crates, which run build scripts and proc macros. The child process re-executes the Kellnr binary with the hidden DOC_BUILD_SUBCOMMAND, optionally prefixed by an operator supplied wrapper (e.g. bubblewrap) for further confinement.

Implementations

impl DocBuilder

pub fn new( program: PathBuf, wrapper: Vec<String>, cratesio_index: Option<String>, ) -> Self

pub fn with_timeout(self, timeout: Duration) -> Self

Kill builds that run longer than timeout, including all processes they started. Duration::ZERO disables the timeout.

pub async fn build(&self, crate_path: &Path) -> Result<(), DocsError>

Build the docs of the crate at crate_path into crate_path/target/doc.

Trait Implementations

impl Clone for DocBuilder

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for DocBuilder

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

Formats the value using the given formatter.