Struct rcmark::Node

pub struct Node { /* fields omitted */ }

An element of a CommonMark document. This includes headers, paragraphs, links, and various other types. Nodes have a variety of properties depending on their type, all of which are exposed here. However, attempting to access a property that does not apply to the node's type will result in a panic. Setters return true or false to indicate whether the node was updated successfully.

Methods

impl Node

unsafe fn from_raw(raw: *mut cmark_node, owned: bool) -> Node

Wrap a raw cmark_node in a Node instance. Since libcmark uses cmark_node pointers for both owned and unowned references, ownership must be manually specified. This is to ensure that, for example, the return value of node.parent() is not freed but the return value of Node::new is.

Examples

extern crate libcmark_sys as raw;
extern crate rcmark;

unsafe {
    let raw_node = raw::cmark_node_new(raw::CMARK_NODE_LIST);
    let my_node = rcmark::Node::from_raw(raw_node, false);
}

fn new(node_type: NodeType) -> Node

Create a new node of type node_type. Other type-specific properties will not be initialized.

Examples

use rcmark::{Node, NodeType};

let my_node = Node::new(NodeType::Paragraph);

fn next(&self) -> Option<Node>

Get the next node in sequence after this one, or None if there is not a subsequent node.

Examples

use rcmark::{Node, parse_document, DEFAULT};

let my_doc = parse_document("*Hello*", DEFAULT);
match my_doc.next() {
    Some(node) => panic!("Should not be an adjacent node"),
    None       => (),
}

fn previous(&self) -> Option<Node>

Get the previous node in the sequence from this one, or None if there is no prior node.

fn parent(&self) -> Option<Node>

Get the parent node that contains this node, or None if this node does not have a parent.

fn first_child(&self) -> Option<Node>

Get the first child of this node, or None if this node has no children.

fn last_child(&self) -> Option<Node>

Get the last child of this node, or None if this node has no children.

fn iter(&self) -> NodeIterator

Create a new iterator over this node and its children.

fn node_type(&self) -> NodeType

Get the type of this node.

Examples

use rcmark::{Node, NodeType};

let my_node = Node::new(NodeType::Strong);
assert_eq!(NodeType::Strong, my_node.node_type());

fn type_string(&self) -> &str

fn literal(&self) -> &str

fn set_literal(&mut self, value: &str) -> bool

fn header_level(&self) -> i32

fn set_header_level(&mut self, value: i32) -> bool

fn list_type(&self) -> ListType

fn set_list_type(&mut self, value: ListType) -> bool

fn list_delim(&self) -> DelimType

fn set_list_delim(&mut self, value: DelimType) -> bool

fn list_start(&self) -> i32

fn set_list_start(&mut self, value: i32) -> bool

fn list_tight(&self) -> bool

fn set_list_tight(&mut self, value: bool) -> bool

fn fence_info(&self) -> &str

fn set_fence_info(&mut self, value: &str) -> bool

fn url(&self) -> &str

fn set_url(&mut self, value: &str) -> bool

fn title(&self) -> &str

fn set_title(&mut self, value: &str) -> bool

fn start_line(&self) -> i32

fn start_column(&self) -> i32

fn end_column(&self) -> i32

fn end_line(&self) -> i32

fn unlink(&mut self)

fn insert_before(&mut self, sibling: &mut Node) -> bool

fn insert_after(&mut self, sibling: &mut Node) -> bool

fn prepend_child(&mut self, child: &mut Node) -> bool

fn append_child(&mut self, child: &mut Node) -> bool

fn consolidate_text_nodes(&mut self)

Trait Implementations

impl Drop for Node

fn drop(&mut self)

A method called when the value goes out of scope.

impl Debug for Node

fn fmt(&self, fmt: &mut Formatter) -> Result<(), Error>

Formats the value using the given formatter.