Struct public_api::Builder

pub struct Builder { /* private fields */ }

Builds PublicApis. See the top level module docs for example code.

Implementations

impl Builder

pub fn from_rustdoc_json(path: impl Into<PathBuf>) -> Self

Create a new PublicApi builder from a rustdoc JSON file. See the top level module docs for example code.

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

If true, items will be sorted before being returned. If you will pass on the return value to diff::PublicApiDiff::between, it is currently unnecessary to sort first, because the sorting will be performed/ensured inside of that function.

The default value is true, because usually the performance impact is negligible, and is is generally more practical to work with sorted data.

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

If true, item paths include the so called “sorting prefix” that makes them grouped in a nice way. Only intended for debugging this library.

The default value is false

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

If true, items that belongs to Blanket Implementations are omitted from the output. This makes the output less noisy, at the cost of not fully describing the public API.

Examples of Blanket Implementations: impl<T> Any for T, impl<T> Borrow<T> for T, and impl<T, U> Into<U> for T where U: From<T>

The default value is false so that the listed public API is complete by default.

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

If true, items that belongs to Auto Trait Implementations are omitted from the output. This makes the output less noisy, at the cost of not fully describing the public API.

Examples of Auto Trait Implementations: impl Send for Foo, impl Sync for Foo, and impl Unpin for Foo

The default value is false so that the listed public API is complete by default.

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

If true, items that belongs to automatically derived implementations (Clone, Debug, Eq, etc) are omitted from the output. This makes the output less noisy, at the cost of not fully describing the public API.

The default value is false so that the listed public API is complete by default.

pub fn build(self) -> Result<PublicApi>

Builds PublicApi. See the top level module docs for example code.

Errors

E.g. if the JSON is invalid or if the file can’t be read.

Trait Implementations

impl Clone for Builder

fn clone(&self) -> Builder

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Builder

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

Formats the value using the given formatter.