rust_tdlib/types/
file.rs

1use crate::errors::Result;
2use crate::types::*;
3use uuid::Uuid;
4
5/// Represents a file
6#[derive(Debug, Clone, Default, Serialize, Deserialize)]
7pub struct File {
8    #[doc(hidden)]
9    #[serde(rename(serialize = "@extra", deserialize = "@extra"))]
10    extra: Option<String>,
11    #[serde(rename(serialize = "@client_id", deserialize = "@client_id"))]
12    client_id: Option<i32>,
13    /// Unique file identifier
14
15    #[serde(default)]
16    id: i32,
17    /// File size, in bytes; 0 if unknown
18
19    #[serde(default)]
20    size: i32,
21    /// Approximate file size in bytes in case the exact file size is unknown. Can be used to show download/upload progress
22
23    #[serde(default)]
24    expected_size: i32,
25    /// Information about the local copy of the file
26    local: LocalFile,
27    /// Information about the remote copy of the file
28    remote: RemoteFile,
29}
30
31impl RObject for File {
32    #[doc(hidden)]
33    fn extra(&self) -> Option<&str> {
34        self.extra.as_deref()
35    }
36    #[doc(hidden)]
37    fn client_id(&self) -> Option<i32> {
38        self.client_id
39    }
40}
41
42impl File {
43    pub fn from_json<S: AsRef<str>>(json: S) -> Result<Self> {
44        Ok(serde_json::from_str(json.as_ref())?)
45    }
46    pub fn builder() -> FileBuilder {
47        let mut inner = File::default();
48        inner.extra = Some(Uuid::new_v4().to_string());
49
50        FileBuilder { inner }
51    }
52
53    pub fn id(&self) -> i32 {
54        self.id
55    }
56
57    pub fn size(&self) -> i32 {
58        self.size
59    }
60
61    pub fn expected_size(&self) -> i32 {
62        self.expected_size
63    }
64
65    pub fn local(&self) -> &LocalFile {
66        &self.local
67    }
68
69    pub fn remote(&self) -> &RemoteFile {
70        &self.remote
71    }
72}
73
74#[doc(hidden)]
75pub struct FileBuilder {
76    inner: File,
77}
78
79#[deprecated]
80pub type RTDFileBuilder = FileBuilder;
81
82impl FileBuilder {
83    pub fn build(&self) -> File {
84        self.inner.clone()
85    }
86
87    pub fn id(&mut self, id: i32) -> &mut Self {
88        self.inner.id = id;
89        self
90    }
91
92    pub fn size(&mut self, size: i32) -> &mut Self {
93        self.inner.size = size;
94        self
95    }
96
97    pub fn expected_size(&mut self, expected_size: i32) -> &mut Self {
98        self.inner.expected_size = expected_size;
99        self
100    }
101
102    pub fn local<T: AsRef<LocalFile>>(&mut self, local: T) -> &mut Self {
103        self.inner.local = local.as_ref().clone();
104        self
105    }
106
107    pub fn remote<T: AsRef<RemoteFile>>(&mut self, remote: T) -> &mut Self {
108        self.inner.remote = remote.as_ref().clone();
109        self
110    }
111}
112
113impl AsRef<File> for File {
114    fn as_ref(&self) -> &File {
115        self
116    }
117}
118
119impl AsRef<File> for FileBuilder {
120    fn as_ref(&self) -> &File {
121        &self.inner
122    }
123}