Struct public_api::Options

#[non_exhaustive]
pub struct Options {
    pub sorted: bool,
    pub debug_sorting: bool,
    pub omit_blanket_impls: bool,
    pub omit_auto_trait_impls: bool,
    pub omit_auto_derived_impls: bool,
}

Contains various options that you can pass to PublicApi::from_rustdoc_json.

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

sorted: bool

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.

debug_sorting: bool

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

omit_blanket_impls: bool

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.

omit_auto_trait_impls: bool

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.

omit_auto_derived_impls: bool

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.

Trait Implementations

impl Clone for Options

fn clone(&self) -> Options

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Options

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

Formats the value using the given formatter.

impl Default for Options

Enables options to be set up like this (note that Options is marked #[non_exhaustive]):

let mut options = Options::default();
options.sorted = true;
// ...

fn default() -> Self

Returns the “default value” for a type.

impl Copy for Options