Struct Org

pub struct Org { /* private fields */ }

Org data structure.

Implementations

impl Org

pub fn new() -> Org

Returns an empty root-level Org struct.

pub fn from_file(fname: &str) -> Result<Org>

Reads an Org struct from a given file path.

pub fn from_vec(contents: &[String]) -> Result<Org>

Reads an Org struct from contents.

pub fn to_file(&self, fname: &str) -> Result<()>

Writes an Org struct to a file.

pub fn to_file_crlf(&self, fname: &str) -> Result<()>

Writes an Org struct to a file using carriage returns with a line feed (CRLF).

pub fn to_vec(&self) -> Vec<String>

Writes an Org struct to a Vec<String>.

pub fn depth(&self) -> usize

Returns the depth of the tree.

pub fn heading(&self) -> &str

Returns the heading of the tree.

pub fn set_heading(&mut self, heading: &str)

Sets the heading of the tree.

pub fn full_heading(&self) -> String

Gets the full heading for the tree, including beginning asterisks.

pub fn content_as_ref(&self) -> &Vec<String>

Returns a reference to the content of the tree.

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

Returns a mutable reference to the content of the tree.

pub fn subtrees_as_ref(&self) -> &Vec<Org>

Returns a reference to the subtrees of the tree.

pub fn subtrees_as_mut(&mut self) -> &mut Vec<Org>

Returns a mutable reference to the subtrees of the tree.

Trait Implementations

impl Clone for Org

fn clone(&self) -> Org

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Org

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

Formats the value using the given formatter.

impl Default for Org

fn default() -> Org

Returns the “default value” for a type.

impl Display for Org

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

Formats the value using the given formatter.

impl<'a> PartialEq<&'a str> for Org

fn eq(&self, other: &&str) -> 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<'a> PartialEq<Org> for &'a str

fn eq(&self, other: &Org) -> 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 PartialEq<Org> for String

fn eq(&self, other: &Org) -> 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 PartialEq<String> for Org

fn eq(&self, other: &String) -> 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 PartialEq for Org

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