Struct SubSection

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

Fields

name: String

caption: Option<String>

header: Header

body: Option<(usize, String)>

is_commented: bool

line_number: usize

Implementations

impl SubSection

pub fn without_line_number(&self) -> Self

pub fn remove_comments(&self) -> SubSection

returns a copy of SubSection after processing comments

NOTE: This function is only used by Section::remove_comments()

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

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

pub fn body_or_caption(&self, doc_id: &str) -> Result<(String, bool)>

returns tuple (body/caption, from_caption)

i.e it either returns

• (body, false)
• (caption, true)

In case both or none are passed then it throws error

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

pub fn and_caption(self, caption: &str) -> 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(self, key: &str, value: &Option<String>) -> Self

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

where T: ToString + PartialEq,

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

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

Trait Implementations

impl Clone for SubSection

fn clone(&self) -> SubSection

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for SubSection

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

Formats the value using the given formatter.

impl Default for SubSection

fn default() -> SubSection

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for SubSection

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for SubSection

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

Formats the value using the given formatter.

impl PartialEq for SubSection

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

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 SubSection