Struct CustomAnnotation 

pub struct CustomAnnotation {
    pub name: String,
    pub value: String,
    pub line: usize,
}

A custom (non-native) annotation captured verbatim from the SQL source.

Scythe parses its known annotations (@name, @returns, @param, @nullable, @nonnull, @json, @optional, @group_by, @deprecated) into typed fields. Any other -- @<name> <value> line is captured here as an opaque triple and exposed to crate consumers, who can layer their own annotation vocabulary on top of scythe without coupling scythe to their domain.

Fields

name: String

Annotation name, lowercased, without the leading @ (e.g. http, http_param).

value: String

Everything after the name on the line, trimmed. Empty if the annotation had no value.

line: usize

1-based line number within the query SQL, for diagnostics.

Trait Implementations

impl Clone for CustomAnnotation

fn clone(&self) -> CustomAnnotation

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for CustomAnnotation

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

Formats the value using the given formatter.

impl PartialEq for CustomAnnotation

fn eq(&self, other: &CustomAnnotation) -> 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 Eq for CustomAnnotation

impl StructuralPartialEq for CustomAnnotation