Enum rustdoc::passes::Pass

pub enum Pass {
    EarlyPass {
        name: &'static str,
        pass: fn(_: Crate, _: &DocContext) -> Crate,
        description: &'static str,
    },
    LatePass {
        name: &'static str,
        pass: fn(_: Crate) -> Crate,
        description: &'static str,
    },
}

Represents a single pass.

Variants

EarlyPass

An "early pass" is run in the compiler context, and can gather information about types and traits and the like.

Fields of EarlyPass

name: &'static str
pass: fn(_: Crate, _: &DocContext) -> Crate
description: &'static str

LatePass

A "late pass" is run between crate cleaning and page generation.

Fields of LatePass

name: &'static str
pass: fn(_: Crate) -> Crate
description: &'static str

Methods

impl Pass

pub const fn early(     name: &'static str,     pass: fn(_: Crate, _: &DocContext) -> Crate,     description: &'static str ) -> Pass

Constructs a new early pass.

pub const fn late(     name: &'static str,     pass: fn(_: Crate) -> Crate,     description: &'static str ) -> Pass

Constructs a new late pass.

pub fn name(self) -> &'static str

Returns the name of this pass.

pub fn description(self) -> &'static str

Returns the description of this pass.

pub fn early_fn(self) -> Option<fn(_: Crate, _: &DocContext) -> Crate>

If this pass is an early pass, returns the pointer to its function.

pub fn late_fn(self) -> Option<fn(_: Crate) -> Crate>

If this pass is a late pass, returns the pointer to its function.

Trait Implementations

impl Copy for Pass

impl Clone for Pass

fn clone(&self) -> Pass

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Pass

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

Formats the value using the given formatter.