scribble 0.5.4

High-level Rust API for audio transcription using Whisper
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

use crate::Result;
use crate::segments::Segment;

/// A streaming encoder for transcription segments.
///
/// Decouples *segment production* (Whisper/VAD/etc.) from *segment presentation*
/// (JSON, VTT, plain text, ...).
///
/// Lifecycle:
/// - Call `write_segment` zero or more times.
/// - Call `close` exactly once when done.
/// - Implementations should treat `close()` as idempotent (safe to call multiple times).
///
/// Streaming considerations:
/// - Implementations should write incrementally and avoid buffering the full output
///   whenever possible.
/// - `close()` is where output is finalized (e.g., write trailing brackets, flush writers).
pub trait SegmentEncoder {
    /// Encode and write a single segment.
    fn write_segment(&mut self, seg: &Segment) -> Result<()>;

    /// Finalize the encoded output and flush any buffered data.
    ///
    /// Prefer `close()` to be idempotent so callers can safely call it in cleanup paths.
    fn close(&mut self) -> Result<()>;
}