Struct mdbook::renderer::RenderContext [−][src]
pub struct RenderContext { pub version: String, pub root: PathBuf, pub book: Book, pub config: Config, pub destination: PathBuf, // some fields omitted }
Expand description
The context provided to all renderers.
Fields
version: String
Which version of mdbook
did this come from (as written in mdbook
’s
Cargo.toml
). Useful if you know the renderer is only compatible with
certain versions of mdbook
.
root: PathBuf
The book’s root directory.
book: Book
A loaded representation of the book itself.
config: Config
The loaded configuration file.
destination: PathBuf
Where the renderer must put any build artefacts generated. To allow renderers to cache intermediate results, this directory is not guaranteed to be empty or even exist.
Implementations
impl RenderContext
[src]
impl RenderContext
[src]pub fn new<P, Q>(
root: P,
book: Book,
config: Config,
destination: Q
) -> RenderContext where
P: Into<PathBuf>,
Q: Into<PathBuf>,
[src]
pub fn new<P, Q>(
root: P,
book: Book,
config: Config,
destination: Q
) -> RenderContext where
P: Into<PathBuf>,
Q: Into<PathBuf>,
[src]Create a new RenderContext
.
pub fn source_dir(&self) -> PathBuf
[src]
pub fn source_dir(&self) -> PathBuf
[src]Get the source directory’s (absolute) path on disk.
pub fn from_json<R: Read>(reader: R) -> Result<RenderContext>
[src]
pub fn from_json<R: Read>(reader: R) -> Result<RenderContext>
[src]Load a RenderContext
from its JSON representation.
Trait Implementations
impl Clone for RenderContext
[src]
impl Clone for RenderContext
[src]fn clone(&self) -> RenderContext
[src]
fn clone(&self) -> RenderContext
[src]Returns a copy of the value. Read more
fn clone_from(&mut self, source: &Self)
1.0.0[src]
fn clone_from(&mut self, source: &Self)
1.0.0[src]Performs copy-assignment from source
. Read more
impl Debug for RenderContext
[src]
impl Debug for RenderContext
[src]impl<'de> Deserialize<'de> for RenderContext
[src]
impl<'de> Deserialize<'de> for RenderContext
[src]fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error> where
__D: Deserializer<'de>,
[src]
fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error> where
__D: Deserializer<'de>,
[src]Deserialize this value from the given Serde deserializer. Read more
impl PartialEq<RenderContext> for RenderContext
[src]
impl PartialEq<RenderContext> for RenderContext
[src]fn eq(&self, other: &RenderContext) -> bool
[src]
fn eq(&self, other: &RenderContext) -> bool
[src]This method tests for self
and other
values to be equal, and is used
by ==
. Read more
fn ne(&self, other: &RenderContext) -> bool
[src]
fn ne(&self, other: &RenderContext) -> bool
[src]This method tests for !=
.
impl Serialize for RenderContext
[src]
impl Serialize for RenderContext
[src]impl StructuralPartialEq for RenderContext
[src]
Auto Trait Implementations
impl RefUnwindSafe for RenderContext
impl Send for RenderContext
impl Sync for RenderContext
impl Unpin for RenderContext
impl UnwindSafe for RenderContext
Blanket Implementations
impl<T> BorrowMut<T> for T where
T: ?Sized,
[src]
impl<T> BorrowMut<T> for T where
T: ?Sized,
[src]pub fn borrow_mut(&mut self) -> &mut T
[src]
pub fn borrow_mut(&mut self) -> &mut T
[src]Mutably borrows from an owned value. Read more
impl<T> ToOwned for T where
T: Clone,
[src]
impl<T> ToOwned for T where
T: Clone,
[src]type Owned = T
type Owned = T
The resulting type after obtaining ownership.
pub fn to_owned(&self) -> T
[src]
pub fn to_owned(&self) -> T
[src]Creates owned data from borrowed data, usually by cloning. Read more
pub fn clone_into(&self, target: &mut T)
[src]
pub fn clone_into(&self, target: &mut T)
[src]🔬 This is a nightly-only experimental API. (toowned_clone_into
)
recently added
Uses borrowed data to replace owned data, usually by cloning. Read more
impl<V, T> VZip<V> for T where
V: MultiLane<T>,
impl<V, T> VZip<V> for T where
V: MultiLane<T>,
pub fn vzip(self) -> V
impl<T> DeserializeOwned for T where
T: for<'de> Deserialize<'de>,
[src]
T: for<'de> Deserialize<'de>,