Struct GuideView 

pub struct GuideView {
    pub preamble: Vec<String>,
    pub sections: Vec<GuideSection>,
    pub epilogue: Vec<String>,
    pub usage: Vec<String>,
    pub commands: Vec<GuideEntry>,
    pub arguments: Vec<GuideEntry>,
    pub options: Vec<GuideEntry>,
    pub common_invocation_options: Vec<GuideEntry>,
    pub notes: Vec<String>,
}

Structured help/guide payload shared by the CLI, REPL, renderers, and semantic output pipeline.

Canonical help sections such as usage, commands, and options are exposed as dedicated buckets for ergonomic access. The generic GuideView::sections list exists to preserve authored section order during serialization and transforms, including canonical sections that were authored inline with custom content. Restore logic may backfill the dedicated buckets from those canonical sections, but renderers and serializers treat the ordered section list as authoritative whenever it already carries that content.

Public API note: this is intentionally an open semantic DTO. Callers may compose it directly for bespoke help payloads, while common generation paths are exposed as factory methods.

Fields

preamble: Vec<String>

Introductory paragraphs shown before structured sections.

sections: Vec<GuideSection>

Extra sections preserved outside the canonical buckets.

epilogue: Vec<String>

Closing paragraphs shown after structured sections.

usage: Vec<String>

Canonical usage synopsis lines.

commands: Vec<GuideEntry>

Canonical command-entry bucket.

arguments: Vec<GuideEntry>

Canonical positional-argument bucket.

options: Vec<GuideEntry>

Canonical option/flag bucket.

common_invocation_options: Vec<GuideEntry>

Canonical shared invocation-option bucket.

notes: Vec<String>

Canonical note paragraphs.

Implementations

impl GuideView

pub fn from_text(help_text: &str) -> Self

Parses plain help text into a structured guide view.

Examples

use osp_cli::guide::GuideView;

let guide = GuideView::from_text("Usage: osp theme <COMMAND>\n\nCommands:\n  list  Show\n");

assert_eq!(guide.usage, vec!["osp theme <COMMAND>".to_string()]);
assert_eq!(guide.commands[0].name, "list");
assert_eq!(guide.commands[0].short_help, "Show");

pub fn from_command_def(command: &CommandDef) -> Self

Builds a guide view from a command definition.

Examples

use osp_cli::core::command_def::CommandDef;
use osp_cli::guide::GuideView;

let command = CommandDef::new("theme")
    .about("Inspect themes")
    .subcommand(CommandDef::new("show").about("Show available themes"));
let guide = GuideView::from_command_def(&command);

assert_eq!(guide.usage, vec!["theme <COMMAND>".to_string()]);
assert_eq!(guide.commands[0].name, "show");
assert!(guide.arguments.is_empty());
assert!(guide.options.is_empty());

pub fn to_output_result(&self) -> OutputResult

Converts the guide into row output with a guide sidecar document.

Examples

use osp_cli::core::output_model::OutputDocumentKind;
use osp_cli::guide::GuideView;

let guide = GuideView {
    usage: vec!["theme show".to_string()],
    ..GuideView::default()
};
let output = guide.to_output_result();

assert_eq!(output.document.as_ref().map(|doc| doc.kind), Some(OutputDocumentKind::Guide));
assert_eq!(output.meta.render_recommendation.is_some(), true);
let rows = output.as_rows().expect("guide output should keep row projection");
assert_eq!(rows.len(), 1);
assert_eq!(rows[0]["usage"][0], "theme show");

pub fn to_json_value(&self) -> Value

Serializes the guide to its JSON object form.

Examples

use osp_cli::guide::GuideView;

let guide = GuideView::from_text("Usage: osp history <COMMAND>\n\nCommands:\n  list\n");
let value = guide.to_json_value();

assert_eq!(value["usage"][0], "osp history <COMMAND>");
assert_eq!(value["commands"][0]["name"], "list");
assert!(value.get("sections").is_none());

pub fn try_from_output_result(output: &OutputResult) -> Option<Self>

Attempts to recover a guide view from structured output.

A carried semantic document is authoritative. When output.document is present, this function only attempts to restore from that document and does not silently fall back to the row projection.

pub fn to_markdown(&self) -> String

Renders the guide as Markdown using the default width policy.

Examples

use osp_cli::guide::GuideView;

let guide = GuideView {
    usage: vec!["theme show".to_string()],
    commands: vec![osp_cli::guide::GuideEntry {
        name: "list".to_string(),
        short_help: "List themes".to_string(),
        display_indent: None,
        display_gap: None,
    }],
    ..GuideView::default()
};

let markdown = guide.to_markdown();

assert!(markdown.contains("## Usage"));
assert!(markdown.contains("theme show"));
assert!(markdown.contains("- `list` List themes"));

pub fn to_markdown_with_width(&self, width: Option<usize>) -> String

Renders the guide as Markdown using an optional target width.

pub fn to_value_lines(&self) -> Vec<String>

Flattens the guide into value-oriented text lines.

pub fn merge(&mut self, other: GuideView)

Appends another guide view into this one, preserving section order.

Trait Implementations

impl Clone for GuideView

fn clone(&self) -> GuideView

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for GuideView

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

Formats the value using the given formatter.

impl Default for GuideView

fn default() -> GuideView

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for GuideView

where GuideView: Default,

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for GuideView

fn eq(&self, other: &GuideView) -> 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 Serialize for GuideView

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl Eq for GuideView

impl StructuralPartialEq for GuideView