Struct TaggedNode 

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

A YAML tagged scalar (tag + value)

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 TaggedNode

pub fn tag(&self) -> Option<String>

Get the tag part of this tagged scalar (e.g., “!custom” from “!custom value”)

pub fn resolved_tag(&self) -> Option<String>

The tag as the %TAG directives of its document resolve it: in the !! shorthand for a tag in the tag:yaml.org,2002: namespace however it is written, verbatim (!<uri>) for another tag a declared handle expands, and as written otherwise.

With %TAG !y! tag:yaml.org,2002: in effect, !y!int resolves to !!int; tag still gives !y!int.

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

Get the value part of this tagged scalar (without the tag)

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

Get the collection this tag is attached to, if the tagged node wraps a mapping (e.g. !custom on a block mapping).

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

Get the collection this tag is attached to, if the tagged node wraps a sequence (e.g. !!seq on a flow sequence).

pub fn as_string(&self) -> Option<String>

Get the string value of this tagged scalar (just the value part), with quotes stripped and escape sequences processed.

Returns None if the tag is on a collection or alias.

pub fn as_set(&self) -> Option<Set>

Extract a set from this tagged node if it has a !!set tag on a mapping.

pub fn as_ordered_mapping(&self) -> Option<Vec<MappingEntry>>

Extract ordered mapping from this tagged node if it has a !!omap tag on a sequence.

Returns the entries of the inner sequence as MappingEntry values, each holding a single key-value pair with full CST fidelity.

pub fn as_pairs(&self) -> Option<Vec<MappingEntry>>

Extract pairs from this tagged node if it has a !!pairs tag on a sequence.

Returns the entries of the inner sequence as MappingEntry values. Unlike !!omap, duplicate keys are allowed.

Trait Implementations

impl AsYaml for TaggedNode

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

Content on lines after the tag (a block collection, say) is shifted to start at column indent, as for an untagged collection. Content starting on the tag line (a flow collection) is shifted like an untagged flow collection, keeping its continuation lines’ offset from indent.

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 is_inline(&self) -> bool

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

impl AstNode for TaggedNode

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 TaggedNode

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for TaggedNode

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

Formats the value using the given formatter.

impl Display for TaggedNode

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

Formats the value using the given formatter.

impl Eq for TaggedNode

impl Hash for TaggedNode

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 TaggedNode

fn eq(&self, other: &Self) -> bool

Equality operator ==.

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=.

impl StructuralPartialEq for TaggedNode