Struct Scalar 

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

A YAML scalar 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 Scalar

pub fn value(&self) -> String

Get the string value of this scalar

pub fn as_string(&self) -> String

Get the string representation of this scalar, properly unquoted and unescaped

pub fn is_quoted(&self) -> bool

Check if this scalar is quoted

pub fn unquoted_value(&self) -> String

Get the raw content of this scalar with outer quotes stripped, but without processing any escape sequences.

For most purposes as_string is more appropriate as it fully unescapes double-quoted strings (\", \\, \n, etc.) and handles the '' → ' escape in single-quoted strings. Use this method only when you need the verbatim content without escape processing.

impl Scalar

pub fn set_value(&self, value: &str)

Replace the text content of this scalar with value.

The token is stored with SyntaxKind::STRING regardless of the semantic type of value (e.g., setting "42" does not produce an INT token). If token-kind accuracy matters, build a replacement scalar node via the higher-level API instead.

pub fn byte_range(&self) -> TextPosition

Get the byte offset range of this scalar in the source text.

Returns the start and end byte offsets as a TextPosition.

pub fn start_position(&self, source_text: &str) -> LineColumn

Get the line and column where this scalar starts.

Requires the original source text to calculate line/column from byte offsets. Line and column numbers are 1-indexed.

Arguments

• source_text - The original YAML source text

pub fn end_position(&self, source_text: &str) -> LineColumn

Get the line and column where this scalar ends.

Requires the original source text to calculate line/column from byte offsets. Line and column numbers are 1-indexed.

Arguments

• source_text - The original YAML source text

pub fn as_i64(&self) -> Option<i64>

Try to interpret this scalar as an i64.

Returns None if the scalar is quoted (string type) or cannot be parsed as an integer. Supports decimal, octal (0o), hexadecimal (0x), and binary (0b) notation.

pub fn as_f64(&self) -> Option<f64>

Try to interpret this scalar as an f64.

Returns None if the scalar is quoted (string type) or cannot be parsed as a float.

pub fn as_bool(&self) -> Option<bool>

Try to interpret this scalar as a bool.

Returns None if the scalar is quoted (string type) or is not a recognized boolean value. Recognizes: true, false, True, False, TRUE, FALSE, yes, no, Yes, No, YES, NO, on, off, On, Off, ON, OFF

pub fn is_null(&self) -> bool

Check if this scalar represents a null value.

Returns true if the unquoted value is null, Null, NULL, ~, or empty.

Trait Implementations

impl AsYaml for Scalar

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 Scalar

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 Scalar

fn clone(&self) -> Scalar

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Scalar

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

Formats the value using the given formatter.

impl Display for Scalar

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

Formats the value using the given formatter.

impl From<Scalar> for ScalarValue

fn from(scalar: Scalar) -> Self

Converts to this type from the input type.

impl Hash for Scalar

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 Scalar

fn eq(&self, other: &Scalar) -> 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 TryFrom<&Scalar> for bool

type Error = ScalarConversionError

The type returned in the event of a conversion error.

fn try_from(scalar: &Scalar) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<&Scalar> for f64

type Error = ScalarConversionError

The type returned in the event of a conversion error.

fn try_from(scalar: &Scalar) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<&Scalar> for i64

type Error = ScalarConversionError

The type returned in the event of a conversion error.

fn try_from(scalar: &Scalar) -> Result<Self, Self::Error>

Performs the conversion.

impl YamlAccept for Scalar

fn accept<V: YamlVisitor>(&self, visitor: &mut V)

Accept a visitor for traversal

impl Eq for Scalar

impl StructuralPartialEq for Scalar