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
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
use crate::models::{CellValue, Hyperlink};
use crate::types::Result;
use core::fmt::Error;
use core::option::Option;
use core::option::Option::{None, Some};
use core::result::Result::{Err, Ok};
use serde::{Deserialize, Serialize};
use serde_json::value::Value;
use serde_json::Number;
#[derive(Debug, Clone, PartialEq, Serialize, Deserialize)]
pub struct Cell {
#[serde(rename = "columnId")]
pub column_id: u64,
#[serde(rename = "columnType")]
pub column_type: Option<String>,
/// Represents a hyperlink to a dashboard, report, sheet, or URL.
///
/// In the most common scenario, the hyperlink is a URL link, and the `url`
/// property contains the URL value. This can more easily be retrieved
/// via the `Cell.link_url` method.
///
/// # More info
///
/// - https://smartsheet-platform.github.io/api-docs/#hyperlinks
/// - https://smartsheet-platform.github.io/api-docs/#hyperlink-object
pub hyperlink: Option<Hyperlink>,
/// `Cell.value` represents a cell's raw value and can be one of the
/// following primitive JSON types: string, number, or Boolean, depending
/// on the column type. An empty cell returns no value.
///
/// # More info
///
/// - https://smartsheet-platform.github.io/api-docs/#cell-reference
pub value: Option<CellValue>,
/// `Cell.displayValue` is always a string and is only returned for certain
/// column types. It represents the formatted value as it should be
/// displayed to an end-user.
///
/// # Examples
///
/// If a TEXT_NUMBER column is formatted as a US Dollar currency, its
/// value may be a number like 1234.5678, but its displayValue
/// is "$1,234.57".
///
/// # More info
///
/// - https://smartsheet-platform.github.io/api-docs/#cell-reference
#[serde(rename = "displayValue")]
pub display_value: Option<String>,
/// `Cell.objectValue` is an object representation of a cell's value and
/// is currently used for adding or updating predecessor cell values, or
/// for multi-contact details, such as email addresses.
///
/// # More info
///
/// - https://smartsheet-platform.github.io/api-docs/#cell-reference
#[serde(rename = "objectValue")]
pub object_value: Option<Value>,
pub format: Option<String>,
pub formula: Option<String>,
}
impl Cell {
/// Retrieve the Cell `value` as a *string*
pub fn value_as_str(&self) -> Result<&str> {
if let Some(value) = &self.value {
value.as_str()
} else {
Err(Box::new(Error::default()))
}
}
/// Retrieve the Cell `value` as a *string*, but prefer to use an
/// `Option` implementation instead, which can be `unwrap`ped.
pub fn value_as_str_safe(&self) -> Option<&str> {
if let Some(value) = &self.value {
value.as_str_safe()
} else {
None
}
}
/// Retrieve the Cell `value` as a *Number*
pub fn value_as_number(&self) -> Result<&Number> {
if let Some(value) = &self.value {
value.as_number()
} else {
Err(Box::new(Error::default()))
}
}
/// Retrieve the Cell `value` as a *boolean*
pub fn value_as_bool(&self) -> Result<bool> {
if let Some(value) = &self.value {
value.as_bool()
} else {
Err(Box::new(Error::default()))
}
}
/// Retrieve the Cell `value` as an *unsigned integer*
pub fn value_as_u64(&self) -> Result<u64> {
if let Some(value) = &self.value {
value.as_u64()
} else {
Err(Box::new(Error::default()))
}
}
/// Retrieve the Cell `value` as a *float*
pub fn value_as_f64(&self) -> Result<f64> {
if let Some(value) = &self.value {
value.as_f64()
} else {
Err(Box::new(Error::default()))
}
}
/// Retrieve the Cell `display_value` as a *string*
pub fn display_value_as_str(&self) -> Result<&str> {
if let Some(value) = &self.display_value {
Ok(value)
} else {
Err(Box::new(Error::default()))
}
}
/// Retrieve the Cell `display_value` as a *string*, but prefer to use an
/// `Option` implementation instead, which can be `unwrap`ped.
pub fn display_value_as_str_safe(&self) -> Option<&str> {
match &self.display_value {
Some(v) => Some(v),
None => None,
}
}
/// Retrieve the Cell `hyperlink` URL as a *string*
pub fn link_url(&self) -> Result<&str> {
if let Some(link) = &self.hyperlink {
Ok(&link.url)
} else {
Err(Box::new(Error::default()))
}
}
/// Retrieve the Cell `hyperlink` URL as a *string*, but prefer to use an
/// `Option` implementation instead, which can be `unwrap`ped.
pub fn link_url_safe(&self) -> Option<&str> {
if let Some(link) = &self.hyperlink {
Some(&link.url)
} else {
None
}
}
}