Struct Document 

pub struct Document {

    pub id: DocumentId,
    pub location_id: LocationId,
    pub subject: DocumentSubject,
    pub classification: Classification,
    pub source: Source,
    pub uploaded_by_actor: ActorRef,
    pub uploaded_at: DateTime<Utc>,
    pub original_file: OriginalFile,
    pub storage_ref: StorageRef,
    pub virus_scan_status: VirusScanStatus,
    pub pii_redaction_status: PiiRedactionStatus,
    pub verification_status: Status,
    pub audit_refs: Vec<EventId>,
}

Document record tying storage, classification, source, scan, redaction, and review status together.

Fields

id: DocumentId

Id retained from source records for staff review, safety gates, and workflow joins.

location_id: LocationId

Location id retained from source records for staff review, safety gates, and workflow joins.

subject: DocumentSubject

Subject retained from source records for staff review, safety gates, and workflow joins.

classification: Classification

Classification retained from source records for staff review, safety gates, and workflow joins.

source: Source

Source retained from source records for staff review, safety gates, and workflow joins.

uploaded_by_actor: ActorRef

Uploaded by actor retained from source records for staff review, safety gates, and workflow joins.

uploaded_at: DateTime<Utc>

Uploaded at retained from source records for staff review, safety gates, and workflow joins.

original_file: OriginalFile

Original file retained from source records for staff review, safety gates, and workflow joins.

storage_ref: StorageRef

Storage ref retained from source records for staff review, safety gates, and workflow joins.

virus_scan_status: VirusScanStatus

Virus scan status retained from source records for staff review, safety gates, and workflow joins.

pii_redaction_status: PiiRedactionStatus

Pii redaction status retained from source records for staff review, safety gates, and workflow joins.

verification_status: Status

Verification status retained from source records for staff review, safety gates, and workflow joins.

audit_refs: Vec<EventId>

Audit refs retained from source records for staff review, safety gates, and workflow joins.

Implementations

impl Document

pub fn builder() -> DocumentBuilder

Create an instance of Document using the builder syntax

impl Document

pub fn requires_human_review_before_use(&self) -> bool

Reports whether the document must be reviewed before agents or staff treat it as usable evidence.

Trait Implementations

impl Clone for Document

fn clone(&self) -> Document

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for Document

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for Document

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for Document

fn eq(&self, other: &Document) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Serialize for Document

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl Eq for Document

impl StructuralPartialEq for Document