Struct SyntaxError 

pub struct SyntaxError {
    pub code: u16,
    pub message: String,
    pub offset: TextSize,
}

A single syntax error record. Spec §4.3 + §10.

cyrs-syntax does not depend on cyrs-diag (§3.1), so this is a local stand-in carrying just the minimum a later pass needs to lift it into a full Diagnostic: a stable numeric code (matching the DiagCode discriminants in cyrs-diag), a human-readable message, and the byte offset at which it was emitted.

Embedders should not match on the raw u16 code field — names survive renumbering, magic numbers do not (cy-emb3). When cyrs-diag is on the dependency graph (typically via cyrs-db), lift the numeric to the typed enum:

use cyrs_diag::DiagCode;
match DiagCode::from(err) {
    DiagCode::E0007 => { /* expected statement */ }
    _ => { /* other syntax codes */ }
}

Fields

code: u16

Numeric value of the DiagCode discriminant (e.g. 3 for E0003).

message: String

Human-readable message (rustc-style lower-case initial, no trailing period).

offset: TextSize

Byte offset at which the error was emitted. Typically the position of the offending token.

Trait Implementations

impl Clone for SyntaxError

fn clone(&self) -> SyntaxError

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for SyntaxError

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

Formats the value using the given formatter.

impl Display for SyntaxError

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

Formats the value using the given formatter.

impl Error for SyntaxError

fn source(&self) -> Option<&(dyn Error + 'static)>

Returns the lower-level source of this error, if any.

fn description(&self) -> &str

👎Deprecated since 1.42.0:

use the Display impl or to_string()

fn cause(&self) -> Option<&dyn Error>

👎Deprecated since 1.33.0:

replaced by Error::source, which can support downcasting

fn provide<'a>(&'a self, request: &mut Request<'a>)

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

Provides type-based access to context intended for error reports.