Skip to main content

FileTimes

Struct FileTimes 

Source
pub struct FileTimes<'a> {
    pub source_modified_us: &'a dyn Fn(&str) -> Option<u64>,
    pub doctree_exists: &'a dyn Fn(&str) -> bool,
    pub dependency_modified_us: &'a dyn Fn(&Path) -> Option<u64>,
}
Expand description

What BuildEnvironment::get_outdated_files needs to know about the filesystem, as the three questions it actually asks — so the computation itself stays pure and the caller decides what “the source of docname” and “the doctree of docname” mean.

Times are microseconds since the Unix epoch, the unit all_docs stores (Sphinx’s _last_modified_time). None means “cannot be stated” — the file is gone, or unstat-able — which is Sphinx’s except OSError: return True: the document is outdated.

Fields§

§source_modified_us: &'a dyn Fn(&str) -> Option<u64>

Modification time of the document’s own source file.

§doctree_exists: &'a dyn Fn(&str) -> bool

Whether the document’s persisted doctree is on disk. Sphinx stats doctreedir/<docname>.doctree; a doctree that exists but can no longer be read is caught later, when the read phase tries to load it, and re-read then.

§dependency_modified_us: &'a dyn Fn(&Path) -> Option<u64>

Modification time of one of a document’s dependencies entries.

Auto Trait Implementations§

§

impl<'a> !RefUnwindSafe for FileTimes<'a>

§

impl<'a> !Send for FileTimes<'a>

§

impl<'a> !Sync for FileTimes<'a>

§

impl<'a> !UnwindSafe for FileTimes<'a>

§

impl<'a> Freeze for FileTimes<'a>

§

impl<'a> Unpin for FileTimes<'a>

§

impl<'a> UnsafeUnpin for FileTimes<'a>

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

impl<T> Pointable for T

Source§

const ALIGN: usize

The alignment of pointer.
Source§

type Init = T

The type for initializers.
Source§

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more
Source§

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more
Source§

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more
Source§

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = !

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, !>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.