dais-sidecar 0.1.0

Sidecar format abstraction and .pdfpc implementation for Dais
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

use std::path::Path;

use crate::types::PresentationMetadata;

/// Abstraction for sidecar file formats.
///
/// In v1, the only implementation is `.pdfpc`. Future formats (e.g., `.dais`)
/// implement this same trait and slot in without changing downstream code.
pub trait SidecarFormat {
    /// Read metadata from a sidecar file.
    fn read(&self, path: &Path) -> Result<PresentationMetadata, SidecarError>;

    /// Write metadata to a sidecar file.
    fn write(&self, path: &Path, metadata: &PresentationMetadata) -> Result<(), SidecarError>;

    /// The file extension this format uses (e.g., "pdfpc").
    fn file_extension(&self) -> &'static str;
}

/// Errors that can occur during sidecar operations.
#[derive(Debug, thiserror::Error)]
pub enum SidecarError {
    /// Filesystem read/write failure.
    #[error("I/O error: {0}")]
    Io(#[from] std::io::Error),

    /// The sidecar file could not be parsed.
    #[error("Parse error at line {line}: {message}")]
    Parse { line: usize, message: String },

    /// A required sidecar section was absent.
    #[error("Missing required section: {0}")]
    MissingSection(String),
}