Struct orgize::Org

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

Implementations

impl<'_> Org<'_>

pub fn document(&self) -> Document

Returns the Document.

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

Returns an iterator of Headlines.

impl<'a> Org<'a>

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

Creates a new empty Org struct.

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

Parses string text into Org struct.

pub fn parse_string(text: String) -> Org<'static>

Likes parse, but accepts String.

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

Parses string text into Org struct with custom ParseConfig.

pub fn parse_string_custom(text: String, config: &ParseConfig) -> Org<'static>

Likes parse_custom, but accepts String.

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

Returns a reference to the underlay arena.

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

Returns a mutual reference to the underlay arena.

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

Returns an iterator of Events.

pub fn keywords(&self) -> impl Iterator<Item = &Keyword>

Returns an iterator of Keywords.

pub fn write_html<W>(&self, writer: W) -> Result<(), Error> where
    W: Write, 

Writes an Org struct as html format.

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

Writes an Org struct as html format with custom HtmlHandler.

pub fn write_org<W>(&self, writer: W) -> Result<(), Error> where
    W: Write, 

Writes an Org struct as org format.

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

Writes an Org struct as org format with custom OrgHandler.

impl<'_> Org<'_>

pub fn validate(&self) -> Vec<ValidationError>

Validates an Org struct.

Trait Implementations

impl Default for Org<'static>

fn default() -> Self

Returns the "default value" for a type.

impl<'a> Index<NodeId> for Org<'a>

type Output = Element<'a>

The returned type after indexing.

fn index(&self, node_id: NodeId) -> &Self::Output

Performs the indexing (container[index]) operation.

impl<'a> IndexMut<NodeId> for Org<'a>

fn index_mut(&mut self, node_id: NodeId) -> &mut Self::Output

Performs the mutable indexing (container[index]) operation.

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

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

Serialize this value into the given Serde serializer.