rust-tdlib 0.4.3

TDlib (Telegram Database library) 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
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
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127

use crate::errors::Result;
use crate::types::*;
use uuid::Uuid;

/// Represents a remote file
#[derive(Debug, Clone, Default, Serialize, Deserialize)]
pub struct RemoteFile {
    #[doc(hidden)]
    #[serde(rename(serialize = "@extra", deserialize = "@extra"))]
    extra: Option<String>,
    #[serde(rename(serialize = "@client_id", deserialize = "@client_id"))]
    client_id: Option<i32>,
    /// Remote file identifier; may be empty. Can be used by the current user across application restarts or even from other devices. Uniquely identifies a file, but a file can have a lot of different valid identifiers. If the ID starts with "http://" or "https://", it represents the HTTP URL of the file. TDLib is currently unable to download files if only their URL is known. If downloadFile is called on such a file or if it is sent to a secret chat, TDLib starts a file generation process by sending updateFileGenerationStart to the application with the HTTP URL in the original_path and "#url#" as the conversion string. Application must generate the file by downloading it to the specified location

    #[serde(default)]
    id: String,
    /// Unique file identifier; may be empty if unknown. The unique file identifier which is the same for the same file even for different users and is persistent over time

    #[serde(default)]
    unique_id: String,
    /// True, if the file is currently being uploaded (or a remote copy is being generated by some other means)

    #[serde(default)]
    is_uploading_active: bool,
    /// True, if a remote copy is fully available

    #[serde(default)]
    is_uploading_completed: bool,
    /// Size of the remote available part of the file, in bytes; 0 if unknown

    #[serde(default)]
    uploaded_size: i32,
}

impl RObject for RemoteFile {
    #[doc(hidden)]
    fn extra(&self) -> Option<&str> {
        self.extra.as_deref()
    }
    #[doc(hidden)]
    fn client_id(&self) -> Option<i32> {
        self.client_id
    }
}

impl RemoteFile {
    pub fn from_json<S: AsRef<str>>(json: S) -> Result<Self> {
        Ok(serde_json::from_str(json.as_ref())?)
    }
    pub fn builder() -> RemoteFileBuilder {
        let mut inner = RemoteFile::default();
        inner.extra = Some(Uuid::new_v4().to_string());

        RemoteFileBuilder { inner }
    }

    pub fn id(&self) -> &String {
        &self.id
    }

    pub fn unique_id(&self) -> &String {
        &self.unique_id
    }

    pub fn is_uploading_active(&self) -> bool {
        self.is_uploading_active
    }

    pub fn is_uploading_completed(&self) -> bool {
        self.is_uploading_completed
    }

    pub fn uploaded_size(&self) -> i32 {
        self.uploaded_size
    }
}

#[doc(hidden)]
pub struct RemoteFileBuilder {
    inner: RemoteFile,
}

#[deprecated]
pub type RTDRemoteFileBuilder = RemoteFileBuilder;

impl RemoteFileBuilder {
    pub fn build(&self) -> RemoteFile {
        self.inner.clone()
    }

    pub fn id<T: AsRef<str>>(&mut self, id: T) -> &mut Self {
        self.inner.id = id.as_ref().to_string();
        self
    }

    pub fn unique_id<T: AsRef<str>>(&mut self, unique_id: T) -> &mut Self {
        self.inner.unique_id = unique_id.as_ref().to_string();
        self
    }

    pub fn is_uploading_active(&mut self, is_uploading_active: bool) -> &mut Self {
        self.inner.is_uploading_active = is_uploading_active;
        self
    }

    pub fn is_uploading_completed(&mut self, is_uploading_completed: bool) -> &mut Self {
        self.inner.is_uploading_completed = is_uploading_completed;
        self
    }

    pub fn uploaded_size(&mut self, uploaded_size: i32) -> &mut Self {
        self.inner.uploaded_size = uploaded_size;
        self
    }
}

impl AsRef<RemoteFile> for RemoteFile {
    fn as_ref(&self) -> &RemoteFile {
        self
    }
}

impl AsRef<RemoteFile> for RemoteFileBuilder {
    fn as_ref(&self) -> &RemoteFile {
        &self.inner
    }
}