docx-review-core 0.1.0

Review-oriented DOCX extraction library for tracked changes, comments, and structural blocks
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

use chrono::{DateTime, Utc};
use serde::{Deserialize, Serialize};

use super::{Block, Comment, TrackedChange};

/// A normalized review-oriented representation of a DOCX file.
#[derive(Clone, Debug, PartialEq, Eq, Serialize, Deserialize)]
#[non_exhaustive]
pub struct Document {
    /// Top-level document metadata when available.
    pub metadata: DocMetadata,
    /// Normalized textual structure of the document.
    pub blocks: Vec<Block>,
    /// Review-oriented tracked changes, optionally paired.
    pub tracked_changes: Vec<TrackedChange>,
    /// Extracted comments, anchors, and thread metadata.
    pub comments: Vec<Comment>,
    /// Raw tracked changes when [`crate::TrackChangesMode::Both`] is used.
    pub raw_changes: Vec<TrackedChange>,
}

/// Optional metadata associated with the DOCX package.
#[derive(Clone, Debug, Default, PartialEq, Eq, Serialize, Deserialize)]
#[non_exhaustive]
pub struct DocMetadata {
    /// Document title.
    pub title: Option<String>,
    /// Primary author.
    pub author: Option<String>,
    /// Document creation time.
    pub created: Option<DateTime<Utc>>,
    /// Last modification time.
    pub modified: Option<DateTime<Utc>>,
    /// Revision counter when present in package metadata.
    pub revision: Option<u32>,
}