Struct Outdated 

pub struct Outdated {
    pub added: BTreeSet<String>,
    pub changed: BTreeSet<String>,
    pub removed: BTreeSet<String>,
}

The three sets env.get_outdated_files splits the project into (environment/__init__.py:521-554).

added and changed are both read; they are kept apart because Sphinx keeps them apart — the distinction drives the glob-toctree rule below and the %s added, %s changed, %s removed progress line.

Fields

added: BTreeSet<String>

Documents the environment has never seen.

changed: BTreeSet<String>

Documents whose recorded read is no longer good enough.

removed: BTreeSet<String>

Documents the environment knows that the project no longer has. Each must be BuildEnvironment::clear_doc’d.

Implementations

impl Outdated

pub fn to_read(&self) -> BTreeSet<String>

The documents this build has to read: added | changed.

Trait Implementations

impl Clone for Outdated

fn clone(&self) -> Outdated

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Outdated

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

Formats the value using the given formatter.

impl Default for Outdated

fn default() -> Outdated

Returns the “default value” for a type.

impl Eq for Outdated

impl PartialEq for Outdated

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for Outdated