jots 0.2.0

Jot Syntax 1.0 RC6 parser (https://jotsyntax.org)
Documentation
//! Parser-output wire types (§8).
//!
//! Field order matches the SPEC §8 example output verbatim so the
//! emitted JSON reads naturally; serde's `preserve_order` feature on
//! `serde_json` (set in Cargo.toml) honors it.

use serde::Serialize;

#[derive(Debug, Clone, Serialize)]
pub struct Loc {
    pub unit: &'static str,
    pub start: usize,
    pub end: usize,
}

#[derive(Debug, Clone, Serialize)]
pub struct Fragment {
    pub start: u64,
    pub end: u64,
    pub raw: String,
}

#[derive(Debug, Clone, Serialize)]
pub struct BookmarkRange {
    pub start_bookmark: Option<String>,
    pub end_bookmark: Option<String>,
}

#[derive(Debug, Clone, Serialize)]
pub struct Reference {
    pub id: String,
    pub fragment: Option<Fragment>,
    pub bookmark: Option<String>,
    pub bookmark_range: Option<BookmarkRange>,
    pub category: Option<String>,
    pub tags: Vec<String>,
    #[serde(skip_serializing_if = "Option::is_none")]
    pub loc: Option<Loc>,
    #[serde(skip_serializing_if = "Option::is_none")]
    pub raw: Option<String>,
}

#[derive(Debug, Clone, Serialize)]
pub struct CrossReference {
    pub space: String,
    pub id: String,
    pub fragment: Option<Fragment>,
    pub bookmark: Option<String>,
    pub bookmark_range: Option<BookmarkRange>,
    pub category: Option<String>,
    pub tags: Vec<String>,
    #[serde(skip_serializing_if = "Option::is_none")]
    pub loc: Option<Loc>,
    #[serde(skip_serializing_if = "Option::is_none")]
    pub raw: Option<String>,
}

#[derive(Debug, Clone, Serialize)]
pub struct FileReference {
    pub filepath: String,
    pub fragment: Option<Fragment>,
    pub bookmark: Option<String>,
    pub bookmark_range: Option<BookmarkRange>,
    pub category: Option<String>,
    pub tags: Vec<String>,
    #[serde(skip_serializing_if = "Option::is_none")]
    pub loc: Option<Loc>,
    #[serde(skip_serializing_if = "Option::is_none")]
    pub raw: Option<String>,
}

#[derive(Debug, Clone, Serialize)]
pub struct CrossFileReference {
    pub space: String,
    pub filepath: String,
    pub fragment: Option<Fragment>,
    pub bookmark: Option<String>,
    pub bookmark_range: Option<BookmarkRange>,
    pub category: Option<String>,
    pub tags: Vec<String>,
    #[serde(skip_serializing_if = "Option::is_none")]
    pub loc: Option<Loc>,
    #[serde(skip_serializing_if = "Option::is_none")]
    pub raw: Option<String>,
}

#[derive(Debug, Clone, Serialize)]
pub struct Resource {
    pub filename: String,
    pub fragment: Option<Fragment>,
    pub bookmark: Option<String>,
    pub bookmark_range: Option<BookmarkRange>,
    pub category: Option<String>,
    pub tags: Vec<String>,
    #[serde(skip_serializing_if = "Option::is_none")]
    pub loc: Option<Loc>,
    #[serde(skip_serializing_if = "Option::is_none")]
    pub raw: Option<String>,
}

#[derive(Debug, Clone, Serialize)]
pub struct InterJotResource {
    pub space: Option<String>,
    pub id: Option<String>,
    pub filepath: Option<String>,
    pub filename: String,
    pub resource_fragment: Option<Fragment>,
    pub resource_bookmark: Option<String>,
    pub resource_bookmark_range: Option<BookmarkRange>,
    pub category: Option<String>,
    pub tags: Vec<String>,
    #[serde(skip_serializing_if = "Option::is_none")]
    pub loc: Option<Loc>,
    #[serde(skip_serializing_if = "Option::is_none")]
    pub raw: Option<String>,
}

#[derive(Debug, Clone, Serialize)]
pub struct Url {
    pub url: String,
    pub label: Option<String>,
    #[serde(skip_serializing_if = "Option::is_none")]
    pub loc: Option<Loc>,
    #[serde(skip_serializing_if = "Option::is_none")]
    pub raw: Option<String>,
}

#[derive(Debug, Clone, Serialize)]
pub struct Bookmark {
    pub name: String,
    #[serde(skip_serializing_if = "Option::is_none")]
    pub loc: Option<Loc>,
    #[serde(skip_serializing_if = "Option::is_none")]
    pub raw: Option<String>,
}

#[derive(Debug, Clone, Serialize)]
pub struct Blocker {
    pub action: String,
    pub cat: Option<String>,
    pub tags: Vec<String>,
}

#[derive(Debug, Clone, Serialize)]
pub struct Todo {
    pub importance: u8,
    pub blockers: Vec<Blocker>,
    pub action: String,
    pub categories: Vec<String>,
    pub tags: Vec<String>,
    pub due: Option<String>,
    pub completed: Option<String>,
    pub description: String,
    pub references: Vec<Reference>,
    pub cross_references: Vec<CrossReference>,
    pub file_references: Vec<FileReference>,
    pub cross_file_references: Vec<CrossFileReference>,
    pub inter_jot_resources: Vec<InterJotResource>,
    pub resources: Vec<Resource>,
    pub urls: Vec<Url>,
    #[serde(skip_serializing_if = "Option::is_none")]
    pub loc: Option<Loc>,
    #[serde(skip_serializing_if = "Option::is_none")]
    pub raw: Option<String>,
    /// Done-marker flag (`??.` form) — routing only, not a wire field.
    #[serde(skip)]
    pub done: bool,
}

#[derive(Debug, Clone, Serialize)]
pub struct Diagnostic {
    pub code: String,
    pub severity: &'static str,
    pub message: String,
    /// `None` serializes as `null` — configuration-scope diagnostics
    /// have no source construct (§10.1).
    pub loc: Option<Loc>,
}

#[derive(Debug, Clone, Serialize)]
pub struct ParseResult {
    pub tags: Vec<String>,
    pub categories: Vec<String>,
    pub references: Vec<Reference>,
    pub cross_references: Vec<CrossReference>,
    pub file_references: Vec<FileReference>,
    pub cross_file_references: Vec<CrossFileReference>,
    pub inter_jot_resources: Vec<InterJotResource>,
    pub resources: Vec<Resource>,
    pub todos: Vec<Todo>,
    pub done_todos: Vec<Todo>,
    pub urls: Vec<Url>,
    pub bookmarks: Vec<Bookmark>,
    pub diagnostics: Vec<Diagnostic>,
}