Struct Options 

pub struct Options {
    pub source_path_const_name: Option<Cow<'static, str>>,
    pub serde_support: SerdeSupport,
    pub parse: ParseOptions,
    pub structs: StructOptions,
    pub enums: EnumOptions,
    pub files: FilesOptions,
    pub output: OutputOptions,
}

Contains the full set of options for all public APIs in this crate.

Fields

source_path_const_name: Option<Cow<'static, str>>

In present, generates a const with this name that stores the path of the original markup file.

serde_support: SerdeSupport

Controls whether generated items should derive serde traits.

parse: ParseOptions

See ParseOptions.

structs: StructOptions

See StructOptions.

enums: EnumOptions

See EnumOptions.

files: FilesOptions

See FilesOptions.

output: OutputOptions

See OutputOptions.

Implementations

impl Options

pub const fn new() -> Options

Examples

assert_eq!(Options::new(), Options {
    source_path_const_name: Some("SOURCE_PATH".into()),
    serde_support: SerdeSupport::No,
    parse: ParseOptions::new(),
    structs: StructOptions::new(),
    enums: EnumOptions::new(),
    files: FilesOptions::new(),
    output: OutputOptions::new(),
});

pub const fn serde_default() -> Options

Examples

assert_eq!(Options::serde_default(), Options {
    source_path_const_name: Some("SOURCE_PATH".into()),
    serde_support: SerdeSupport::Yes,
    parse: ParseOptions::new(),
    structs: StructOptions::new(),
    enums: EnumOptions::new(),
    files: FilesOptions::new(),
    output: OutputOptions::new(),
});

pub const fn minimal() -> Options

assert_eq!(Options::minimal(), Options {
    source_path_const_name: None,
    serde_support: SerdeSupport::No,
    parse: ParseOptions::new(),
    structs: StructOptions::minimal(),
    enums: EnumOptions::minimal(),
    files: FilesOptions::minimal(),
    output: OutputOptions::new(),
});

Trait Implementations

impl Clone for Options

fn clone(&self) -> Options

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Options

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

Formats the value using the given formatter.

impl Default for Options

fn default() -> Options

Examples

assert_eq!(Options::default(), Options::new());

impl PartialEq for Options

fn eq(&self, other: &Options) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Eq for Options

impl StructuralPartialEq for Options