paperless-api 0.11.0

Async Paperless ngx API client
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

//! DTO traits and helpers.

use serde::Serialize;

use crate::id::PaperlessId;

/// Marker trait for DTOs used to create new items.
pub trait CreateDtoObject: Serialize {}

/// Marker trait for DTOs used to update existing items.
pub trait UpdateDtoObject: Serialize {}

/// Trait for items that can be managed via the Paperless API.
pub trait Item {
    /// The ID type for this item.
    type Id: PaperlessId;

    /// The base type used for deserialization.
    type BaseType: serde::de::DeserializeOwned;

    /// The DTO type used for creating new items.
    type CreateDto: CreateDtoObject;

    /// The DTO type used for updating existing items.
    type UpdateDto: UpdateDtoObject;

    /// Returns the API endpoint for this item.
    fn endpoint() -> &'static str;

    /// Returns the ID of this item.
    fn id(&self) -> Self::Id;
}