Struct orgize::Org

pub struct Org<'a> { /* fields omitted */ }

Methods

impl<'a> Org<'a>

pub fn new() -> Org<'static>

Create a new empty Org struct

pub fn parse(text: &'a str) -> Org<'a>

Create a new Org struct from parsing text, using the default ParseConfig

pub fn parse_with_config(content: &'a str, config: &ParseConfig) -> Org<'a>

Create a new Org struct from parsing text, using a custom ParseConfig

pub fn document(&self) -> DocumentNode

Return a DocumentNode

pub fn headlines<'b>(&'b self) -> impl Iterator<Item = HeadlineNode> + 'b

Return an iterator of HeadlineNode

pub fn arena(&self) -> &Arena<Element<'a>>

Return a refrence to underlay arena

pub fn arena_mut(&mut self) -> &mut Arena<Element<'a>>

Return a mutual reference to underlay arena

pub fn new_headline(&mut self, title: Title<'a>) -> HeadlineNode

Create a new headline and return it's HeadlineNode

pub fn iter<'b>(&'b self) -> impl Iterator<Item = Event<'a, 'b>> + 'b

Return an iterator of Event

pub fn html<W: Write>(&self, wrtier: W) -> Result<(), Error>

pub fn html_with_handler<W, H, E>(
    &self,
    writer: W,
    handler: &mut H
) -> Result<(), E> where
    W: Write,
    E: From<Error>,
    H: HtmlHandler<E>, 

pub fn org<W: Write>(&self, wrtier: W) -> Result<(), Error>

pub fn org_with_handler<W, H, E>(
    &self,
    writer: W,
    handler: &mut H
) -> Result<(), E> where
    W: Write,
    E: From<Error>,
    H: OrgHandler<E>, 

impl<'_> Org<'_>

pub fn validate(&self) -> Result<(), OrgizeError>

Validate an Org struct.

pub fn check(&self) -> Result<(), OrgizeError>

Deprecated since 0.3.1:

rename to validate

Validate an Org struct.

Trait Implementations

impl Default for Org<'static>

fn default() -> Self

Returns the "default value" for a type.

impl<'_> Serialize for Org<'_>

fn serialize<S: Serializer>(&self, serializer: S) -> Result<S::Ok, S::Error>

Serialize this value into the given Serde serializer.