imagekit 0.1.0-beta+1

Rust API Client for ImageKit.io a file storage and image processing service
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

use serde::Deserialize;

/// An object containing the file or file version's id (versionId) and name.
#[derive(Debug, Deserialize)]
#[serde(rename_all = "camelCase")]
pub struct VersionInfo {
    pub id: String,
    pub name: String,
}

/// Array of AITags associated with the image. If no AITags are set, it
/// will be null. These tags can be added using the google-auto-tagging
/// or aws-auto-tagging extensions.
#[derive(Debug, Deserialize)]
#[serde(rename_all = "camelCase")]
pub struct AiTag {
    pub name: String,
    pub confidence: f32,
    pub source: String,
}

/// The type of file could be either `image` or `non-image`.
#[derive(Debug, Deserialize, PartialEq)]
pub enum FileType {
    #[serde(rename = "image")]
    Image,
    #[serde(rename = "non-image")]
    NonImage,
}

/// Response struct returned from successful requests to the ImageKit API.
///
/// Refer: https://docs.imagekit.io/api-reference/upload-file-api/server-side-file-upload#response-code-and-structure-json
/// Fields Documentation: https://docs.imagekit.io/api-reference/upload-file-api/server-side-file-upload#understanding-response
#[derive(Debug, Deserialize)]
#[serde(rename_all = "camelCase")]
pub struct Response {
    /// Unique fileId. Store this fileld in your database, as this will be used
    /// to perform update action on this file
    pub file_id: String,
    /// Name of the file or folder.
    pub name: String,
    /// Size of the image file in Bytes
    pub size: u64,
    /// An object containing the file or file version's id (versionId) and name.
    pub version_info: VersionInfo,
    /// The relative path of the file. In the case of an image, you can use
    /// this path to construct different transformations.
    pub file_path: String,
    /// A publicly accessible URL of the file.
    pub url: String,
    /// The type of file could be either `image` or `non-image`.
    pub file_type: FileType,
    /// Height of the image in pixels (Only for images)
    pub height: Option<u64>,
    /// Width of the image in pixels (Only for Images)
    pub width: Option<u64>,
    /// In the case of an image, a small thumbnail URL.
    pub thumbnail_url: String,
    /// Array of AITags associated with the image. If no AITags are set, it
    /// will be null. These tags can be added using the google-auto-tagging
    /// or aws-auto-tagging extensions.
    pub ai_tags: Option<Vec<AiTag>>,
}