Struct Config 

pub struct Config {
    pub input: Option<Vec<PathBuf>>,
    pub include: Option<Vec<PathBuf>>,
    pub output: Option<Vec<PathBuf>>,
    pub output_schemas: Option<Vec<PathBuf>>,
    pub output_paths: Option<Vec<PathBuf>>,
    pub output_fragments: Option<Vec<PathBuf>>,
    pub config_file: Option<PathBuf>,
}

Fields

input: Option<Vec<PathBuf>>

Input directories to scan for Rust files and OpenAPI fragments

include: Option<Vec<PathBuf>>

Specific files to include (e.g., .json, .yaml)

output: Option<Vec<PathBuf>>

Output file(s) for the generated OpenAPI definition (defaults to openapi.yaml)

output_schemas: Option<Vec<PathBuf>>

Output file(s) for just the components/schemas section

output_paths: Option<Vec<PathBuf>>

Output file(s) for just the paths section

output_fragments: Option<Vec<PathBuf>>

Output file(s) for the full spec minus root details (fragments)

config_file: Option<PathBuf>

Path to a configuration file (toml)

Implementations

impl Config

pub fn load() -> Self

Load configuration with priority:

1. CLI Arguments (Highest)
2. –config file
3. openapi.toml
4. Cargo.toml [package.metadata.oas-forge]

Trait Implementations

impl Args for Config

fn group_id() -> Option<Id>

Report the ArgGroup::id for this set of arguments

fn augment_args<'b>(__clap_app: Command) -> Command

Append to Command so it can instantiate Self via FromArgMatches::from_arg_matches_mut

fn augment_args_for_update<'b>(__clap_app: Command) -> Command

Append to Command so it can instantiate self via FromArgMatches::update_from_arg_matches_mut

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 CommandFactory for Config

fn command<'b>() -> Command

Build a Command that can instantiate Self.

fn command_for_update<'b>() -> Command

Build a Command that can update self.

impl Debug for Config

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

Formats the value using the given formatter.

impl Default for Config

fn default() -> Config

Returns the “default value” for a type.

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

where Config: Default,

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl FromArgMatches for Config

fn from_arg_matches(__clap_arg_matches: &ArgMatches) -> Result<Self, Error>

Instantiate Self from ArgMatches, parsing the arguments as needed.

fn from_arg_matches_mut( __clap_arg_matches: &mut ArgMatches, ) -> Result<Self, Error>

Instantiate Self from ArgMatches, parsing the arguments as needed.

fn update_from_arg_matches( &mut self, __clap_arg_matches: &ArgMatches, ) -> Result<(), Error>

Assign values from ArgMatches to self.

fn update_from_arg_matches_mut( &mut self, __clap_arg_matches: &mut ArgMatches, ) -> Result<(), Error>

Assign values from ArgMatches to self.

impl Parser for Config

fn parse() -> Self

Parse from std::env::args_os(), exit on error.

fn try_parse() -> Result<Self, Error>

Parse from std::env::args_os(), return Err on error.

fn parse_from<I, T>(itr: I) -> Self

where I: IntoIterator<Item = T>, T: Into<OsString> + Clone,

Parse from iterator, exit on error.

fn try_parse_from<I, T>(itr: I) -> Result<Self, Error>

where I: IntoIterator<Item = T>, T: Into<OsString> + Clone,

Parse from iterator, return Err on error.

fn update_from<I, T>(&mut self, itr: I)

where I: IntoIterator<Item = T>, T: Into<OsString> + Clone,

Update from iterator, exit on error.

fn try_update_from<I, T>(&mut self, itr: I) -> Result<(), Error>

where I: IntoIterator<Item = T>, T: Into<OsString> + Clone,

Update from iterator, return Err on error.