Struct rustme::Configuration

pub struct Configuration {
    pub relative_to: PathBuf,
    pub files: HashMap<String, FileConfiguration>,
    pub glossaries: Vec<Glossary>,
}

A configuration of how to generate one or more READMEs.

Fields

relative_to: PathBuf

The location that paths should be resolved relative to.

files: HashMap<String, FileConfiguration>

The collection of files (key) and sections (values).

glossaries: Vec<Glossary>

A list of glossaries that act as a source of snippets.

Implementations

impl Configuration

pub fn load<P: AsRef<Path>>(path: P) -> Result<Self, Error>

Attempts to load a configuration from path.

Errors

• Error::Io: Returned if an error occurs interacting with the filesystem.
• Error::Ron: Returned if an error occurs while parsing the configuration file.

pub fn generate(&self, release: bool) -> Result<(), Error>

Generates the README files.

Errors

Can return various errors that are encountred with files that could not be parsed.

pub fn generate_with_cache(
    &self,
    release: bool,
    cache: &mut Cache
) -> Result<(), Error>

Generates the README files using cache to load glossaries and snippets.

Errors

Can return various errors that are encountred with files that could not be parsed.

Trait Implementations

impl Debug for Configuration

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for Configuration

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

Deserialize this value from the given Serde deserializer.

impl Serialize for Configuration

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

Serialize this value into the given Serde serializer.