Struct Guide 

pub struct Guide { /* private fields */ }

Implementations

impl Guide

pub fn new_default(dir: PathBuf, template_extension: &str) -> Self

pub fn add_step( &mut self, step: &StepRef, after_step: Option<&StepRef>, code_extension: Option<Extension>, before_after_extension: Option<Extension>, )

pub fn get_step_dir(&self, step: &StepRef) -> Option<&StepDir>

pub fn steps_iter(&self) -> StepsIter<'_>

pub fn template(&self) -> &String

pub fn render_template(&self, steps: String) -> String

pub fn render_guide(&self) -> String

Trait Implementations

impl DirStructure for Guide

impl HasField<DirStructure> for Guide

type Inner = Versioned<JsonPretty<Steps>>

fn resolve_path(__dir_structure_path: PathBuf) -> PathBuf

impl HasField<DirStructure> for Guide

type Inner = ForceCreateDirChildren<StepDir>

fn resolve_path(__dir_structure_path: PathBuf) -> PathBuf

impl HasField<DirStructure> for Guide

type Inner = Option<String>

fn resolve_path(__dir_structure_path: PathBuf) -> PathBuf

impl HasField<DirStructure> for Guide

type Inner = Option<String>

fn resolve_path(__dir_structure_path: PathBuf) -> PathBuf

impl HasField<DirStructure> for Guide

type Inner = DirChildSingle<String, TemplateFilter>

fn resolve_path(__dir_structure_path: PathBuf) -> PathBuf

impl ReadFrom for Guide

fn read_from(__dir_structure_path: &Path) -> Result<Self>

where Self: Sized,

Reads the structure from the specified path, which can be either a file or a directory.

impl WriteTo for Guide

fn write_to(&self, __dir_structure_path: &Path) -> Result<()>

Writes the structure to the specified path.