Struct SyntaxReference 

pub struct SyntaxReference {
    pub value: String,
    pub raw: Option<String>,
}

A reference read from a document, together with the text it was written as.

Equality, hashing, ordering and Display use the value only, so 1 and '1' are equal references and a LiNo<SyntaxReference> formats exactly like the LiNo<String> with the same values. raw and quote say how the reference was written.

Examples

use links_notation::{LiNo, SyntaxReference, parse_lino_to_syntax_links};

let links = parse_lino_to_syntax_links("(t 1 '1')").unwrap();
let LiNo::Link { values, .. } = &links[0] else { unreachable!() };
let (LiNo::Ref(bare), LiNo::Ref(quoted)) = (&values[1], &values[2]) else {
    unreachable!()
};
assert_eq!(bare, quoted);
assert_eq!(bare.raw.as_deref(), Some("1"));
assert_eq!(quoted.raw.as_deref(), Some("'1'"));
assert_eq!((bare.quote(), quoted.quote()), (None, Some('\'')));
assert_eq!(quoted.to_string(), "1");
assert_eq!(SyntaxReference::from("x").raw, None);

Fields

value: String

What the reference means: its delimiters and escapes resolved and a versioned literal decoded. This is the ID parse_lino_to_links reads.

raw: Option<String>

The reference exactly as the document wrote it: quotes, doubled quote runs and ~1{...} literal syntax included, and the line breaks of a multi-line quoted reference. Taken from the document as the caller passed it, comments included. None for a reference built in code.

Implementations

impl SyntaxReference

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

A reference that was not read from a document, so it has no raw text.

pub fn with_raw(value: impl Into<String>, raw: impl Into<String>) -> Self

A reference with the text it was written as.

pub fn as_str(&self) -> &str

What the reference means, the same as value.

pub fn quote(&self) -> Option<char>

The delimiter the reference was written between: ', " or ` when it was quoted, and None when it was bare, a versioned literal, or not read from a document. See reference_quote.

Trait Implementations

impl Clone for SyntaxReference

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 SyntaxReference

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

Formats the value using the given formatter.

impl Default for SyntaxReference

fn default() -> Self

Returns the “default value” for a type.

impl Display for SyntaxReference

Writes the value, unescaped, the way a String ID is written: a LiNo quotes it where the notation needs quotes, so a LiNo<SyntaxReference> prints exactly what the LiNo<String> prints.

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

Formats the value using the given formatter.

impl Eq for SyntaxReference

impl From<&str> for SyntaxReference

fn from(value: &str) -> Self

Converts to this type from the input type.

impl From<String> for SyntaxReference

fn from(value: String) -> Self

Converts to this type from the input type.

impl From<SyntaxReference> for String

fn from(reference: SyntaxReference) -> Self

Converts to this type from the input type.

impl Hash for SyntaxReference

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 Ord for SyntaxReference

fn cmp(&self, other: &Self) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized,

Restrict a value to a certain interval.

fn clamp_to<R>(self, range: R) -> Self

where Self: Sized, R: ClampBounds<Self>,

🔬This is a nightly-only experimental API. (clamp_to)

Restrict a value to a certain range.

impl PartialEq for SyntaxReference

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

Equality operator ==.

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

Inequality operator !=.

impl PartialEq<&str> for SyntaxReference

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

Equality operator ==.

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

Inequality operator !=.

impl PartialEq<String> for SyntaxReference

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

Equality operator ==.

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

Inequality operator !=.

impl PartialEq<str> for SyntaxReference

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

Equality operator ==.

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

Inequality operator !=.

impl PartialOrd for SyntaxReference

fn partial_cmp(&self, other: &Self) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

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

Tests less than (for self and other) and is used by the < operator.

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

Tests less than or equal to (for self and other) and is used by the <= operator.

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

Tests greater than (for self and other) and is used by the > operator.

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

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl StreamReference for SyntaxReference