stately-files 0.5.0

File upload and relative path management for stately
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
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70

//! Response types for file management endpoints.

use serde::Serialize;
use utoipa::{ToResponse, ToSchema};

/// Response from file upload or save operations.
#[derive(Debug, Serialize, ToSchema, ToResponse)]
pub struct FileUploadResponse {
    /// Whether the operation was successful.
    pub success:   bool,
    /// Relative path from uploads directory (e.g., "config.json").
    pub path:      String,
    /// The UUID version identifier for this upload.
    pub uuid:      String,
    /// Full absolute path on the server filesystem.
    pub full_path: String,
}

/// Response from listing files in a directory.
#[derive(Debug, Serialize, ToSchema, ToResponse)]
pub struct FileListResponse {
    /// List of files and directories.
    pub files: Vec<FileInfo>,
}

/// Type of file system entry.
#[derive(Debug, Clone, Copy, Serialize, ToSchema)]
#[serde(rename_all = "snake_case")]
pub enum FileEntryType {
    /// A directory that may contain other files or directories.
    Directory,
    /// A regular file (not versioned).
    File,
    /// A versioned file with multiple versions stored.
    VersionedFile,
}

/// Information about a file or directory entry.
#[derive(Debug, Serialize, ToSchema)]
pub struct FileInfo {
    /// Entry name (filename or directory name).
    pub name:       String,
    /// Size in bytes. For versioned files, this is the size of the latest version.
    /// For directories, this is 0.
    pub size:       u64,
    /// Type of this entry.
    #[serde(rename = "type")]
    pub entry_type: FileEntryType,
    /// Creation timestamp as Unix epoch seconds.
    /// For versioned files, this is when the first version was created.
    pub created:    Option<u64>,
    /// Last modified timestamp as Unix epoch seconds.
    /// For versioned files, this is when the latest version was created.
    pub modified:   Option<u64>,
    /// List of all versions, sorted newest first.
    /// Only populated for versioned files.
    #[serde(skip_serializing_if = "Option::is_none")]
    pub versions:   Option<Vec<FileVersion>>,
}

/// Information about a specific file version.
#[derive(Debug, Serialize, ToSchema)]
pub struct FileVersion {
    /// UUID v7 identifier for this version.
    pub uuid:    String,
    /// Size of this version in bytes.
    pub size:    u64,
    /// Creation timestamp as Unix epoch seconds.
    pub created: Option<u64>,
}