Skip to main content

paperless_api/
custom_field.rs

1use serde::{Deserialize, Serialize};
2
3#[derive(Debug, Clone, Copy, PartialEq, Eq, Hash, Deserialize, Serialize)]
4#[repr(transparent)]
5pub struct CustomFieldId(pub i32);
6
7/// Custom field definition.
8#[derive(Debug, Clone, Deserialize)]
9pub struct CustomField {
10    /// Unique identifier of the custom field.
11    pub id: CustomFieldId,
12
13    /// Name of the custom field.
14    pub name: String,
15
16    /// Data type of the custom field.
17    pub data_type: String,
18}
19
20/// Custom field value of an existing document
21#[derive(Debug, Clone, Deserialize, Serialize)]
22pub struct DocumentCustomField {
23    /// Unique identifier of the custom field.
24    pub field: CustomFieldId,
25
26    /// Value of the custom field.
27    pub value: String,
28}
29
30impl std::fmt::Display for CustomFieldId {
31    fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
32        write!(f, "{}", self.0)
33    }
34}