Struct SourceId 

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

Stable identity for a source analyzed by SurrealGuard.

This may be a real file URI, an embedded-query virtual URI, or any adapter-owned identifier. Spans should never travel without a source id.

Implementations

impl SourceId

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

Wraps an identifier string as a source id.

Examples found in repository

examples/conformance.rs (line 23)

fn main() {
    let path = std::env::args()
        .nth(1)
        .expect("usage: conformance <corpus.json>");
    let raw = std::fs::read_to_string(&path).expect("corpus file readable");
    let corpus: Vec<String> = parse_json_strings(&raw);

    let mut failures = 0usize;
    let mut report = String::new();
    for (index, query) in corpus.iter().enumerate() {
        let source = surrealguard_syntax::source::SourceId::new(format!("corpus:{index}"));
        let Ok(parsed) = surrealguard_syntax::parse::parse_source(source, query.as_str()) else {
            failures += 1;
            let _ = writeln!(report, "#{index}: parser returned no tree");
            continue;
        };
        if let Some(range) = first_broken_range(parsed.tree().root_node()) {
            failures += 1;
            let snippet: String = query[range.clone()].chars().take(60).collect();
            let context: String = query.chars().take(80).collect();
            let _ = writeln!(
                report,
                "#{index}: ERROR at {range:?}: `{}`\n    in: {}",
                snippet.replace('\n', " "),
                context.replace('\n', " ")
            );
        }
    }

    print!("{report}");
    println!(
        "---\n{failures}/{} corpus entries fail to parse",
        corpus.len()
    );
    if failures > 0 {
        std::process::exit(1);
    }
}

pub fn as_str(&self) -> &str

The underlying identifier string.

Trait Implementations

impl Clone for SourceId

fn clone(&self) -> SourceId

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for SourceId

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for SourceId

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for SourceId

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

Formats the value using the given formatter.

impl Eq for SourceId

impl From<&str> for SourceId

fn from(value: &str) -> Self

Converts to this type from the input type.

impl From<String> for SourceId

fn from(value: String) -> Self

Converts to this type from the input type.

impl Hash for SourceId

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 SourceId

fn cmp(&self, other: &SourceId) -> 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.

impl PartialEq for SourceId

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

Equality operator ==.

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

Inequality operator !=.

impl PartialOrd for SourceId

fn partial_cmp(&self, other: &SourceId) -> 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 Serialize for SourceId

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for SourceId