Struct GuideSection 

pub struct GuideSection {
    pub title: String,
    pub kind: GuideSectionKind,
    pub paragraphs: Vec<String>,
    pub entries: Vec<GuideEntry>,
    pub data: Option<Value>,
}

One logical section within a GuideView.

Custom sections live here directly. Canonical sections may also be represented here when authored inline with custom content. Restore logic may mirror canonical sections into the dedicated GuideView buckets for ergonomic access, but it should not reorder or delete the authored section list.

Fields

title: String

User-facing section heading.

kind: GuideSectionKind

Semantic kind used for normalization and rendering policy.

paragraphs: Vec<String>

Paragraph content rendered before any entries.

entries: Vec<GuideEntry>

Structured rows rendered within the section.

data: Option<Value>

Arbitrary semantic data rendered through the normal value/document path.

Markdown template imports use this for fenced osp blocks so authors can embed structured data without forcing the final output to be literal source JSON.

Implementations

impl GuideSection

pub fn new(title: impl Into<String>, kind: GuideSectionKind) -> Self

Creates a new guide section with a title and canonical kind.

Examples

use osp_cli::guide::{GuideSection, GuideSectionKind};

let section = GuideSection::new("Notes", GuideSectionKind::Notes)
    .paragraph("first")
    .entry("show", "Display");

assert_eq!(section.paragraphs, vec!["first".to_string()]);
assert_eq!(section.entries[0].name, "show");
assert_eq!(section.entries[0].short_help, "Display");

pub fn paragraph(self, text: impl Into<String>) -> Self

Appends a paragraph to the section.

pub fn data(self, value: Value) -> Self

Attaches semantic data to the section.

Renderers may choose the best presentation for this payload instead of showing the authoring JSON literally.

pub fn entry( self, name: impl Into<String>, short_help: impl Into<String>, ) -> Self

Appends a named entry row to the section.

Trait Implementations

impl Clone for GuideSection

fn clone(&self) -> GuideSection

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for GuideSection

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

Formats the value using the given formatter.

impl Default for GuideSection

fn default() -> GuideSection

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for GuideSection

where GuideSection: 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 GuideSection

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

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 GuideSection

impl StructuralPartialEq for GuideSection