Struct Alias 

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

A YAML alias reference (e.g., *anchor_name)

Note: This type uses interior mutability through the rowan library. Mutation methods work even when called through &self. See the crate-level documentation for details on the mutability model.

Implementations

impl Alias

pub fn value(&self) -> String

Get the full text of this alias including the * prefix

pub fn name(&self) -> String

Get the anchor name this alias refers to (without the * prefix)

Examples

use yaml_edit::Document;
use std::str::FromStr;

let yaml = r#"
anchor: &my_anchor
  key: value
reference: *my_anchor
"#;

let doc = Document::from_str(yaml).unwrap();
let mapping = doc.as_mapping().unwrap();
let reference = mapping.get("reference").unwrap();

if let yaml_edit::YamlNode::Alias(alias) = reference {
    assert_eq!(alias.name(), "my_anchor");
}

Trait Implementations

impl AsYaml for Alias

fn as_node(&self) -> Option<&SyntaxNode<Lang>>

Returns a reference to the underlying SyntaxNode if one exists.

fn kind(&self) -> YamlKind

Returns the kind of YAML value this represents.

fn build_content( &self, builder: &mut GreenNodeBuilder<'_>, _indent: usize, _flow_context: bool, ) -> bool

Serialize this value into a GreenNodeBuilder.

fn is_inline(&self) -> bool

Returns whether this value should be rendered on the same line as its key.

impl AstNode for Alias

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 Clone for Alias

fn clone(&self) -> Alias

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Alias

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

Formats the value using the given formatter.

impl Display for Alias

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

Formats the value using the given formatter.

impl Hash for Alias

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 Alias

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

impl StructuralPartialEq for Alias