Struct DocOpts

pub struct DocOpts {
    pub out_markdown: Option<PathBuf>,
}

The options for the opt2doc derive macro

TODO: add useful options

Fields

out_markdown: Option<PathBuf>

default to store at target/opt2doc/out.md

Implementations

impl DocOpts

pub fn read_opts(file_path: &Option<PathBuf>) -> DocOpts

read options either from default location of opt2doc.toml or from env var OPT2DOC_CFG_FILE determined config file

Trait Implementations

impl Debug for DocOpts

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

Formats the value using the given formatter.

impl Default for DocOpts

fn default() -> Self

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for DocOpts

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Serialize for DocOpts

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

where __S: Serializer,

Serialize this value into the given Serde serializer.