Struct Config

pub struct Config {
    pub author: String,
    pub title: String,
    pub date: String,
    pub project_name: String,
    pub template: Option<String>,
    pub custom_template: Option<String>,
    pub paper_size: String,
    pub document_class: String,
    pub font_size: u8,
    pub packages: Vec<String>,
    pub only_files: Option<bool>,
}

The Config struct contains all necessary metadata information

• Author: The author of the project
• Title: The title of the document
• Date: The date for the document
• Project Name: The name for the project
• Template: The prebuilt template to use
• Paper-size: The paper-size for the document
• Document Class: The document class of the document
• Font size: The font size for the document
• Packages: Additional packages to add
• Only Files: Whether structure is project or files (default: false)

Fields

author: String

title: String

date: String

project_name: String

template: Option<String>

custom_template: Option<String>

paper_size: String

document_class: String

font_size: u8

packages: Vec<String>

only_files: Option<bool>

Implementations

impl Config

pub fn new( author: &str, title: &str, date: &str, project_name: &str, template: &Option<String>, custom_templates: &Option<String>, paper_size: &str, font_size: u8, packages: Vec<&str>, only_files: Option<bool>, document_class: &str, ) -> Self

Creates a new Config

pub fn to_string(&self) -> Result<String, Error>

Using toml::to_string_pretty(), turns Config into toml string for config.toml

pub fn from_string(s: String) -> Result<Self, Error>

From config.toml string, turns into Config

pub fn migrate() -> Result<String, Error>

Turns a v1 config.toml into v2 Config toml string

pub fn template(&self) -> TexCreateResult<Latex>

Grabs the tex_rs::Latex template from &self.template by matching the string

pub async fn build(&self, force: Option<bool>) -> TexCreateResult<()>

Builds project depending on Config.only_files

pub async fn zip_proj(&self, path: PathBuf) -> TexCreateResult<()>

Zips a project structure

pub async fn zip_files(&self, path: PathBuf) -> TexCreateResult<()>

Zips a only files structure

Trait Implementations

impl Clone for Config

fn clone(&self) -> Config

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for Config

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

Formats the value using the given formatter.

impl Default for Config

fn default() -> Self

Default settings for Config

impl<'de> Deserialize<'de> for Config

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl<'r> FromForm<'r> for Config

type Context = FromFormGeneratedContext<'r>

The form guard’s parsing context.

fn init(__opts: Options) -> Self::Context

Initializes and returns the parsing context for Self.

fn push_value(__c: &mut Self::Context, __f: ValueField<'r>)

Processes the value field field.

fn push_data<'life0, 'life1, 'async_trait>( __c: &'life0 mut FromFormGeneratedContext<'r>, __f: DataField<'r, 'life1>, ) -> Pin<Box<dyn Future<Output = ()> + Send + 'async_trait>>

where 'r: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait,

Processes the data field field.

fn push_error(__c: &mut Self::Context, __e: Error<'r>)

Processes the external form or field error _error.

fn finalize(__c: Self::Context) -> Result<Self, Errors<'r>>

Finalizes parsing. Returns the parsed value when successful or collection of Errors otherwise.

fn default(opts: Options) -> Option<Self>

Returns a default value, if any, to use when a value is desired and parsing fails.

impl Serialize for Config

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

where __S: Serializer,

Serialize this value into the given Serde serializer.