Struct Note 

pub struct Note { /* private fields */ }

A multi-line note attached to a TaskPaper entry.

Internally stores lines as a Vec<String>. Supports conversion to/from single-line format and whitespace compression.

Implementations

impl Note

pub fn from_lines(lines: impl IntoIterator<Item = impl Into<String>>) -> Self

Create a note from a list of lines.

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

Create a note by splitting a single string on newlines.

pub fn new() -> Self

Create a new empty note.

pub fn add(&mut self, text: impl Into<String>)

Append lines to the note.

pub fn compress(&mut self)

Compress whitespace: collapse consecutive blank lines into one, remove leading and trailing blank lines, and trim trailing whitespace from each line.

pub fn is_empty(&self) -> bool

Return whether the note has no content.

pub fn len(&self) -> usize

Return the number of lines.

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

Return the lines as a slice.

pub fn to_line(&self, separator: &str) -> String

Convert to a single-line string with the given separator between lines.

Trait Implementations

impl Clone for Note

fn clone(&self) -> Note

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Note

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

Formats the value using the given formatter.

impl Default for Note

fn default() -> Note

Returns the “default value” for a type.

impl Display for Note

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

Format as multi-line text with each line prefixed by two tabs (TaskPaper note format).

impl FromStr for Note

type Err = Infallible

The associated error which can be returned from parsing.

fn from_str(text: &str) -> Result<Self, Self::Err>

Parses a string s to return a value of this type.

impl PartialEq for Note

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

impl StructuralPartialEq for Note