Struct Section 

pub struct Section {
    pub name: String,
    pub caption: Option<String>,
    pub header: Header,
    pub body: Option<(usize, String)>,
    pub sub_sections: SubSections,
    pub is_commented: bool,
    pub line_number: usize,
}

Fields

name: String

caption: Option<String>

header: Header

body: Option<(usize, String)>

sub_sections: SubSections

is_commented: bool

line_number: usize

Implementations

impl Section

pub fn remove_comments(&self) -> Section

returns a copy of Section after processing comments

NOTE: This function is only called by ParsedDocument::ignore_comments()

pub fn caption(&self, line_number: usize, doc_id: &str) -> Result<String>

pub fn body(&self, line_number: usize, doc_id: &str) -> Result<String>

pub fn assert_missing( &self, line_number: usize, key: &str, doc_id: &str, ) -> Result<()>

pub fn with_name(name: &str) -> Self

pub fn without_line_number(&self) -> Self

pub fn and_caption(self, caption: &str) -> Self

pub fn and_optional_caption(self, value: &Option<Rendered>) -> Self

pub fn add_header(self, key: &str, value: &str) -> Self

pub fn add_optional_header_bool(self, key: &str, value: Option<bool>) -> Self

pub fn add_optional_header_i32(self, key: &str, value: &Option<i32>) -> Self

pub fn add_header_if_not_equal<T>( self, key: &str, value: T, reference: T, ) -> Self

where T: ToString + PartialEq,

pub fn add_optional_header(self, key: &str, value: &Option<String>) -> Self

pub fn and_body(self, body: &str) -> Self

pub fn and_optional_body(self, body: &Option<String>) -> Self

pub fn add_sub_section(self, sub: SubSection) -> Self

pub fn sub_sections_by_name(&self, name: &str) -> Vec<&SubSection>

pub fn sub_section_by_name( &self, name: &str, doc_id: String, ) -> Result<&SubSection>

Trait Implementations

impl Clone for Section

fn clone(&self) -> Section

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Section

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

Formats the value using the given formatter.

impl Default for Section

fn default() -> Section

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for Section

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for Section

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

Formats the value using the given formatter.

impl PartialEq for Section

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

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for Section