Struct rustdoc_json::BuildOptions

pub struct BuildOptions { /* private fields */ }

Contains all options for crate::build().

See crate for an example on how to use it.

Implementations

impl BuildOptions

pub fn toolchain(self, toolchain: impl AsRef<OsStr>) -> Self

Set the toolchain. Default: None, which in practice means "+stable". Until rustdoc JSON has stabilized, you will want to set this to "+nightly" or similar.

pub fn manifest_path(self, manifest_path: impl AsRef<Path>) -> Self

Set the relative or absolute path to Cargo.toml. Default: Cargo.toml

pub fn quiet(self, quiet: bool) -> Self

Whether or not to pass --quiet to cargo rustdoc. Default: false

Trait Implementations

impl Debug for BuildOptions

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

Formats the value using the given formatter.

impl Default for BuildOptions

fn default() -> Self

Returns the “default value” for a type.