Struct StringValue 

pub struct StringValue<'src> {
    pub is_block: bool,
    pub span: ByteSpan,
    pub syntax: Option<Box<StringValueSyntax<'src>>>,
    pub value: Cow<'src, str>,
}

A GraphQL string value.

Per the String Value section of the spec, string values may be quoted strings or block strings. This struct contains the processed string after escape-sequence resolution and block-string indentation stripping. Borrows from source when no transformation was needed; owned when escapes were resolved or block-string stripping produced a non-contiguous result.

Fields

is_block: bool

Whether this string was written as a block string ("""...""") rather than a quoted string ("..."). Both forms produce the same semantic value after processing, but tools (formatters, schema differs) may need to preserve or inspect the original form.

span: ByteSpan

syntax: Option<Box<StringValueSyntax<'src>>>

value: Cow<'src, str>

The processed string value after escape-sequence resolution and block-string indentation stripping.

Implementations

impl StringValue<'_>

pub fn append_source(&self, sink: &mut String, source: Option<&str>)

See AstNode::append_source().

pub fn byte_span(&self) -> ByteSpan

Returns this string value’s byte-offset span within the source text.

The returned ByteSpan can be resolved to line/column positions via source_span() or ByteSpan::resolve().

pub fn source_span(&self, source_map: &SourceMap<'_>) -> Option<SourceSpan>

Resolves this string value’s position to line/column coordinates using the given SourceMap.

Returns None if the byte offsets cannot be resolved (e.g. the span was synthetically constructed without valid position data).

Trait Implementations

impl AstNode for StringValue<'_>

fn append_source(&self, sink: &mut String, source: Option<&str>)

See AstNode::append_source().

fn byte_span(&self) -> ByteSpan

Returns this string value’s byte-offset span within the source text.

The returned ByteSpan can be resolved to line/column positions via source_span() or ByteSpan::resolve().

fn source_span(&self, source_map: &SourceMap<'_>) -> Option<SourceSpan>

Resolves this string value’s position to line/column coordinates using the given SourceMap.

Returns None if the byte offsets cannot be resolved (e.g. the span was synthetically constructed without valid position data).

fn to_source(&self, source: Option<&str>) -> String

Return this node as a source string.

impl<'src> Clone for StringValue<'src>

fn clone(&self) -> StringValue<'src>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<'src> Debug for StringValue<'src>

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

Formats the value using the given formatter.

impl<'src> PartialEq for StringValue<'src>

fn eq(&self, other: &StringValue<'src>) -> 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<'src> StructuralPartialEq for StringValue<'src>