Struct ScalarValue

Source

pub struct ScalarValue { /* private fields */ }

Expand description

A scalar value with metadata about its style and content

Implementations§

Source §

impl ScalarValue

Source

pub fn string(value: impl Into<String>) -> Self

Create a scalar value explicitly treating it as a string (no type auto-detection)

This method always creates a String type scalar. The value will be properly quoted if needed when rendering to YAML, but no type detection is performed.

§Examples

use yaml_edit::ScalarValue;

let scalar = ScalarValue::string("123");
assert_eq!(scalar.scalar_type(), yaml_edit::ScalarType::String);
// Renders with quotes to distinguish from integer
assert_eq!(scalar.to_yaml_string(), "'123'");

let scalar = ScalarValue::string("true");
assert_eq!(scalar.scalar_type(), yaml_edit::ScalarType::String);
// Renders with quotes to distinguish from boolean
assert_eq!(scalar.to_yaml_string(), "'true'");

let scalar = ScalarValue::string("hello");
assert_eq!(scalar.scalar_type(), yaml_edit::ScalarType::String);
// Plain strings don't need quotes
assert_eq!(scalar.to_yaml_string(), "hello");

For YAML-style type detection (parsing “123” as Integer, “true” as Boolean), use ScalarValue::parse() instead.

Source

pub fn parse_escape_sequences(text: &str) -> String

Parse escape sequences in a double-quoted string

Source

pub fn with_style(value: impl Into<String>, style: ScalarStyle) -> Self

Create a new scalar with a specific style

Source

pub fn plain(value: impl Into<String>) -> Self

Create a plain scalar

Source

pub fn single_quoted(value: impl Into<String>) -> Self

Create a single-quoted scalar

Source

pub fn double_quoted(value: impl Into<String>) -> Self

Create a double-quoted scalar

Source

pub fn literal(value: impl Into<String>) -> Self

Create a literal scalar

Source

pub fn folded(value: impl Into<String>) -> Self

Create a folded scalar

Source

pub fn null() -> Self

Create a null scalar

Source

pub fn binary(data: &[u8]) -> Self

Create a binary scalar from raw bytes

Source

pub fn timestamp(value: impl Into<String>) -> Self

Create a timestamp scalar

Source

pub fn regex(pattern: impl Into<String>) -> Self

Create a regex scalar

Source

pub fn value(&self) -> &str

Get the raw value

Source

pub fn style(&self) -> ScalarStyle

Get the style

Source

pub fn scalar_type(&self) -> ScalarType

Get the scalar type

Source

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

Try to parse this scalar as an i64.

Returns None if the scalar type is not Integer.

Source

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

Try to parse this scalar as an f64.

Returns None if the scalar type is not Float.

Source

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

Try to parse this scalar as a bool.

Returns None if the scalar type is not Boolean. Recognizes: true, false, yes, no, on, off (case-insensitive).

Source

pub fn as_binary(&self) -> Option<Result<Vec<u8>, String>>

Extract binary data if this is a binary scalar

Source

pub fn is_binary(&self) -> bool

Check if this is a binary scalar

Source

pub fn is_timestamp(&self) -> bool

Check if this is a timestamp scalar

Source

pub fn is_regex(&self) -> bool

Check if this is a regex scalar

Source

pub fn coerce_to_type(&self, target_type: ScalarType) -> Option<ScalarValue>

Try to coerce this scalar to the specified type

Source

pub fn auto_detect_type(value: &str) -> ScalarType

Auto-detect the most appropriate scalar type from a string value

Source

pub fn parse(value: impl Into<String>) -> Self

Parse a YAML scalar value with automatic type detection

This method automatically detects the YAML type based on the content:

“123” → Integer
“3.14” → Float
“true” / “false” → Boolean
“null” / “~” → Null
etc.

§Examples

use yaml_edit::{ScalarValue, ScalarType};

let scalar = ScalarValue::parse("123");
assert_eq!(scalar.scalar_type(), ScalarType::Integer);
assert_eq!(scalar.to_yaml_string(), "123");

let scalar = ScalarValue::parse("true");
assert_eq!(scalar.scalar_type(), ScalarType::Boolean);
assert_eq!(scalar.to_yaml_string(), "true");

let scalar = ScalarValue::parse("hello");
assert_eq!(scalar.scalar_type(), ScalarType::String);
assert_eq!(scalar.to_yaml_string(), "hello");

To create a String-type scalar without auto-detection (e.g., to represent the string “123” rather than the integer 123), use ScalarValue::string() instead.

Source

pub fn from_scalar(scalar: &Scalar) -> Self

Create a ScalarValue from a Scalar syntax node, preserving the type from the lexer

This extracts type information directly from the token kind (INT, BOOL, FLOAT, etc.) rather than guessing based on heuristics. This is the correct way to convert parsed YAML into ScalarValue.

Source