Struct takeoff::launchpad::Launchpad

#[non_exhaustive]pub struct Launchpad {
    pub compile_sass: bool,
    pub mode: Mode,
    pub output: PathBuf,
    pub source: PathBuf,
    pub statics: Vec<(String, String)>,
    pub templates: Templates,
    pub tera: Tera,
}

The entry point for Takeoff.

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

compile_sass: bool

If set to true, any .scss files found in Launchpad::statics will be compiled and output as CSS with grass. Sass partials (.scss files starting with an underscore) will also be skipped.

Defaults to false.

mode: Mode

The Launchpad mode.

• Mode::Development will render all Documents.
• Mode::Production only renders Documents with is_draft = false and will trigger a complete rebuild of the site (completely removing output before starting).

Defaults to Mode::Development

output: PathBuf

The root directory to output the site files to.

Defaults to "public".

source: PathBuf

The root directory to look for Markdown and static files.

Defaults to "source".

statics: Vec<(String, String)>

Static files to copy or process*.

The first string in the tuple should be a valid glob string that targets files to copy. Relative to Launchpad::source.

And the second string should be a directory to copy the files matched by the glob to. Relative to Launchpad::output.

* Optionally, some files can be automatically processed as well, see Launchpad::compile_sass.

templates: Templates

Templating settings.

tera: Tera

The tera instance to re-use for templating.

Implementations

impl Launchpad

pub fn prepare() -> LaunchpadBuilder

Creates a new LaunchpadBuilder.

pub fn parse_documents(&self) -> Result<Vec<Document>>

Parses and returns all Documents defined by this Launchpad.

pub fn take_off(&self) -> Result<()>

Generates the site defined by this Launchpad.

Trait Implementations

impl Debug for Launchpad

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for Launchpad

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error> where
    __D: Deserializer<'de>, 

Deserialize this value from the given Serde deserializer.

impl Serialize for Launchpad

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error> where
    __S: Serializer, 

Serialize this value into the given Serde serializer.