[−][src]Struct mdbook::renderer::RenderContext
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]
pub fn new<P, Q>(
root: P,
book: Book,
config: Config,
destination: Q
) -> RenderContext where
P: Into<PathBuf>,
Q: Into<PathBuf>,
[src]
root: P,
book: Book,
config: Config,
destination: Q
) -> RenderContext where
P: Into<PathBuf>,
Q: Into<PathBuf>,
Create a new RenderContext
.
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]
Load a RenderContext
from its JSON representation.
Trait Implementations
impl Clone for RenderContext
[src]
pub fn clone(&self) -> RenderContext
[src]
pub fn clone_from(&mut self, source: &Self)
1.0.0[src]
impl Debug for RenderContext
[src]
impl<'de> Deserialize<'de> for RenderContext
[src]
pub fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error> where
__D: Deserializer<'de>,
[src]
__D: Deserializer<'de>,
impl PartialEq<RenderContext> for RenderContext
[src]
pub fn eq(&self, other: &RenderContext) -> bool
[src]
pub fn ne(&self, other: &RenderContext) -> bool
[src]
impl Serialize for RenderContext
[src]
pub fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error> where
__S: Serializer,
[src]
__S: Serializer,
impl StructuralPartialEq for RenderContext
[src]
Auto Trait Implementations
impl RefUnwindSafe for RenderContext
[src]
impl Send for RenderContext
[src]
impl Sync for RenderContext
[src]
impl Unpin for RenderContext
[src]
impl UnwindSafe for RenderContext
[src]
Blanket Implementations
impl<T> Any for T where
T: 'static + ?Sized,
[src]
T: 'static + ?Sized,
impl<T> Borrow<T> for T where
T: ?Sized,
[src]
T: ?Sized,
impl<T> BorrowMut<T> for T where
T: ?Sized,
[src]
T: ?Sized,
pub fn borrow_mut(&mut self) -> &mut T
[src]
impl<T> DeserializeOwned for T where
T: for<'de> Deserialize<'de>,
[src]
T: for<'de> Deserialize<'de>,
impl<T> From<T> for T
[src]
impl<T, U> Into<U> for T where
U: From<T>,
[src]
U: From<T>,
impl<T> Same<T> for T
type Output = T
Should always be Self
impl<T> ToOwned for T where
T: Clone,
[src]
T: Clone,
type Owned = T
The resulting type after obtaining ownership.
pub fn to_owned(&self) -> T
[src]
pub fn clone_into(&self, target: &mut T)
[src]
impl<T, U> TryFrom<U> for T where
U: Into<T>,
[src]
U: Into<T>,
type Error = Infallible
The type returned in the event of a conversion error.
pub fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>
[src]
impl<T, U> TryInto<U> for T where
U: TryFrom<T>,
[src]
U: TryFrom<T>,
type Error = <U as TryFrom<T>>::Error
The type returned in the event of a conversion error.
pub fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>
[src]
impl<V, T> VZip<V> for T where
V: MultiLane<T>,
V: MultiLane<T>,