Struct ApiRefArgs 

pub struct ApiRefArgs {
    pub json: bool,
    pub path: Option<String>,
}

Generate flodl API reference.

Fields

json: bool

Emit machine-readable JSON.

path: Option<String>

Explicit flodl source path (defaults to detected project root).

Trait Implementations

impl Debug for ApiRefArgs

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

Formats the value using the given formatter.

impl FdlArgsTrait for ApiRefArgs

fn try_parse_from(args: &[String]) -> Result<Self, String>

Parse from an explicit argv slice. First element is the program name (ignored), following elements are flags/values/positionals.

fn schema() -> Schema

Return the JSON schema for this CLI shape.

fn render_help() -> String

Render --help to a string.

fn parse() -> Self

Parse argv into Self. Uses std::env::args() by default.

fn render_help_path(argv: &[String]) -> String

Render --help for a specific argv path (program name first, then the tokens typed). The default ignores the path and returns Self::render_help — correct for a single struct, whose help is context-free.