Struct Section 

pub struct Section { /* private fields */ }

A named section in a TaskPaper doing file containing an ordered list of entries.

Sections correspond to top-level headings in the doing file format (e.g. Currently:, Archive:). Each section holds a title and a sequence of entries that belong to it.

Implementations

impl Section

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

Create a new section with the given title and no entries.

pub fn add_entry(&mut self, entry: Entry)

Add an entry to the end of this section.

pub fn entries(&self) -> &[Entry]

Return a slice of all entries in this section.

pub fn entries_mut(&mut self) -> &mut Vec<Entry>

Return a mutable slice of all entries in this section.

pub fn into_entries(self) -> Vec<Entry>

Consume the section and return its entries.

pub fn is_empty(&self) -> bool

Return true if this section contains no entries.

pub fn len(&self) -> usize

Return the number of entries in this section.

pub fn remove_entry(&mut self, id: &str) -> usize

Remove all entries whose ID matches the given ID, returning the number removed.

pub fn title(&self) -> &str

Return the section title.

pub fn trailing_content(&self) -> &[String]

Return a slice of trailing content lines (non-entry lines after entries).

pub fn trailing_content_mut(&mut self) -> &mut Vec<String>

Return a mutable reference to trailing content lines.

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 Display for Section

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

Format as a TaskPaper section: title line followed by indented entries with notes.