marque-engine 0.2.1

Pipeline orchestration: core + rules → diagnostics + fixes
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44

// SPDX-FileCopyrightText: 2026 Knitli Inc.
//
// SPDX-License-Identifier: LicenseRef-MarqueLicense-1.0

//! Async stream pipeline types.
//!
//! The full pipeline:
//!   Source → TextStream → SpanStream → AttributeStream → DiagnosticStream → Sink
//!
//! Each stage is a `Stream`. Middleware inserts between stages.
//! This module defines the stage types; full async streaming implementation is TODO.

use marque_ism::MarkingCandidate;
use marque_rules::Diagnostic;

/// Error type for stream sources.
#[derive(Debug, thiserror::Error)]
pub enum SourceError {
    /// Standard I/O errors from underlying readers.
    #[error("I/O error: {0}")]
    Io(#[from] std::io::Error),
    /// Other errors.
    #[error("Source error: {0}")]
    Other(String),
}

/// A chunk of source text with its byte offset in the original document.
#[derive(Debug)]
pub struct TextChunk {
    pub offset: usize,
    pub data: Vec<u8>,
}

/// A stream source — anything that produces `TextChunk`s.
/// Implemented by: string buffer (WASM/server), file reader (CLI/batch), HTTP body.
pub trait Source: futures_core::Stream<Item = Result<TextChunk, SourceError>> + Send {}

impl<T> Source for T where T: futures_core::Stream<Item = Result<TextChunk, SourceError>> + Send {}

/// A stream sink — anything that consumes pipeline output.
pub trait Sink: Send {
    fn accept_diagnostic(&mut self, diag: Diagnostic);
    fn accept_candidate(&mut self, candidate: MarkingCandidate);
}