Struct RustDocBuilder

pub struct RustDocBuilder { /* private fields */ }

Implementations

impl RustDocBuilder

pub fn new() -> Self

pub fn deps(self, yes: bool) -> Self

Include dependencies

Reasons to have this disabled:

• Faster API extraction
• Less likely to hit bugs in rustdoc, like
  • rust-lang/rust#89097
  • rust-lang/rust#83718

Reasons to have this enabled:

• Check for accidental inclusion of dependencies in your API
• Detect breaking changes from dependencies in your API

pub fn target_directory(self, path: impl Into<PathBuf>) -> Self

pub fn silence(self, yes: bool) -> Self

Don’t write progress to stderr

pub fn color(self, yes: impl Into<Option<bool>>) -> Self

Whether stderr can be colored

pub fn dump_raw(self, manifest_path: &Path) -> Result<String, Error>

pub fn into_api(self, manifest_path: &Path) -> Result<Api, Error>

Trait Implementations

impl Clone for RustDocBuilder

fn clone(&self) -> RustDocBuilder

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for RustDocBuilder

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

Formats the value using the given formatter.

impl Default for RustDocBuilder

fn default() -> Self

Returns the “default value” for a type.

impl PartialEq for RustDocBuilder

fn eq(&self, other: &RustDocBuilder) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Eq for RustDocBuilder

impl StructuralPartialEq for RustDocBuilder