Struct Document 

pub struct Document(/* private fields */);

A single YAML document

Implementations

impl Document

pub fn new() -> Document

Create a new document

pub fn root_node(&self) -> Option<SyntaxNode<Lang>>

Get the root node of this document (could be mapping, sequence, or scalar)

pub fn as_mapping(&self) -> Option<Mapping>

Get this document as a mapping, if it is one

pub fn as_sequence(&self) -> Option<Sequence>

Get this document as a sequence, if it is one

pub fn as_scalar(&self) -> Option<Scalar>

Get this document as a scalar, if it is one

Trait Implementations

impl AstNode for Document

type Language = Lang

fn can_cast(kind: SyntaxKind) -> bool

fn cast(syntax: SyntaxNode<Lang>) -> Option<Self>

fn syntax(&self) -> &SyntaxNode<Lang>

fn clone_for_update(&self) -> Self

where Self: Sized,

fn clone_subtree(&self) -> Self

where Self: Sized,

impl Debug for Document

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

Formats the value using the given formatter.

impl Display for Document

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

Formats the value using the given formatter.

impl From<SyntaxNode<Lang>> for Document

fn from(node: SyntaxNode<Lang>) -> Self

Converts to this type from the input type.

impl Hash for Document

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl PartialEq for Document

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

impl StructuralPartialEq for Document