pub struct DocsTree { /* private fields */ }
Expand description
A tree representing the docs directory.
Implementations§
Source§impl DocsTree
impl DocsTree
Sourcepub fn root_relative_to<P>(&self, path: P) -> PathBuf
pub fn root_relative_to<P>(&self, path: P) -> PathBuf
Get the path to the root directory relative to a given path.
Sourcepub fn stylesheet(&self) -> PathBuf
pub fn stylesheet(&self) -> PathBuf
Get the absolute path to the stylesheet.
Sourcepub fn render_all(&self) -> Result<(), Error>
pub fn render_all(&self) -> Result<(), Error>
Render every page in the tree.
Trait Implementations§
Auto Trait Implementations§
impl Freeze for DocsTree
impl !RefUnwindSafe for DocsTree
impl !Send for DocsTree
impl !Sync for DocsTree
impl Unpin for DocsTree
impl !UnwindSafe for DocsTree
Blanket Implementations§
Source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
Source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more
Source§impl<T> Instrument for T
impl<T> Instrument for T
Source§fn instrument(self, span: Span) -> Instrumented<Self>
fn instrument(self, span: Span) -> Instrumented<Self>
Source§fn in_current_span(self) -> Instrumented<Self>
fn in_current_span(self) -> Instrumented<Self>
Source§impl<T> IntoEither for T
impl<T> IntoEither for T
Source§fn into_either(self, into_left: bool) -> Either<Self, Self>
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 moreSource§fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
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