f32216e1e0
Some checks failed
CI / Lint & TypeCheck (push) Has been cancelled
CI / Unit Tests (push) Has been cancelled
CI / Build Frontend (push) Has been cancelled
CI / Rust Check (push) Has been cancelled
CI / Security Scan (push) Has been cancelled
CI / E2E Tests (push) Has been cancelled
添加了关于管家主动性与行业配置体系的发散探讨文档，包含现状诊断、关键讨论、架构设计等内容。同时添加了测试失败的截图和日志文件。
1182 lines
120 KiB
HTML
1182 lines
120 KiB
HTML
<!DOCTYPE html><html lang="en"><head><meta charset="utf-8"><meta name="viewport" content="width=device-width, initial-scale=1.0"><meta name="generator" content="rustdoc"><meta name="description" content="Source of the Rust file `C:\Users\szend\.cargo\registry\src\mirrors.ustc.edu.cn-38d0e5eb5da2abae\calamine-0.26.1\src\lib.rs`."><title>lib.rs - source</title><script>if(window.location.protocol!=="file:")document.head.insertAdjacentHTML("beforeend","SourceSerif4-Regular-6b053e98.ttf.woff2,FiraSans-Italic-81dc35de.woff2,FiraSans-Regular-0fe48ade.woff2,FiraSans-MediumItalic-ccf7e434.woff2,FiraSans-Medium-e1aa3f0a.woff2,SourceCodePro-Regular-8badfe75.ttf.woff2,SourceCodePro-Semibold-aa29a496.ttf.woff2".split(",").map(f=>`<link rel="preload" as="font" type="font/woff2"href="../../static.files/${f}">`).join(""))</script><link rel="stylesheet" href="../../static.files/normalize-9960930a.css"><link rel="stylesheet" href="../../static.files/rustdoc-ca0dd0c4.css"><meta name="rustdoc-vars" data-root-path="../../" data-static-root-path="../../static.files/" data-current-crate="calamine" data-themes="" data-resource-suffix="" data-rustdoc-version="1.93.1 (01f6ddf75 2026-02-11)" data-channel="1.93.1" data-search-js="search-9e2438ea.js" data-stringdex-js="stringdex-a3946164.js" data-settings-js="settings-c38705f0.js" ><script src="../../static.files/storage-e2aeef58.js"></script><script defer src="../../static.files/src-script-813739b1.js"></script><script defer src="../../src-files.js"></script><script defer src="../../static.files/main-a410ff4d.js"></script><noscript><link rel="stylesheet" href="../../static.files/noscript-263c88ec.css"></noscript><link rel="alternate icon" type="image/png" href="../../static.files/favicon-32x32-eab170b8.png"><link rel="icon" type="image/svg+xml" href="../../static.files/favicon-044be391.svg"></head><body class="rustdoc src"><!--[if lte IE 11]><div class="warning">This old browser is unsupported and will most likely display funky things.</div><![endif]--><nav class="sidebar"><div class="src-sidebar-title"><h2>Files</h2></div></nav><div class="sidebar-resizer" title="Drag to resize sidebar"></div><main><section id="main-content" class="content"><div class="main-heading"><h1><div class="sub-heading">calamine/</div>lib.rs</h1><rustdoc-toolbar></rustdoc-toolbar></div><div class="example-wrap digits-4"><pre class="rust"><code><a href=#1 id=1 data-nosnippet>1</a><span class="doccomment">//! Rust Excel/OpenDocument reader
|
|
<a href=#2 id=2 data-nosnippet>2</a>//!
|
|
<a href=#3 id=3 data-nosnippet>3</a>//! # Status
|
|
<a href=#4 id=4 data-nosnippet>4</a>//!
|
|
<a href=#5 id=5 data-nosnippet>5</a>//! **calamine** is a pure Rust library to read Excel and OpenDocument Spreadsheet files.
|
|
<a href=#6 id=6 data-nosnippet>6</a>//!
|
|
<a href=#7 id=7 data-nosnippet>7</a>//! Read both cell values and vba project.
|
|
<a href=#8 id=8 data-nosnippet>8</a>//!
|
|
<a href=#9 id=9 data-nosnippet>9</a>//! # Examples
|
|
<a href=#10 id=10 data-nosnippet>10</a>//! ```
|
|
<a href=#11 id=11 data-nosnippet>11</a>//! use calamine::{Reader, open_workbook, Xlsx, Data};
|
|
<a href=#12 id=12 data-nosnippet>12</a>//!
|
|
<a href=#13 id=13 data-nosnippet>13</a>//! // opens a new workbook
|
|
<a href=#14 id=14 data-nosnippet>14</a>//! # let path = format!("{}/tests/issue3.xlsm", env!("CARGO_MANIFEST_DIR"));
|
|
<a href=#15 id=15 data-nosnippet>15</a>//! let mut workbook: Xlsx<_> = open_workbook(path).expect("Cannot open file");
|
|
<a href=#16 id=16 data-nosnippet>16</a>//!
|
|
<a href=#17 id=17 data-nosnippet>17</a>//! // Read whole worksheet data and provide some statistics
|
|
<a href=#18 id=18 data-nosnippet>18</a>//! if let Ok(range) = workbook.worksheet_range("Sheet1") {
|
|
<a href=#19 id=19 data-nosnippet>19</a>//! let total_cells = range.get_size().0 * range.get_size().1;
|
|
<a href=#20 id=20 data-nosnippet>20</a>//! let non_empty_cells: usize = range.used_cells().count();
|
|
<a href=#21 id=21 data-nosnippet>21</a>//! println!("Found {} cells in 'Sheet1', including {} non empty cells",
|
|
<a href=#22 id=22 data-nosnippet>22</a>//! total_cells, non_empty_cells);
|
|
<a href=#23 id=23 data-nosnippet>23</a>//! // alternatively, we can manually filter rows
|
|
<a href=#24 id=24 data-nosnippet>24</a>//! assert_eq!(non_empty_cells, range.rows()
|
|
<a href=#25 id=25 data-nosnippet>25</a>//! .flat_map(|r| r.iter().filter(|&c| c != &Data::Empty)).count());
|
|
<a href=#26 id=26 data-nosnippet>26</a>//! }
|
|
<a href=#27 id=27 data-nosnippet>27</a>//!
|
|
<a href=#28 id=28 data-nosnippet>28</a>//! // Check if the workbook has a vba project
|
|
<a href=#29 id=29 data-nosnippet>29</a>//! if let Some(Ok(mut vba)) = workbook.vba_project() {
|
|
<a href=#30 id=30 data-nosnippet>30</a>//! let vba = vba.to_mut();
|
|
<a href=#31 id=31 data-nosnippet>31</a>//! let module1 = vba.get_module("Module 1").unwrap();
|
|
<a href=#32 id=32 data-nosnippet>32</a>//! println!("Module 1 code:");
|
|
<a href=#33 id=33 data-nosnippet>33</a>//! println!("{}", module1);
|
|
<a href=#34 id=34 data-nosnippet>34</a>//! for r in vba.get_references() {
|
|
<a href=#35 id=35 data-nosnippet>35</a>//! if r.is_missing() {
|
|
<a href=#36 id=36 data-nosnippet>36</a>//! println!("Reference {} is broken or not accessible", r.name);
|
|
<a href=#37 id=37 data-nosnippet>37</a>//! }
|
|
<a href=#38 id=38 data-nosnippet>38</a>//! }
|
|
<a href=#39 id=39 data-nosnippet>39</a>//! }
|
|
<a href=#40 id=40 data-nosnippet>40</a>//!
|
|
<a href=#41 id=41 data-nosnippet>41</a>//! // You can also get defined names definition (string representation only)
|
|
<a href=#42 id=42 data-nosnippet>42</a>//! for name in workbook.defined_names() {
|
|
<a href=#43 id=43 data-nosnippet>43</a>//! println!("name: {}, formula: {}", name.0, name.1);
|
|
<a href=#44 id=44 data-nosnippet>44</a>//! }
|
|
<a href=#45 id=45 data-nosnippet>45</a>//!
|
|
<a href=#46 id=46 data-nosnippet>46</a>//! // Now get all formula!
|
|
<a href=#47 id=47 data-nosnippet>47</a>//! let sheets = workbook.sheet_names().to_owned();
|
|
<a href=#48 id=48 data-nosnippet>48</a>//! for s in sheets {
|
|
<a href=#49 id=49 data-nosnippet>49</a>//! println!("found {} formula in '{}'",
|
|
<a href=#50 id=50 data-nosnippet>50</a>//! workbook
|
|
<a href=#51 id=51 data-nosnippet>51</a>//! .worksheet_formula(&s)
|
|
<a href=#52 id=52 data-nosnippet>52</a>//! .expect("error while getting formula")
|
|
<a href=#53 id=53 data-nosnippet>53</a>//! .rows().flat_map(|r| r.iter().filter(|f| !f.is_empty()))
|
|
<a href=#54 id=54 data-nosnippet>54</a>//! .count(),
|
|
<a href=#55 id=55 data-nosnippet>55</a>//! s);
|
|
<a href=#56 id=56 data-nosnippet>56</a>//! }
|
|
<a href=#57 id=57 data-nosnippet>57</a>//! ```
|
|
<a href=#58 id=58 data-nosnippet>58</a></span><span class="attr">#![deny(missing_docs)]
|
|
<a href=#59 id=59 data-nosnippet>59</a>
|
|
<a href=#60 id=60 data-nosnippet>60</a>#[macro_use]
|
|
<a href=#61 id=61 data-nosnippet>61</a></span><span class="kw">mod </span>utils;
|
|
<a href=#62 id=62 data-nosnippet>62</a>
|
|
<a href=#63 id=63 data-nosnippet>63</a><span class="kw">mod </span>auto;
|
|
<a href=#64 id=64 data-nosnippet>64</a><span class="kw">mod </span>cfb;
|
|
<a href=#65 id=65 data-nosnippet>65</a><span class="kw">mod </span>datatype;
|
|
<a href=#66 id=66 data-nosnippet>66</a><span class="kw">mod </span>formats;
|
|
<a href=#67 id=67 data-nosnippet>67</a><span class="kw">mod </span>ods;
|
|
<a href=#68 id=68 data-nosnippet>68</a><span class="kw">mod </span>xls;
|
|
<a href=#69 id=69 data-nosnippet>69</a><span class="kw">mod </span>xlsb;
|
|
<a href=#70 id=70 data-nosnippet>70</a><span class="kw">mod </span>xlsx;
|
|
<a href=#71 id=71 data-nosnippet>71</a>
|
|
<a href=#72 id=72 data-nosnippet>72</a><span class="kw">mod </span>de;
|
|
<a href=#73 id=73 data-nosnippet>73</a><span class="kw">mod </span>errors;
|
|
<a href=#74 id=74 data-nosnippet>74</a><span class="kw">pub mod </span>vba;
|
|
<a href=#75 id=75 data-nosnippet>75</a>
|
|
<a href=#76 id=76 data-nosnippet>76</a><span class="kw">use </span>serde::de::{Deserialize, DeserializeOwned, Deserializer};
|
|
<a href=#77 id=77 data-nosnippet>77</a><span class="kw">use </span>std::borrow::Cow;
|
|
<a href=#78 id=78 data-nosnippet>78</a><span class="kw">use </span>std::cmp::{max, min};
|
|
<a href=#79 id=79 data-nosnippet>79</a><span class="kw">use </span>std::fmt;
|
|
<a href=#80 id=80 data-nosnippet>80</a><span class="kw">use </span>std::fs::File;
|
|
<a href=#81 id=81 data-nosnippet>81</a><span class="kw">use </span>std::io::{BufReader, Read, Seek};
|
|
<a href=#82 id=82 data-nosnippet>82</a><span class="kw">use </span>std::ops::{Index, IndexMut};
|
|
<a href=#83 id=83 data-nosnippet>83</a><span class="kw">use </span>std::path::Path;
|
|
<a href=#84 id=84 data-nosnippet>84</a>
|
|
<a href=#85 id=85 data-nosnippet>85</a><span class="kw">pub use </span><span class="kw">crate</span>::auto::{open_workbook_auto, open_workbook_auto_from_rs, Sheets};
|
|
<a href=#86 id=86 data-nosnippet>86</a><span class="kw">pub use </span><span class="kw">crate</span>::datatype::{Data, DataRef, DataType, ExcelDateTime, ExcelDateTimeType};
|
|
<a href=#87 id=87 data-nosnippet>87</a><span class="kw">pub use </span><span class="kw">crate</span>::de::{DeError, RangeDeserializer, RangeDeserializerBuilder, ToCellDeserializer};
|
|
<a href=#88 id=88 data-nosnippet>88</a><span class="kw">pub use </span><span class="kw">crate</span>::errors::Error;
|
|
<a href=#89 id=89 data-nosnippet>89</a><span class="kw">pub use </span><span class="kw">crate</span>::ods::{Ods, OdsError};
|
|
<a href=#90 id=90 data-nosnippet>90</a><span class="kw">pub use </span><span class="kw">crate</span>::xls::{Xls, XlsError, XlsOptions};
|
|
<a href=#91 id=91 data-nosnippet>91</a><span class="kw">pub use </span><span class="kw">crate</span>::xlsb::{Xlsb, XlsbError};
|
|
<a href=#92 id=92 data-nosnippet>92</a><span class="kw">pub use </span><span class="kw">crate</span>::xlsx::{Xlsx, XlsxError};
|
|
<a href=#93 id=93 data-nosnippet>93</a>
|
|
<a href=#94 id=94 data-nosnippet>94</a><span class="kw">use </span><span class="kw">crate</span>::vba::VbaProject;
|
|
<a href=#95 id=95 data-nosnippet>95</a>
|
|
<a href=#96 id=96 data-nosnippet>96</a><span class="comment">// https://msdn.microsoft.com/en-us/library/office/ff839168.aspx
|
|
<a href=#97 id=97 data-nosnippet>97</a></span><span class="doccomment">/// An enum to represent all different errors that can appear as
|
|
<a href=#98 id=98 data-nosnippet>98</a>/// a value in a worksheet cell
|
|
<a href=#99 id=99 data-nosnippet>99</a></span><span class="attr">#[derive(Debug, Clone, PartialEq)]
|
|
<a href=#100 id=100 data-nosnippet>100</a></span><span class="kw">pub enum </span>CellErrorType {
|
|
<a href=#101 id=101 data-nosnippet>101</a> <span class="doccomment">/// Division by 0 error
|
|
<a href=#102 id=102 data-nosnippet>102</a> </span>Div0,
|
|
<a href=#103 id=103 data-nosnippet>103</a> <span class="doccomment">/// Unavailable value error
|
|
<a href=#104 id=104 data-nosnippet>104</a> </span>NA,
|
|
<a href=#105 id=105 data-nosnippet>105</a> <span class="doccomment">/// Invalid name error
|
|
<a href=#106 id=106 data-nosnippet>106</a> </span>Name,
|
|
<a href=#107 id=107 data-nosnippet>107</a> <span class="doccomment">/// Null value error
|
|
<a href=#108 id=108 data-nosnippet>108</a> </span>Null,
|
|
<a href=#109 id=109 data-nosnippet>109</a> <span class="doccomment">/// Number error
|
|
<a href=#110 id=110 data-nosnippet>110</a> </span>Num,
|
|
<a href=#111 id=111 data-nosnippet>111</a> <span class="doccomment">/// Invalid cell reference error
|
|
<a href=#112 id=112 data-nosnippet>112</a> </span>Ref,
|
|
<a href=#113 id=113 data-nosnippet>113</a> <span class="doccomment">/// Value error
|
|
<a href=#114 id=114 data-nosnippet>114</a> </span>Value,
|
|
<a href=#115 id=115 data-nosnippet>115</a> <span class="doccomment">/// Getting data
|
|
<a href=#116 id=116 data-nosnippet>116</a> </span>GettingData,
|
|
<a href=#117 id=117 data-nosnippet>117</a>}
|
|
<a href=#118 id=118 data-nosnippet>118</a>
|
|
<a href=#119 id=119 data-nosnippet>119</a><span class="kw">impl </span>fmt::Display <span class="kw">for </span>CellErrorType {
|
|
<a href=#120 id=120 data-nosnippet>120</a> <span class="kw">fn </span>fmt(<span class="kw-2">&</span><span class="self">self</span>, f: <span class="kw-2">&mut </span>fmt::Formatter<<span class="lifetime">'_</span>>) -> <span class="prelude-ty">Result</span><(), fmt::Error> {
|
|
<a href=#121 id=121 data-nosnippet>121</a> <span class="kw">match </span><span class="kw-2">*</span><span class="self">self </span>{
|
|
<a href=#122 id=122 data-nosnippet>122</a> CellErrorType::Div0 => <span class="macro">write!</span>(f, <span class="string">"#DIV/0!"</span>),
|
|
<a href=#123 id=123 data-nosnippet>123</a> CellErrorType::NA => <span class="macro">write!</span>(f, <span class="string">"#N/A"</span>),
|
|
<a href=#124 id=124 data-nosnippet>124</a> CellErrorType::Name => <span class="macro">write!</span>(f, <span class="string">"#NAME?"</span>),
|
|
<a href=#125 id=125 data-nosnippet>125</a> CellErrorType::Null => <span class="macro">write!</span>(f, <span class="string">"#NULL!"</span>),
|
|
<a href=#126 id=126 data-nosnippet>126</a> CellErrorType::Num => <span class="macro">write!</span>(f, <span class="string">"#NUM!"</span>),
|
|
<a href=#127 id=127 data-nosnippet>127</a> CellErrorType::Ref => <span class="macro">write!</span>(f, <span class="string">"#REF!"</span>),
|
|
<a href=#128 id=128 data-nosnippet>128</a> CellErrorType::Value => <span class="macro">write!</span>(f, <span class="string">"#VALUE!"</span>),
|
|
<a href=#129 id=129 data-nosnippet>129</a> CellErrorType::GettingData => <span class="macro">write!</span>(f, <span class="string">"#DATA!"</span>),
|
|
<a href=#130 id=130 data-nosnippet>130</a> }
|
|
<a href=#131 id=131 data-nosnippet>131</a> }
|
|
<a href=#132 id=132 data-nosnippet>132</a>}
|
|
<a href=#133 id=133 data-nosnippet>133</a>
|
|
<a href=#134 id=134 data-nosnippet>134</a><span class="doccomment">/// Dimensions info
|
|
<a href=#135 id=135 data-nosnippet>135</a></span><span class="attr">#[derive(Debug, Default, PartialEq, Eq, Hash, Ord, PartialOrd, Copy, Clone)]
|
|
<a href=#136 id=136 data-nosnippet>136</a></span><span class="kw">pub struct </span>Dimensions {
|
|
<a href=#137 id=137 data-nosnippet>137</a> <span class="doccomment">/// start: (row, col)
|
|
<a href=#138 id=138 data-nosnippet>138</a> </span><span class="kw">pub </span>start: (u32, u32),
|
|
<a href=#139 id=139 data-nosnippet>139</a> <span class="doccomment">/// end: (row, col)
|
|
<a href=#140 id=140 data-nosnippet>140</a> </span><span class="kw">pub </span>end: (u32, u32),
|
|
<a href=#141 id=141 data-nosnippet>141</a>}
|
|
<a href=#142 id=142 data-nosnippet>142</a>
|
|
<a href=#143 id=143 data-nosnippet>143</a><span class="attr">#[allow(clippy::len_without_is_empty)]
|
|
<a href=#144 id=144 data-nosnippet>144</a></span><span class="kw">impl </span>Dimensions {
|
|
<a href=#145 id=145 data-nosnippet>145</a> <span class="doccomment">/// create dimensions info with start position and end position
|
|
<a href=#146 id=146 data-nosnippet>146</a> </span><span class="kw">pub fn </span>new(start: (u32, u32), end: (u32, u32)) -> <span class="self">Self </span>{
|
|
<a href=#147 id=147 data-nosnippet>147</a> <span class="self">Self </span>{ start, end }
|
|
<a href=#148 id=148 data-nosnippet>148</a> }
|
|
<a href=#149 id=149 data-nosnippet>149</a> <span class="doccomment">/// check if a position is in it
|
|
<a href=#150 id=150 data-nosnippet>150</a> </span><span class="kw">pub fn </span>contains(<span class="kw-2">&</span><span class="self">self</span>, row: u32, col: u32) -> bool {
|
|
<a href=#151 id=151 data-nosnippet>151</a> row >= <span class="self">self</span>.start.<span class="number">0 </span>&& row <= <span class="self">self</span>.end.<span class="number">0 </span>&& col >= <span class="self">self</span>.start.<span class="number">1 </span>&& col <= <span class="self">self</span>.end.<span class="number">1
|
|
<a href=#152 id=152 data-nosnippet>152</a> </span>}
|
|
<a href=#153 id=153 data-nosnippet>153</a> <span class="doccomment">/// len
|
|
<a href=#154 id=154 data-nosnippet>154</a> </span><span class="kw">pub fn </span>len(<span class="kw-2">&</span><span class="self">self</span>) -> u64 {
|
|
<a href=#155 id=155 data-nosnippet>155</a> (<span class="self">self</span>.end.<span class="number">0 </span>- <span class="self">self</span>.start.<span class="number">0 </span>+ <span class="number">1</span>) <span class="kw">as </span>u64 * (<span class="self">self</span>.end.<span class="number">1 </span>- <span class="self">self</span>.start.<span class="number">1 </span>+ <span class="number">1</span>) <span class="kw">as </span>u64
|
|
<a href=#156 id=156 data-nosnippet>156</a> }
|
|
<a href=#157 id=157 data-nosnippet>157</a>}
|
|
<a href=#158 id=158 data-nosnippet>158</a>
|
|
<a href=#159 id=159 data-nosnippet>159</a><span class="doccomment">/// Common file metadata
|
|
<a href=#160 id=160 data-nosnippet>160</a>///
|
|
<a href=#161 id=161 data-nosnippet>161</a>/// Depending on file type, some extra information may be stored
|
|
<a href=#162 id=162 data-nosnippet>162</a>/// in the Reader implementations
|
|
<a href=#163 id=163 data-nosnippet>163</a></span><span class="attr">#[derive(Debug, Default)]
|
|
<a href=#164 id=164 data-nosnippet>164</a></span><span class="kw">pub struct </span>Metadata {
|
|
<a href=#165 id=165 data-nosnippet>165</a> sheets: Vec<Sheet>,
|
|
<a href=#166 id=166 data-nosnippet>166</a> <span class="doccomment">/// Map of sheet names/sheet path within zip archive
|
|
<a href=#167 id=167 data-nosnippet>167</a> </span>names: Vec<(String, String)>,
|
|
<a href=#168 id=168 data-nosnippet>168</a>}
|
|
<a href=#169 id=169 data-nosnippet>169</a>
|
|
<a href=#170 id=170 data-nosnippet>170</a><span class="doccomment">/// Type of sheet
|
|
<a href=#171 id=171 data-nosnippet>171</a>///
|
|
<a href=#172 id=172 data-nosnippet>172</a>/// Only Excel formats support this. Default value for ODS is SheetType::WorkSheet.
|
|
<a href=#173 id=173 data-nosnippet>173</a>/// https://learn.microsoft.com/en-us/openspecs/office_file_formats/ms-xls/b9ec509a-235d-424e-871d-f8e721106501
|
|
<a href=#174 id=174 data-nosnippet>174</a>/// https://learn.microsoft.com/en-us/openspecs/office_file_formats/ms-xlsb/1edadf56-b5cd-4109-abe7-76651bbe2722
|
|
<a href=#175 id=175 data-nosnippet>175</a>/// [ECMA-376 Part 1](https://www.ecma-international.org/publications-and-standards/standards/ecma-376/) 12.3.2, 12.3.7 and 12.3.24
|
|
<a href=#176 id=176 data-nosnippet>176</a></span><span class="attr">#[derive(Debug, Clone, Copy, PartialEq)]
|
|
<a href=#177 id=177 data-nosnippet>177</a></span><span class="kw">pub enum </span>SheetType {
|
|
<a href=#178 id=178 data-nosnippet>178</a> <span class="doccomment">/// WorkSheet
|
|
<a href=#179 id=179 data-nosnippet>179</a> </span>WorkSheet,
|
|
<a href=#180 id=180 data-nosnippet>180</a> <span class="doccomment">/// DialogSheet
|
|
<a href=#181 id=181 data-nosnippet>181</a> </span>DialogSheet,
|
|
<a href=#182 id=182 data-nosnippet>182</a> <span class="doccomment">/// MacroSheet
|
|
<a href=#183 id=183 data-nosnippet>183</a> </span>MacroSheet,
|
|
<a href=#184 id=184 data-nosnippet>184</a> <span class="doccomment">/// ChartSheet
|
|
<a href=#185 id=185 data-nosnippet>185</a> </span>ChartSheet,
|
|
<a href=#186 id=186 data-nosnippet>186</a> <span class="doccomment">/// VBA module
|
|
<a href=#187 id=187 data-nosnippet>187</a> </span>Vba,
|
|
<a href=#188 id=188 data-nosnippet>188</a>}
|
|
<a href=#189 id=189 data-nosnippet>189</a>
|
|
<a href=#190 id=190 data-nosnippet>190</a><span class="doccomment">/// Type of visible sheet
|
|
<a href=#191 id=191 data-nosnippet>191</a>///
|
|
<a href=#192 id=192 data-nosnippet>192</a>/// http://docs.oasis-open.org/office/v1.2/os/OpenDocument-v1.2-os-part1.html#__RefHeading__1417896_253892949
|
|
<a href=#193 id=193 data-nosnippet>193</a>/// https://learn.microsoft.com/en-us/openspecs/office_file_formats/ms-xls/b9ec509a-235d-424e-871d-f8e721106501
|
|
<a href=#194 id=194 data-nosnippet>194</a>/// https://learn.microsoft.com/en-us/openspecs/office_file_formats/ms-xlsb/74cb1d22-b931-4bf8-997d-17517e2416e9
|
|
<a href=#195 id=195 data-nosnippet>195</a>/// [ECMA-376 Part 1](https://www.ecma-international.org/publications-and-standards/standards/ecma-376/) 18.18.68
|
|
<a href=#196 id=196 data-nosnippet>196</a></span><span class="attr">#[derive(Debug, Clone, Copy, PartialEq)]
|
|
<a href=#197 id=197 data-nosnippet>197</a></span><span class="kw">pub enum </span>SheetVisible {
|
|
<a href=#198 id=198 data-nosnippet>198</a> <span class="doccomment">/// Visible
|
|
<a href=#199 id=199 data-nosnippet>199</a> </span>Visible,
|
|
<a href=#200 id=200 data-nosnippet>200</a> <span class="doccomment">/// Hidden
|
|
<a href=#201 id=201 data-nosnippet>201</a> </span>Hidden,
|
|
<a href=#202 id=202 data-nosnippet>202</a> <span class="doccomment">/// The sheet is hidden and cannot be displayed using the user interface. It is supported only by Excel formats.
|
|
<a href=#203 id=203 data-nosnippet>203</a> </span>VeryHidden,
|
|
<a href=#204 id=204 data-nosnippet>204</a>}
|
|
<a href=#205 id=205 data-nosnippet>205</a>
|
|
<a href=#206 id=206 data-nosnippet>206</a><span class="doccomment">/// Metadata of sheet
|
|
<a href=#207 id=207 data-nosnippet>207</a></span><span class="attr">#[derive(Debug, Clone, PartialEq)]
|
|
<a href=#208 id=208 data-nosnippet>208</a></span><span class="kw">pub struct </span>Sheet {
|
|
<a href=#209 id=209 data-nosnippet>209</a> <span class="doccomment">/// Name
|
|
<a href=#210 id=210 data-nosnippet>210</a> </span><span class="kw">pub </span>name: String,
|
|
<a href=#211 id=211 data-nosnippet>211</a> <span class="doccomment">/// Type
|
|
<a href=#212 id=212 data-nosnippet>212</a> /// Only Excel formats support this. Default value for ODS is SheetType::WorkSheet.
|
|
<a href=#213 id=213 data-nosnippet>213</a> </span><span class="kw">pub </span>typ: SheetType,
|
|
<a href=#214 id=214 data-nosnippet>214</a> <span class="doccomment">/// Visible
|
|
<a href=#215 id=215 data-nosnippet>215</a> </span><span class="kw">pub </span>visible: SheetVisible,
|
|
<a href=#216 id=216 data-nosnippet>216</a>}
|
|
<a href=#217 id=217 data-nosnippet>217</a>
|
|
<a href=#218 id=218 data-nosnippet>218</a><span class="doccomment">/// Row to use as header
|
|
<a href=#219 id=219 data-nosnippet>219</a>/// By default, the first non-empty row is used as header
|
|
<a href=#220 id=220 data-nosnippet>220</a></span><span class="attr">#[derive(Debug, Clone, Copy)]
|
|
<a href=#221 id=221 data-nosnippet>221</a>#[non_exhaustive]
|
|
<a href=#222 id=222 data-nosnippet>222</a></span><span class="kw">pub enum </span>HeaderRow {
|
|
<a href=#223 id=223 data-nosnippet>223</a> <span class="doccomment">/// First non-empty row
|
|
<a href=#224 id=224 data-nosnippet>224</a> </span>FirstNonEmptyRow,
|
|
<a href=#225 id=225 data-nosnippet>225</a> <span class="doccomment">/// Index of the header row
|
|
<a href=#226 id=226 data-nosnippet>226</a> </span>Row(u32),
|
|
<a href=#227 id=227 data-nosnippet>227</a>}
|
|
<a href=#228 id=228 data-nosnippet>228</a>
|
|
<a href=#229 id=229 data-nosnippet>229</a><span class="kw">impl </span>Default <span class="kw">for </span>HeaderRow {
|
|
<a href=#230 id=230 data-nosnippet>230</a> <span class="kw">fn </span>default() -> <span class="self">Self </span>{
|
|
<a href=#231 id=231 data-nosnippet>231</a> HeaderRow::FirstNonEmptyRow
|
|
<a href=#232 id=232 data-nosnippet>232</a> }
|
|
<a href=#233 id=233 data-nosnippet>233</a>}
|
|
<a href=#234 id=234 data-nosnippet>234</a>
|
|
<a href=#235 id=235 data-nosnippet>235</a><span class="comment">// FIXME `Reader` must only be seek `Seek` for `Xls::xls`. Because of the present API this limits
|
|
<a href=#236 id=236 data-nosnippet>236</a>// the kinds of readers (other) data in formats can be read from.
|
|
<a href=#237 id=237 data-nosnippet>237</a></span><span class="doccomment">/// A trait to share spreadsheets reader functions across different `FileType`s
|
|
<a href=#238 id=238 data-nosnippet>238</a></span><span class="kw">pub trait </span>Reader<RS>: Sized
|
|
<a href=#239 id=239 data-nosnippet>239</a><span class="kw">where
|
|
<a href=#240 id=240 data-nosnippet>240</a> </span>RS: Read + Seek,
|
|
<a href=#241 id=241 data-nosnippet>241</a>{
|
|
<a href=#242 id=242 data-nosnippet>242</a> <span class="doccomment">/// Error specific to file type
|
|
<a href=#243 id=243 data-nosnippet>243</a> </span><span class="kw">type </span>Error: std::fmt::Debug + From<std::io::Error>;
|
|
<a href=#244 id=244 data-nosnippet>244</a>
|
|
<a href=#245 id=245 data-nosnippet>245</a> <span class="doccomment">/// Creates a new instance.
|
|
<a href=#246 id=246 data-nosnippet>246</a> </span><span class="kw">fn </span>new(reader: RS) -> <span class="prelude-ty">Result</span><<span class="self">Self</span>, <span class="self">Self</span>::Error>;
|
|
<a href=#247 id=247 data-nosnippet>247</a>
|
|
<a href=#248 id=248 data-nosnippet>248</a> <span class="doccomment">/// Set header row (i.e. first row to be read)
|
|
<a href=#249 id=249 data-nosnippet>249</a> /// If `header_row` is `None`, the first non-empty row will be used as header row
|
|
<a href=#250 id=250 data-nosnippet>250</a> </span><span class="kw">fn </span>with_header_row(<span class="kw-2">&mut </span><span class="self">self</span>, header_row: HeaderRow) -> <span class="kw-2">&mut </span><span class="self">Self</span>;
|
|
<a href=#251 id=251 data-nosnippet>251</a>
|
|
<a href=#252 id=252 data-nosnippet>252</a> <span class="doccomment">/// Gets `VbaProject`
|
|
<a href=#253 id=253 data-nosnippet>253</a> </span><span class="kw">fn </span>vba_project(<span class="kw-2">&mut </span><span class="self">self</span>) -> <span class="prelude-ty">Option</span><<span class="prelude-ty">Result</span><Cow<<span class="lifetime">'_</span>, VbaProject>, <span class="self">Self</span>::Error>>;
|
|
<a href=#254 id=254 data-nosnippet>254</a>
|
|
<a href=#255 id=255 data-nosnippet>255</a> <span class="doccomment">/// Initialize
|
|
<a href=#256 id=256 data-nosnippet>256</a> </span><span class="kw">fn </span>metadata(<span class="kw-2">&</span><span class="self">self</span>) -> <span class="kw-2">&</span>Metadata;
|
|
<a href=#257 id=257 data-nosnippet>257</a>
|
|
<a href=#258 id=258 data-nosnippet>258</a> <span class="doccomment">/// Read worksheet data in corresponding worksheet path
|
|
<a href=#259 id=259 data-nosnippet>259</a> </span><span class="kw">fn </span>worksheet_range(<span class="kw-2">&mut </span><span class="self">self</span>, name: <span class="kw-2">&</span>str) -> <span class="prelude-ty">Result</span><Range<Data>, <span class="self">Self</span>::Error>;
|
|
<a href=#260 id=260 data-nosnippet>260</a>
|
|
<a href=#261 id=261 data-nosnippet>261</a> <span class="doccomment">/// Fetch all worksheet data & paths
|
|
<a href=#262 id=262 data-nosnippet>262</a> </span><span class="kw">fn </span>worksheets(<span class="kw-2">&mut </span><span class="self">self</span>) -> Vec<(String, Range<Data>)>;
|
|
<a href=#263 id=263 data-nosnippet>263</a>
|
|
<a href=#264 id=264 data-nosnippet>264</a> <span class="doccomment">/// Read worksheet formula in corresponding worksheet path
|
|
<a href=#265 id=265 data-nosnippet>265</a> </span><span class="kw">fn </span>worksheet_formula(<span class="kw-2">&mut </span><span class="self">self</span>, <span class="kw">_</span>: <span class="kw-2">&</span>str) -> <span class="prelude-ty">Result</span><Range<String>, <span class="self">Self</span>::Error>;
|
|
<a href=#266 id=266 data-nosnippet>266</a>
|
|
<a href=#267 id=267 data-nosnippet>267</a> <span class="doccomment">/// Get all sheet names of this workbook, in workbook order
|
|
<a href=#268 id=268 data-nosnippet>268</a> ///
|
|
<a href=#269 id=269 data-nosnippet>269</a> /// # Examples
|
|
<a href=#270 id=270 data-nosnippet>270</a> /// ```
|
|
<a href=#271 id=271 data-nosnippet>271</a> /// use calamine::{Xlsx, open_workbook, Reader};
|
|
<a href=#272 id=272 data-nosnippet>272</a> ///
|
|
<a href=#273 id=273 data-nosnippet>273</a> /// # let path = format!("{}/tests/issue3.xlsm", env!("CARGO_MANIFEST_DIR"));
|
|
<a href=#274 id=274 data-nosnippet>274</a> /// let mut workbook: Xlsx<_> = open_workbook(path).unwrap();
|
|
<a href=#275 id=275 data-nosnippet>275</a> /// println!("Sheets: {:#?}", workbook.sheet_names());
|
|
<a href=#276 id=276 data-nosnippet>276</a> /// ```
|
|
<a href=#277 id=277 data-nosnippet>277</a> </span><span class="kw">fn </span>sheet_names(<span class="kw-2">&</span><span class="self">self</span>) -> Vec<String> {
|
|
<a href=#278 id=278 data-nosnippet>278</a> <span class="self">self</span>.metadata()
|
|
<a href=#279 id=279 data-nosnippet>279</a> .sheets
|
|
<a href=#280 id=280 data-nosnippet>280</a> .iter()
|
|
<a href=#281 id=281 data-nosnippet>281</a> .map(|s| s.name.to_owned())
|
|
<a href=#282 id=282 data-nosnippet>282</a> .collect()
|
|
<a href=#283 id=283 data-nosnippet>283</a> }
|
|
<a href=#284 id=284 data-nosnippet>284</a>
|
|
<a href=#285 id=285 data-nosnippet>285</a> <span class="doccomment">/// Fetch all sheets metadata
|
|
<a href=#286 id=286 data-nosnippet>286</a> </span><span class="kw">fn </span>sheets_metadata(<span class="kw-2">&</span><span class="self">self</span>) -> <span class="kw-2">&</span>[Sheet] {
|
|
<a href=#287 id=287 data-nosnippet>287</a> <span class="kw-2">&</span><span class="self">self</span>.metadata().sheets
|
|
<a href=#288 id=288 data-nosnippet>288</a> }
|
|
<a href=#289 id=289 data-nosnippet>289</a>
|
|
<a href=#290 id=290 data-nosnippet>290</a> <span class="doccomment">/// Get all defined names (Ranges names etc)
|
|
<a href=#291 id=291 data-nosnippet>291</a> </span><span class="kw">fn </span>defined_names(<span class="kw-2">&</span><span class="self">self</span>) -> <span class="kw-2">&</span>[(String, String)] {
|
|
<a href=#292 id=292 data-nosnippet>292</a> <span class="kw-2">&</span><span class="self">self</span>.metadata().names
|
|
<a href=#293 id=293 data-nosnippet>293</a> }
|
|
<a href=#294 id=294 data-nosnippet>294</a>
|
|
<a href=#295 id=295 data-nosnippet>295</a> <span class="doccomment">/// Get the nth worksheet. Shortcut for getting the nth
|
|
<a href=#296 id=296 data-nosnippet>296</a> /// sheet_name, then the corresponding worksheet.
|
|
<a href=#297 id=297 data-nosnippet>297</a> </span><span class="kw">fn </span>worksheet_range_at(<span class="kw-2">&mut </span><span class="self">self</span>, n: usize) -> <span class="prelude-ty">Option</span><<span class="prelude-ty">Result</span><Range<Data>, <span class="self">Self</span>::Error>> {
|
|
<a href=#298 id=298 data-nosnippet>298</a> <span class="kw">let </span>name = <span class="self">self</span>.sheet_names().get(n)<span class="question-mark">?</span>.to_string();
|
|
<a href=#299 id=299 data-nosnippet>299</a> <span class="prelude-val">Some</span>(<span class="self">self</span>.worksheet_range(<span class="kw-2">&</span>name))
|
|
<a href=#300 id=300 data-nosnippet>300</a> }
|
|
<a href=#301 id=301 data-nosnippet>301</a>
|
|
<a href=#302 id=302 data-nosnippet>302</a> <span class="doccomment">/// Get all pictures, tuple as (ext: String, data: Vec<u8>)
|
|
<a href=#303 id=303 data-nosnippet>303</a> </span><span class="attr">#[cfg(feature = <span class="string">"picture"</span>)]
|
|
<a href=#304 id=304 data-nosnippet>304</a> </span><span class="kw">fn </span>pictures(<span class="kw-2">&</span><span class="self">self</span>) -> <span class="prelude-ty">Option</span><Vec<(String, Vec<u8>)>>;
|
|
<a href=#305 id=305 data-nosnippet>305</a>}
|
|
<a href=#306 id=306 data-nosnippet>306</a>
|
|
<a href=#307 id=307 data-nosnippet>307</a><span class="doccomment">/// A trait to share spreadsheets reader functions across different `FileType`s
|
|
<a href=#308 id=308 data-nosnippet>308</a></span><span class="kw">pub trait </span>ReaderRef<RS>: Reader<RS>
|
|
<a href=#309 id=309 data-nosnippet>309</a><span class="kw">where
|
|
<a href=#310 id=310 data-nosnippet>310</a> </span>RS: Read + Seek,
|
|
<a href=#311 id=311 data-nosnippet>311</a>{
|
|
<a href=#312 id=312 data-nosnippet>312</a> <span class="doccomment">/// Get worksheet range where shared string values are only borrowed.
|
|
<a href=#313 id=313 data-nosnippet>313</a> ///
|
|
<a href=#314 id=314 data-nosnippet>314</a> /// This is implemented only for [`calamine::Xlsb`] and [`calamine::Xlsx`], as Xls and Ods formats
|
|
<a href=#315 id=315 data-nosnippet>315</a> /// do not support lazy iteration.
|
|
<a href=#316 id=316 data-nosnippet>316</a> </span><span class="kw">fn </span>worksheet_range_ref<<span class="lifetime">'a</span>>(<span class="kw-2">&</span><span class="lifetime">'a </span><span class="kw-2">mut </span><span class="self">self</span>, name: <span class="kw-2">&</span>str)
|
|
<a href=#317 id=317 data-nosnippet>317</a> -> <span class="prelude-ty">Result</span><Range<DataRef<<span class="lifetime">'a</span>>>, <span class="self">Self</span>::Error>;
|
|
<a href=#318 id=318 data-nosnippet>318</a>
|
|
<a href=#319 id=319 data-nosnippet>319</a> <span class="doccomment">/// Get the nth worksheet range where shared string values are only borrowed. Shortcut for getting the nth
|
|
<a href=#320 id=320 data-nosnippet>320</a> /// sheet_name, then the corresponding worksheet.
|
|
<a href=#321 id=321 data-nosnippet>321</a> ///
|
|
<a href=#322 id=322 data-nosnippet>322</a> /// This is implemented only for [`calamine::Xlsb`] and [`calamine::Xlsx`], as Xls and Ods formats
|
|
<a href=#323 id=323 data-nosnippet>323</a> /// do not support lazy iteration.
|
|
<a href=#324 id=324 data-nosnippet>324</a> </span><span class="kw">fn </span>worksheet_range_at_ref(<span class="kw-2">&mut </span><span class="self">self</span>, n: usize) -> <span class="prelude-ty">Option</span><<span class="prelude-ty">Result</span><Range<DataRef>, <span class="self">Self</span>::Error>> {
|
|
<a href=#325 id=325 data-nosnippet>325</a> <span class="kw">let </span>name = <span class="self">self</span>.sheet_names().get(n)<span class="question-mark">?</span>.to_string();
|
|
<a href=#326 id=326 data-nosnippet>326</a> <span class="prelude-val">Some</span>(<span class="self">self</span>.worksheet_range_ref(<span class="kw-2">&</span>name))
|
|
<a href=#327 id=327 data-nosnippet>327</a> }
|
|
<a href=#328 id=328 data-nosnippet>328</a>}
|
|
<a href=#329 id=329 data-nosnippet>329</a>
|
|
<a href=#330 id=330 data-nosnippet>330</a><span class="doccomment">/// Convenient function to open a file with a BufReader<File>
|
|
<a href=#331 id=331 data-nosnippet>331</a></span><span class="kw">pub fn </span>open_workbook<R, P>(path: P) -> <span class="prelude-ty">Result</span><R, R::Error>
|
|
<a href=#332 id=332 data-nosnippet>332</a><span class="kw">where
|
|
<a href=#333 id=333 data-nosnippet>333</a> </span>R: Reader<BufReader<File>>,
|
|
<a href=#334 id=334 data-nosnippet>334</a> P: AsRef<Path>,
|
|
<a href=#335 id=335 data-nosnippet>335</a>{
|
|
<a href=#336 id=336 data-nosnippet>336</a> <span class="kw">let </span>file = BufReader::new(File::open(path)<span class="question-mark">?</span>);
|
|
<a href=#337 id=337 data-nosnippet>337</a> R::new(file)
|
|
<a href=#338 id=338 data-nosnippet>338</a>}
|
|
<a href=#339 id=339 data-nosnippet>339</a>
|
|
<a href=#340 id=340 data-nosnippet>340</a><span class="doccomment">/// Convenient function to open a file with a BufReader<File>
|
|
<a href=#341 id=341 data-nosnippet>341</a></span><span class="kw">pub fn </span>open_workbook_from_rs<R, RS>(rs: RS) -> <span class="prelude-ty">Result</span><R, R::Error>
|
|
<a href=#342 id=342 data-nosnippet>342</a><span class="kw">where
|
|
<a href=#343 id=343 data-nosnippet>343</a> </span>RS: Read + Seek,
|
|
<a href=#344 id=344 data-nosnippet>344</a> R: Reader<RS>,
|
|
<a href=#345 id=345 data-nosnippet>345</a>{
|
|
<a href=#346 id=346 data-nosnippet>346</a> R::new(rs)
|
|
<a href=#347 id=347 data-nosnippet>347</a>}
|
|
<a href=#348 id=348 data-nosnippet>348</a>
|
|
<a href=#349 id=349 data-nosnippet>349</a><span class="doccomment">/// A trait to constrain cells
|
|
<a href=#350 id=350 data-nosnippet>350</a></span><span class="kw">pub trait </span>CellType: Default + Clone + PartialEq {}
|
|
<a href=#351 id=351 data-nosnippet>351</a>
|
|
<a href=#352 id=352 data-nosnippet>352</a><span class="kw">impl </span>CellType <span class="kw">for </span>Data {}
|
|
<a href=#353 id=353 data-nosnippet>353</a><span class="kw">impl</span><<span class="lifetime">'a</span>> CellType <span class="kw">for </span>DataRef<<span class="lifetime">'a</span>> {}
|
|
<a href=#354 id=354 data-nosnippet>354</a><span class="kw">impl </span>CellType <span class="kw">for </span>String {}
|
|
<a href=#355 id=355 data-nosnippet>355</a><span class="kw">impl </span>CellType <span class="kw">for </span>usize {} <span class="comment">// for tests
|
|
<a href=#356 id=356 data-nosnippet>356</a>
|
|
<a href=#357 id=357 data-nosnippet>357</a></span><span class="doccomment">/// A struct to hold cell position and value
|
|
<a href=#358 id=358 data-nosnippet>358</a></span><span class="attr">#[derive(Debug, Clone)]
|
|
<a href=#359 id=359 data-nosnippet>359</a></span><span class="kw">pub struct </span>Cell<T: CellType> {
|
|
<a href=#360 id=360 data-nosnippet>360</a> <span class="doccomment">/// Position for the cell (row, column)
|
|
<a href=#361 id=361 data-nosnippet>361</a> </span>pos: (u32, u32),
|
|
<a href=#362 id=362 data-nosnippet>362</a> <span class="doccomment">/// Value for the cell
|
|
<a href=#363 id=363 data-nosnippet>363</a> </span>val: T,
|
|
<a href=#364 id=364 data-nosnippet>364</a>}
|
|
<a href=#365 id=365 data-nosnippet>365</a>
|
|
<a href=#366 id=366 data-nosnippet>366</a><span class="kw">impl</span><T: CellType> Cell<T> {
|
|
<a href=#367 id=367 data-nosnippet>367</a> <span class="doccomment">/// Creates a new `Cell`
|
|
<a href=#368 id=368 data-nosnippet>368</a> </span><span class="kw">pub fn </span>new(position: (u32, u32), value: T) -> Cell<T> {
|
|
<a href=#369 id=369 data-nosnippet>369</a> Cell {
|
|
<a href=#370 id=370 data-nosnippet>370</a> pos: position,
|
|
<a href=#371 id=371 data-nosnippet>371</a> val: value,
|
|
<a href=#372 id=372 data-nosnippet>372</a> }
|
|
<a href=#373 id=373 data-nosnippet>373</a> }
|
|
<a href=#374 id=374 data-nosnippet>374</a>
|
|
<a href=#375 id=375 data-nosnippet>375</a> <span class="doccomment">/// Gets `Cell` position
|
|
<a href=#376 id=376 data-nosnippet>376</a> </span><span class="kw">pub fn </span>get_position(<span class="kw-2">&</span><span class="self">self</span>) -> (u32, u32) {
|
|
<a href=#377 id=377 data-nosnippet>377</a> <span class="self">self</span>.pos
|
|
<a href=#378 id=378 data-nosnippet>378</a> }
|
|
<a href=#379 id=379 data-nosnippet>379</a>
|
|
<a href=#380 id=380 data-nosnippet>380</a> <span class="doccomment">/// Gets `Cell` value
|
|
<a href=#381 id=381 data-nosnippet>381</a> </span><span class="kw">pub fn </span>get_value(<span class="kw-2">&</span><span class="self">self</span>) -> <span class="kw-2">&</span>T {
|
|
<a href=#382 id=382 data-nosnippet>382</a> <span class="kw-2">&</span><span class="self">self</span>.val
|
|
<a href=#383 id=383 data-nosnippet>383</a> }
|
|
<a href=#384 id=384 data-nosnippet>384</a>}
|
|
<a href=#385 id=385 data-nosnippet>385</a>
|
|
<a href=#386 id=386 data-nosnippet>386</a><span class="doccomment">/// A struct which represents a squared selection of cells
|
|
<a href=#387 id=387 data-nosnippet>387</a></span><span class="attr">#[derive(Debug, Default, Clone)]
|
|
<a href=#388 id=388 data-nosnippet>388</a></span><span class="kw">pub struct </span>Range<T> {
|
|
<a href=#389 id=389 data-nosnippet>389</a> start: (u32, u32),
|
|
<a href=#390 id=390 data-nosnippet>390</a> end: (u32, u32),
|
|
<a href=#391 id=391 data-nosnippet>391</a> inner: Vec<T>,
|
|
<a href=#392 id=392 data-nosnippet>392</a>}
|
|
<a href=#393 id=393 data-nosnippet>393</a>
|
|
<a href=#394 id=394 data-nosnippet>394</a><span class="kw">impl</span><T: CellType> Range<T> {
|
|
<a href=#395 id=395 data-nosnippet>395</a> <span class="doccomment">/// Creates a new non-empty `Range`
|
|
<a href=#396 id=396 data-nosnippet>396</a> ///
|
|
<a href=#397 id=397 data-nosnippet>397</a> /// When possible, prefer the more efficient `Range::from_sparse`
|
|
<a href=#398 id=398 data-nosnippet>398</a> ///
|
|
<a href=#399 id=399 data-nosnippet>399</a> /// # Panics
|
|
<a href=#400 id=400 data-nosnippet>400</a> ///
|
|
<a href=#401 id=401 data-nosnippet>401</a> /// Panics if start.0 > end.0 or start.1 > end.1
|
|
<a href=#402 id=402 data-nosnippet>402</a> </span><span class="attr">#[inline]
|
|
<a href=#403 id=403 data-nosnippet>403</a> </span><span class="kw">pub fn </span>new(start: (u32, u32), end: (u32, u32)) -> Range<T> {
|
|
<a href=#404 id=404 data-nosnippet>404</a> <span class="macro">assert!</span>(start <= end, <span class="string">"invalid range bounds"</span>);
|
|
<a href=#405 id=405 data-nosnippet>405</a> Range {
|
|
<a href=#406 id=406 data-nosnippet>406</a> start,
|
|
<a href=#407 id=407 data-nosnippet>407</a> end,
|
|
<a href=#408 id=408 data-nosnippet>408</a> inner: <span class="macro">vec!</span>[T::default(); ((end.<span class="number">0 </span>- start.<span class="number">0 </span>+ <span class="number">1</span>) * (end.<span class="number">1 </span>- start.<span class="number">1 </span>+ <span class="number">1</span>)) <span class="kw">as </span>usize],
|
|
<a href=#409 id=409 data-nosnippet>409</a> }
|
|
<a href=#410 id=410 data-nosnippet>410</a> }
|
|
<a href=#411 id=411 data-nosnippet>411</a>
|
|
<a href=#412 id=412 data-nosnippet>412</a> <span class="doccomment">/// Creates a new empty range
|
|
<a href=#413 id=413 data-nosnippet>413</a> </span><span class="attr">#[inline]
|
|
<a href=#414 id=414 data-nosnippet>414</a> </span><span class="kw">pub fn </span>empty() -> Range<T> {
|
|
<a href=#415 id=415 data-nosnippet>415</a> Range {
|
|
<a href=#416 id=416 data-nosnippet>416</a> start: (<span class="number">0</span>, <span class="number">0</span>),
|
|
<a href=#417 id=417 data-nosnippet>417</a> end: (<span class="number">0</span>, <span class="number">0</span>),
|
|
<a href=#418 id=418 data-nosnippet>418</a> inner: Vec::new(),
|
|
<a href=#419 id=419 data-nosnippet>419</a> }
|
|
<a href=#420 id=420 data-nosnippet>420</a> }
|
|
<a href=#421 id=421 data-nosnippet>421</a>
|
|
<a href=#422 id=422 data-nosnippet>422</a> <span class="doccomment">/// Get top left cell position (row, column)
|
|
<a href=#423 id=423 data-nosnippet>423</a> </span><span class="attr">#[inline]
|
|
<a href=#424 id=424 data-nosnippet>424</a> </span><span class="kw">pub fn </span>start(<span class="kw-2">&</span><span class="self">self</span>) -> <span class="prelude-ty">Option</span><(u32, u32)> {
|
|
<a href=#425 id=425 data-nosnippet>425</a> <span class="kw">if </span><span class="self">self</span>.is_empty() {
|
|
<a href=#426 id=426 data-nosnippet>426</a> <span class="prelude-val">None
|
|
<a href=#427 id=427 data-nosnippet>427</a> </span>} <span class="kw">else </span>{
|
|
<a href=#428 id=428 data-nosnippet>428</a> <span class="prelude-val">Some</span>(<span class="self">self</span>.start)
|
|
<a href=#429 id=429 data-nosnippet>429</a> }
|
|
<a href=#430 id=430 data-nosnippet>430</a> }
|
|
<a href=#431 id=431 data-nosnippet>431</a>
|
|
<a href=#432 id=432 data-nosnippet>432</a> <span class="doccomment">/// Get bottom right cell position (row, column)
|
|
<a href=#433 id=433 data-nosnippet>433</a> </span><span class="attr">#[inline]
|
|
<a href=#434 id=434 data-nosnippet>434</a> </span><span class="kw">pub fn </span>end(<span class="kw-2">&</span><span class="self">self</span>) -> <span class="prelude-ty">Option</span><(u32, u32)> {
|
|
<a href=#435 id=435 data-nosnippet>435</a> <span class="kw">if </span><span class="self">self</span>.is_empty() {
|
|
<a href=#436 id=436 data-nosnippet>436</a> <span class="prelude-val">None
|
|
<a href=#437 id=437 data-nosnippet>437</a> </span>} <span class="kw">else </span>{
|
|
<a href=#438 id=438 data-nosnippet>438</a> <span class="prelude-val">Some</span>(<span class="self">self</span>.end)
|
|
<a href=#439 id=439 data-nosnippet>439</a> }
|
|
<a href=#440 id=440 data-nosnippet>440</a> }
|
|
<a href=#441 id=441 data-nosnippet>441</a>
|
|
<a href=#442 id=442 data-nosnippet>442</a> <span class="doccomment">/// Get column width
|
|
<a href=#443 id=443 data-nosnippet>443</a> </span><span class="attr">#[inline]
|
|
<a href=#444 id=444 data-nosnippet>444</a> </span><span class="kw">pub fn </span>width(<span class="kw-2">&</span><span class="self">self</span>) -> usize {
|
|
<a href=#445 id=445 data-nosnippet>445</a> <span class="kw">if </span><span class="self">self</span>.is_empty() {
|
|
<a href=#446 id=446 data-nosnippet>446</a> <span class="number">0
|
|
<a href=#447 id=447 data-nosnippet>447</a> </span>} <span class="kw">else </span>{
|
|
<a href=#448 id=448 data-nosnippet>448</a> (<span class="self">self</span>.end.<span class="number">1 </span>- <span class="self">self</span>.start.<span class="number">1 </span>+ <span class="number">1</span>) <span class="kw">as </span>usize
|
|
<a href=#449 id=449 data-nosnippet>449</a> }
|
|
<a href=#450 id=450 data-nosnippet>450</a> }
|
|
<a href=#451 id=451 data-nosnippet>451</a>
|
|
<a href=#452 id=452 data-nosnippet>452</a> <span class="doccomment">/// Get column height
|
|
<a href=#453 id=453 data-nosnippet>453</a> </span><span class="attr">#[inline]
|
|
<a href=#454 id=454 data-nosnippet>454</a> </span><span class="kw">pub fn </span>height(<span class="kw-2">&</span><span class="self">self</span>) -> usize {
|
|
<a href=#455 id=455 data-nosnippet>455</a> <span class="kw">if </span><span class="self">self</span>.is_empty() {
|
|
<a href=#456 id=456 data-nosnippet>456</a> <span class="number">0
|
|
<a href=#457 id=457 data-nosnippet>457</a> </span>} <span class="kw">else </span>{
|
|
<a href=#458 id=458 data-nosnippet>458</a> (<span class="self">self</span>.end.<span class="number">0 </span>- <span class="self">self</span>.start.<span class="number">0 </span>+ <span class="number">1</span>) <span class="kw">as </span>usize
|
|
<a href=#459 id=459 data-nosnippet>459</a> }
|
|
<a href=#460 id=460 data-nosnippet>460</a> }
|
|
<a href=#461 id=461 data-nosnippet>461</a>
|
|
<a href=#462 id=462 data-nosnippet>462</a> <span class="doccomment">/// Get size in (height, width) format
|
|
<a href=#463 id=463 data-nosnippet>463</a> </span><span class="attr">#[inline]
|
|
<a href=#464 id=464 data-nosnippet>464</a> </span><span class="kw">pub fn </span>get_size(<span class="kw-2">&</span><span class="self">self</span>) -> (usize, usize) {
|
|
<a href=#465 id=465 data-nosnippet>465</a> (<span class="self">self</span>.height(), <span class="self">self</span>.width())
|
|
<a href=#466 id=466 data-nosnippet>466</a> }
|
|
<a href=#467 id=467 data-nosnippet>467</a>
|
|
<a href=#468 id=468 data-nosnippet>468</a> <span class="doccomment">/// Is range empty
|
|
<a href=#469 id=469 data-nosnippet>469</a> </span><span class="attr">#[inline]
|
|
<a href=#470 id=470 data-nosnippet>470</a> </span><span class="kw">pub fn </span>is_empty(<span class="kw-2">&</span><span class="self">self</span>) -> bool {
|
|
<a href=#471 id=471 data-nosnippet>471</a> <span class="self">self</span>.inner.is_empty()
|
|
<a href=#472 id=472 data-nosnippet>472</a> }
|
|
<a href=#473 id=473 data-nosnippet>473</a>
|
|
<a href=#474 id=474 data-nosnippet>474</a> <span class="doccomment">/// Creates a `Range` from a coo sparse vector of `Cell`s.
|
|
<a href=#475 id=475 data-nosnippet>475</a> ///
|
|
<a href=#476 id=476 data-nosnippet>476</a> /// Coordinate list (COO) is the natural way cells are stored
|
|
<a href=#477 id=477 data-nosnippet>477</a> /// Inner size is defined only by non empty.
|
|
<a href=#478 id=478 data-nosnippet>478</a> ///
|
|
<a href=#479 id=479 data-nosnippet>479</a> /// cells: `Vec` of non empty `Cell`s, sorted by row
|
|
<a href=#480 id=480 data-nosnippet>480</a> ///
|
|
<a href=#481 id=481 data-nosnippet>481</a> /// # Panics
|
|
<a href=#482 id=482 data-nosnippet>482</a> ///
|
|
<a href=#483 id=483 data-nosnippet>483</a> /// panics when a `Cell` row is lower than the first `Cell` row or
|
|
<a href=#484 id=484 data-nosnippet>484</a> /// bigger than the last `Cell` row.
|
|
<a href=#485 id=485 data-nosnippet>485</a> </span><span class="kw">pub fn </span>from_sparse(cells: Vec<Cell<T>>) -> Range<T> {
|
|
<a href=#486 id=486 data-nosnippet>486</a> <span class="kw">if </span>cells.is_empty() {
|
|
<a href=#487 id=487 data-nosnippet>487</a> Range::empty()
|
|
<a href=#488 id=488 data-nosnippet>488</a> } <span class="kw">else </span>{
|
|
<a href=#489 id=489 data-nosnippet>489</a> <span class="comment">// search bounds
|
|
<a href=#490 id=490 data-nosnippet>490</a> </span><span class="kw">let </span>row_start = cells.first().unwrap().pos.<span class="number">0</span>;
|
|
<a href=#491 id=491 data-nosnippet>491</a> <span class="kw">let </span>row_end = cells.last().unwrap().pos.<span class="number">0</span>;
|
|
<a href=#492 id=492 data-nosnippet>492</a> <span class="kw">let </span><span class="kw-2">mut </span>col_start = u32::MAX;
|
|
<a href=#493 id=493 data-nosnippet>493</a> <span class="kw">let </span><span class="kw-2">mut </span>col_end = <span class="number">0</span>;
|
|
<a href=#494 id=494 data-nosnippet>494</a> <span class="kw">for </span>c <span class="kw">in </span>cells.iter().map(|c| c.pos.<span class="number">1</span>) {
|
|
<a href=#495 id=495 data-nosnippet>495</a> <span class="kw">if </span>c < col_start {
|
|
<a href=#496 id=496 data-nosnippet>496</a> col_start = c;
|
|
<a href=#497 id=497 data-nosnippet>497</a> }
|
|
<a href=#498 id=498 data-nosnippet>498</a> <span class="kw">if </span>c > col_end {
|
|
<a href=#499 id=499 data-nosnippet>499</a> col_end = c
|
|
<a href=#500 id=500 data-nosnippet>500</a> }
|
|
<a href=#501 id=501 data-nosnippet>501</a> }
|
|
<a href=#502 id=502 data-nosnippet>502</a> <span class="kw">let </span>cols = (col_end - col_start + <span class="number">1</span>) <span class="kw">as </span>usize;
|
|
<a href=#503 id=503 data-nosnippet>503</a> <span class="kw">let </span>rows = (row_end - row_start + <span class="number">1</span>) <span class="kw">as </span>usize;
|
|
<a href=#504 id=504 data-nosnippet>504</a> <span class="kw">let </span>len = cols.saturating_mul(rows);
|
|
<a href=#505 id=505 data-nosnippet>505</a> <span class="kw">let </span><span class="kw-2">mut </span>v = <span class="macro">vec!</span>[T::default(); len];
|
|
<a href=#506 id=506 data-nosnippet>506</a> v.shrink_to_fit();
|
|
<a href=#507 id=507 data-nosnippet>507</a> <span class="kw">for </span>c <span class="kw">in </span>cells {
|
|
<a href=#508 id=508 data-nosnippet>508</a> <span class="kw">let </span>row = (c.pos.<span class="number">0 </span>- row_start) <span class="kw">as </span>usize;
|
|
<a href=#509 id=509 data-nosnippet>509</a> <span class="kw">let </span>col = (c.pos.<span class="number">1 </span>- col_start) <span class="kw">as </span>usize;
|
|
<a href=#510 id=510 data-nosnippet>510</a> <span class="kw">let </span>idx = row.saturating_mul(cols) + col;
|
|
<a href=#511 id=511 data-nosnippet>511</a> <span class="kw">if let </span><span class="prelude-val">Some</span>(v) = v.get_mut(idx) {
|
|
<a href=#512 id=512 data-nosnippet>512</a> <span class="kw-2">*</span>v = c.val;
|
|
<a href=#513 id=513 data-nosnippet>513</a> }
|
|
<a href=#514 id=514 data-nosnippet>514</a> }
|
|
<a href=#515 id=515 data-nosnippet>515</a> Range {
|
|
<a href=#516 id=516 data-nosnippet>516</a> start: (row_start, col_start),
|
|
<a href=#517 id=517 data-nosnippet>517</a> end: (row_end, col_end),
|
|
<a href=#518 id=518 data-nosnippet>518</a> inner: v,
|
|
<a href=#519 id=519 data-nosnippet>519</a> }
|
|
<a href=#520 id=520 data-nosnippet>520</a> }
|
|
<a href=#521 id=521 data-nosnippet>521</a> }
|
|
<a href=#522 id=522 data-nosnippet>522</a>
|
|
<a href=#523 id=523 data-nosnippet>523</a> <span class="doccomment">/// Set inner value from absolute position
|
|
<a href=#524 id=524 data-nosnippet>524</a> ///
|
|
<a href=#525 id=525 data-nosnippet>525</a> /// # Remarks
|
|
<a href=#526 id=526 data-nosnippet>526</a> ///
|
|
<a href=#527 id=527 data-nosnippet>527</a> /// Will try to resize inner structure if the value is out of bounds.
|
|
<a href=#528 id=528 data-nosnippet>528</a> /// For relative positions, use Index trait
|
|
<a href=#529 id=529 data-nosnippet>529</a> ///
|
|
<a href=#530 id=530 data-nosnippet>530</a> /// Try to avoid this method as much as possible and prefer initializing
|
|
<a href=#531 id=531 data-nosnippet>531</a> /// the `Range` with `from_sparse` constructor.
|
|
<a href=#532 id=532 data-nosnippet>532</a> ///
|
|
<a href=#533 id=533 data-nosnippet>533</a> /// # Panics
|
|
<a href=#534 id=534 data-nosnippet>534</a> ///
|
|
<a href=#535 id=535 data-nosnippet>535</a> /// If absolute_position > Cell start
|
|
<a href=#536 id=536 data-nosnippet>536</a> ///
|
|
<a href=#537 id=537 data-nosnippet>537</a> /// # Examples
|
|
<a href=#538 id=538 data-nosnippet>538</a> /// ```
|
|
<a href=#539 id=539 data-nosnippet>539</a> /// use calamine::{Range, Data};
|
|
<a href=#540 id=540 data-nosnippet>540</a> ///
|
|
<a href=#541 id=541 data-nosnippet>541</a> /// let mut range = Range::new((0, 0), (5, 2));
|
|
<a href=#542 id=542 data-nosnippet>542</a> /// assert_eq!(range.get_value((2, 1)), Some(&Data::Empty));
|
|
<a href=#543 id=543 data-nosnippet>543</a> /// range.set_value((2, 1), Data::Float(1.0));
|
|
<a href=#544 id=544 data-nosnippet>544</a> /// assert_eq!(range.get_value((2, 1)), Some(&Data::Float(1.0)));
|
|
<a href=#545 id=545 data-nosnippet>545</a> /// ```
|
|
<a href=#546 id=546 data-nosnippet>546</a> </span><span class="kw">pub fn </span>set_value(<span class="kw-2">&mut </span><span class="self">self</span>, absolute_position: (u32, u32), value: T) {
|
|
<a href=#547 id=547 data-nosnippet>547</a> <span class="macro">assert!</span>(
|
|
<a href=#548 id=548 data-nosnippet>548</a> <span class="self">self</span>.start.<span class="number">0 </span><= absolute_position.<span class="number">0 </span>&& <span class="self">self</span>.start.<span class="number">1 </span><= absolute_position.<span class="number">1</span>,
|
|
<a href=#549 id=549 data-nosnippet>549</a> <span class="string">"absolute_position out of bounds"
|
|
<a href=#550 id=550 data-nosnippet>550</a> </span>);
|
|
<a href=#551 id=551 data-nosnippet>551</a>
|
|
<a href=#552 id=552 data-nosnippet>552</a> <span class="comment">// check if we need to change range dimension (strangely happens sometimes ...)
|
|
<a href=#553 id=553 data-nosnippet>553</a> </span><span class="kw">match </span>(
|
|
<a href=#554 id=554 data-nosnippet>554</a> <span class="self">self</span>.end.<span class="number">0 </span>< absolute_position.<span class="number">0</span>,
|
|
<a href=#555 id=555 data-nosnippet>555</a> <span class="self">self</span>.end.<span class="number">1 </span>< absolute_position.<span class="number">1</span>,
|
|
<a href=#556 id=556 data-nosnippet>556</a> ) {
|
|
<a href=#557 id=557 data-nosnippet>557</a> (<span class="bool-val">false</span>, <span class="bool-val">false</span>) => (), <span class="comment">// regular case, position within bounds
|
|
<a href=#558 id=558 data-nosnippet>558</a> </span>(<span class="bool-val">true</span>, <span class="bool-val">false</span>) => {
|
|
<a href=#559 id=559 data-nosnippet>559</a> <span class="kw">let </span>len = (absolute_position.<span class="number">0 </span>- <span class="self">self</span>.end.<span class="number">0 </span>+ <span class="number">1</span>) <span class="kw">as </span>usize * <span class="self">self</span>.width();
|
|
<a href=#560 id=560 data-nosnippet>560</a> <span class="self">self</span>.inner.extend_from_slice(<span class="kw-2">&</span><span class="macro">vec!</span>[T::default(); len]);
|
|
<a href=#561 id=561 data-nosnippet>561</a> <span class="self">self</span>.end.<span class="number">0 </span>= absolute_position.<span class="number">0</span>;
|
|
<a href=#562 id=562 data-nosnippet>562</a> }
|
|
<a href=#563 id=563 data-nosnippet>563</a> <span class="comment">// missing some rows
|
|
<a href=#564 id=564 data-nosnippet>564</a> </span>(e, <span class="bool-val">true</span>) => {
|
|
<a href=#565 id=565 data-nosnippet>565</a> <span class="kw">let </span>height = <span class="kw">if </span>e {
|
|
<a href=#566 id=566 data-nosnippet>566</a> (absolute_position.<span class="number">0 </span>- <span class="self">self</span>.start.<span class="number">0 </span>+ <span class="number">1</span>) <span class="kw">as </span>usize
|
|
<a href=#567 id=567 data-nosnippet>567</a> } <span class="kw">else </span>{
|
|
<a href=#568 id=568 data-nosnippet>568</a> <span class="self">self</span>.height()
|
|
<a href=#569 id=569 data-nosnippet>569</a> };
|
|
<a href=#570 id=570 data-nosnippet>570</a> <span class="kw">let </span>width = (absolute_position.<span class="number">1 </span>- <span class="self">self</span>.start.<span class="number">1 </span>+ <span class="number">1</span>) <span class="kw">as </span>usize;
|
|
<a href=#571 id=571 data-nosnippet>571</a> <span class="kw">let </span>old_width = <span class="self">self</span>.width();
|
|
<a href=#572 id=572 data-nosnippet>572</a> <span class="kw">let </span><span class="kw-2">mut </span>data = Vec::with_capacity(width * height);
|
|
<a href=#573 id=573 data-nosnippet>573</a> <span class="kw">let </span>empty = <span class="macro">vec!</span>[T::default(); width - old_width];
|
|
<a href=#574 id=574 data-nosnippet>574</a> <span class="kw">for </span>sce <span class="kw">in </span><span class="self">self</span>.inner.chunks(old_width) {
|
|
<a href=#575 id=575 data-nosnippet>575</a> data.extend_from_slice(sce);
|
|
<a href=#576 id=576 data-nosnippet>576</a> data.extend_from_slice(<span class="kw-2">&</span>empty);
|
|
<a href=#577 id=577 data-nosnippet>577</a> }
|
|
<a href=#578 id=578 data-nosnippet>578</a> data.extend_from_slice(<span class="kw-2">&</span><span class="macro">vec!</span>[T::default(); width * (height - <span class="self">self</span>.height())]);
|
|
<a href=#579 id=579 data-nosnippet>579</a> <span class="kw">if </span>e {
|
|
<a href=#580 id=580 data-nosnippet>580</a> <span class="self">self</span>.end = absolute_position
|
|
<a href=#581 id=581 data-nosnippet>581</a> } <span class="kw">else </span>{
|
|
<a href=#582 id=582 data-nosnippet>582</a> <span class="self">self</span>.end.<span class="number">1 </span>= absolute_position.<span class="number">1
|
|
<a href=#583 id=583 data-nosnippet>583</a> </span>}
|
|
<a href=#584 id=584 data-nosnippet>584</a> <span class="self">self</span>.inner = data;
|
|
<a href=#585 id=585 data-nosnippet>585</a> } <span class="comment">// missing some columns
|
|
<a href=#586 id=586 data-nosnippet>586</a> </span>}
|
|
<a href=#587 id=587 data-nosnippet>587</a>
|
|
<a href=#588 id=588 data-nosnippet>588</a> <span class="kw">let </span>pos = (
|
|
<a href=#589 id=589 data-nosnippet>589</a> absolute_position.<span class="number">0 </span>- <span class="self">self</span>.start.<span class="number">0</span>,
|
|
<a href=#590 id=590 data-nosnippet>590</a> absolute_position.<span class="number">1 </span>- <span class="self">self</span>.start.<span class="number">1</span>,
|
|
<a href=#591 id=591 data-nosnippet>591</a> );
|
|
<a href=#592 id=592 data-nosnippet>592</a> <span class="kw">let </span>idx = pos.<span class="number">0 </span><span class="kw">as </span>usize * <span class="self">self</span>.width() + pos.<span class="number">1 </span><span class="kw">as </span>usize;
|
|
<a href=#593 id=593 data-nosnippet>593</a> <span class="self">self</span>.inner[idx] = value;
|
|
<a href=#594 id=594 data-nosnippet>594</a> }
|
|
<a href=#595 id=595 data-nosnippet>595</a>
|
|
<a href=#596 id=596 data-nosnippet>596</a> <span class="doccomment">/// Get cell value from **absolute position**.
|
|
<a href=#597 id=597 data-nosnippet>597</a> ///
|
|
<a href=#598 id=598 data-nosnippet>598</a> /// If the `absolute_position` is out of range, returns `None`, else returns the cell value.
|
|
<a href=#599 id=599 data-nosnippet>599</a> /// The coordinate format is (row, column).
|
|
<a href=#600 id=600 data-nosnippet>600</a> ///
|
|
<a href=#601 id=601 data-nosnippet>601</a> /// # Warnings
|
|
<a href=#602 id=602 data-nosnippet>602</a> ///
|
|
<a href=#603 id=603 data-nosnippet>603</a> /// For relative positions, use Index trait
|
|
<a href=#604 id=604 data-nosnippet>604</a> ///
|
|
<a href=#605 id=605 data-nosnippet>605</a> /// # Remarks
|
|
<a href=#606 id=606 data-nosnippet>606</a> ///
|
|
<a href=#607 id=607 data-nosnippet>607</a> /// Absolute position is in *sheet* referential while relative position is in *range* referential.
|
|
<a href=#608 id=608 data-nosnippet>608</a> ///
|
|
<a href=#609 id=609 data-nosnippet>609</a> /// For instance if we consider range *C2:H38*:
|
|
<a href=#610 id=610 data-nosnippet>610</a> /// - `(0, 0)` absolute is "A1" and thus this function returns `None`
|
|
<a href=#611 id=611 data-nosnippet>611</a> /// - `(0, 0)` relative is "C2" and is returned by the `Index` trait (i.e `my_range[(0, 0)]`)
|
|
<a href=#612 id=612 data-nosnippet>612</a> ///
|
|
<a href=#613 id=613 data-nosnippet>613</a> /// # Examples
|
|
<a href=#614 id=614 data-nosnippet>614</a> /// ```
|
|
<a href=#615 id=615 data-nosnippet>615</a> /// use calamine::{Range, Data};
|
|
<a href=#616 id=616 data-nosnippet>616</a> ///
|
|
<a href=#617 id=617 data-nosnippet>617</a> /// let range: Range<usize> = Range::new((1, 0), (5, 2));
|
|
<a href=#618 id=618 data-nosnippet>618</a> /// assert_eq!(range.get_value((0, 0)), None);
|
|
<a href=#619 id=619 data-nosnippet>619</a> /// assert_eq!(range[(0, 0)], 0);
|
|
<a href=#620 id=620 data-nosnippet>620</a> /// ```
|
|
<a href=#621 id=621 data-nosnippet>621</a> </span><span class="kw">pub fn </span>get_value(<span class="kw-2">&</span><span class="self">self</span>, absolute_position: (u32, u32)) -> <span class="prelude-ty">Option</span><<span class="kw-2">&</span>T> {
|
|
<a href=#622 id=622 data-nosnippet>622</a> <span class="kw">let </span>p = absolute_position;
|
|
<a href=#623 id=623 data-nosnippet>623</a> <span class="kw">if </span>p.<span class="number">0 </span>>= <span class="self">self</span>.start.<span class="number">0 </span>&& p.<span class="number">0 </span><= <span class="self">self</span>.end.<span class="number">0 </span>&& p.<span class="number">1 </span>>= <span class="self">self</span>.start.<span class="number">1 </span>&& p.<span class="number">1 </span><= <span class="self">self</span>.end.<span class="number">1 </span>{
|
|
<a href=#624 id=624 data-nosnippet>624</a> <span class="kw">return </span><span class="self">self</span>.get((
|
|
<a href=#625 id=625 data-nosnippet>625</a> (absolute_position.<span class="number">0 </span>- <span class="self">self</span>.start.<span class="number">0</span>) <span class="kw">as </span>usize,
|
|
<a href=#626 id=626 data-nosnippet>626</a> (absolute_position.<span class="number">1 </span>- <span class="self">self</span>.start.<span class="number">1</span>) <span class="kw">as </span>usize,
|
|
<a href=#627 id=627 data-nosnippet>627</a> ));
|
|
<a href=#628 id=628 data-nosnippet>628</a> }
|
|
<a href=#629 id=629 data-nosnippet>629</a> <span class="prelude-val">None
|
|
<a href=#630 id=630 data-nosnippet>630</a> </span>}
|
|
<a href=#631 id=631 data-nosnippet>631</a>
|
|
<a href=#632 id=632 data-nosnippet>632</a> <span class="doccomment">/// Get cell value from **relative position**.
|
|
<a href=#633 id=633 data-nosnippet>633</a> ///
|
|
<a href=#634 id=634 data-nosnippet>634</a> /// Unlike using the Index trait, this will not panic but rather yield `None` if out of range.
|
|
<a href=#635 id=635 data-nosnippet>635</a> /// Otherwise, returns the cell value. The coordinate format is (row, column).
|
|
<a href=#636 id=636 data-nosnippet>636</a> ///
|
|
<a href=#637 id=637 data-nosnippet>637</a> </span><span class="kw">pub fn </span>get(<span class="kw-2">&</span><span class="self">self</span>, relative_position: (usize, usize)) -> <span class="prelude-ty">Option</span><<span class="kw-2">&</span>T> {
|
|
<a href=#638 id=638 data-nosnippet>638</a> <span class="kw">let </span>(row, col) = relative_position;
|
|
<a href=#639 id=639 data-nosnippet>639</a> <span class="kw">let </span>(height, width) = <span class="self">self</span>.get_size();
|
|
<a href=#640 id=640 data-nosnippet>640</a> <span class="kw">if </span>col >= width || row >= height {
|
|
<a href=#641 id=641 data-nosnippet>641</a> <span class="prelude-val">None
|
|
<a href=#642 id=642 data-nosnippet>642</a> </span>} <span class="kw">else </span>{
|
|
<a href=#643 id=643 data-nosnippet>643</a> <span class="self">self</span>.inner.get(row * width + col)
|
|
<a href=#644 id=644 data-nosnippet>644</a> }
|
|
<a href=#645 id=645 data-nosnippet>645</a> }
|
|
<a href=#646 id=646 data-nosnippet>646</a>
|
|
<a href=#647 id=647 data-nosnippet>647</a> <span class="doccomment">/// Get an iterator over inner rows
|
|
<a href=#648 id=648 data-nosnippet>648</a> ///
|
|
<a href=#649 id=649 data-nosnippet>649</a> /// # Examples
|
|
<a href=#650 id=650 data-nosnippet>650</a> /// ```
|
|
<a href=#651 id=651 data-nosnippet>651</a> /// use calamine::{Range, Data};
|
|
<a href=#652 id=652 data-nosnippet>652</a> ///
|
|
<a href=#653 id=653 data-nosnippet>653</a> /// let range: Range<Data> = Range::new((0, 0), (5, 2));
|
|
<a href=#654 id=654 data-nosnippet>654</a> /// // with rows item row: &[Data]
|
|
<a href=#655 id=655 data-nosnippet>655</a> /// assert_eq!(range.rows().map(|r| r.len()).sum::<usize>(), 18);
|
|
<a href=#656 id=656 data-nosnippet>656</a> /// ```
|
|
<a href=#657 id=657 data-nosnippet>657</a> </span><span class="kw">pub fn </span>rows(<span class="kw-2">&</span><span class="self">self</span>) -> Rows<<span class="lifetime">'_</span>, T> {
|
|
<a href=#658 id=658 data-nosnippet>658</a> <span class="kw">if </span><span class="self">self</span>.inner.is_empty() {
|
|
<a href=#659 id=659 data-nosnippet>659</a> Rows { inner: <span class="prelude-val">None </span>}
|
|
<a href=#660 id=660 data-nosnippet>660</a> } <span class="kw">else </span>{
|
|
<a href=#661 id=661 data-nosnippet>661</a> <span class="kw">let </span>width = <span class="self">self</span>.width();
|
|
<a href=#662 id=662 data-nosnippet>662</a> Rows {
|
|
<a href=#663 id=663 data-nosnippet>663</a> inner: <span class="prelude-val">Some</span>(<span class="self">self</span>.inner.chunks(width)),
|
|
<a href=#664 id=664 data-nosnippet>664</a> }
|
|
<a href=#665 id=665 data-nosnippet>665</a> }
|
|
<a href=#666 id=666 data-nosnippet>666</a> }
|
|
<a href=#667 id=667 data-nosnippet>667</a>
|
|
<a href=#668 id=668 data-nosnippet>668</a> <span class="doccomment">/// Get an iterator over used cells only
|
|
<a href=#669 id=669 data-nosnippet>669</a> </span><span class="kw">pub fn </span>used_cells(<span class="kw-2">&</span><span class="self">self</span>) -> UsedCells<<span class="lifetime">'_</span>, T> {
|
|
<a href=#670 id=670 data-nosnippet>670</a> UsedCells {
|
|
<a href=#671 id=671 data-nosnippet>671</a> width: <span class="self">self</span>.width(),
|
|
<a href=#672 id=672 data-nosnippet>672</a> inner: <span class="self">self</span>.inner.iter().enumerate(),
|
|
<a href=#673 id=673 data-nosnippet>673</a> }
|
|
<a href=#674 id=674 data-nosnippet>674</a> }
|
|
<a href=#675 id=675 data-nosnippet>675</a>
|
|
<a href=#676 id=676 data-nosnippet>676</a> <span class="doccomment">/// Get an iterator over all cells in this range
|
|
<a href=#677 id=677 data-nosnippet>677</a> </span><span class="kw">pub fn </span>cells(<span class="kw-2">&</span><span class="self">self</span>) -> Cells<<span class="lifetime">'_</span>, T> {
|
|
<a href=#678 id=678 data-nosnippet>678</a> Cells {
|
|
<a href=#679 id=679 data-nosnippet>679</a> width: <span class="self">self</span>.width(),
|
|
<a href=#680 id=680 data-nosnippet>680</a> inner: <span class="self">self</span>.inner.iter().enumerate(),
|
|
<a href=#681 id=681 data-nosnippet>681</a> }
|
|
<a href=#682 id=682 data-nosnippet>682</a> }
|
|
<a href=#683 id=683 data-nosnippet>683</a>
|
|
<a href=#684 id=684 data-nosnippet>684</a> <span class="doccomment">/// Build a `RangeDeserializer` from this configuration.
|
|
<a href=#685 id=685 data-nosnippet>685</a> ///
|
|
<a href=#686 id=686 data-nosnippet>686</a> /// # Example
|
|
<a href=#687 id=687 data-nosnippet>687</a> ///
|
|
<a href=#688 id=688 data-nosnippet>688</a> /// ```
|
|
<a href=#689 id=689 data-nosnippet>689</a> /// # use calamine::{Reader, Error, open_workbook, Xlsx, RangeDeserializerBuilder};
|
|
<a href=#690 id=690 data-nosnippet>690</a> /// fn main() -> Result<(), Error> {
|
|
<a href=#691 id=691 data-nosnippet>691</a> /// let path = format!("{}/tests/temperature.xlsx", env!("CARGO_MANIFEST_DIR"));
|
|
<a href=#692 id=692 data-nosnippet>692</a> /// let mut workbook: Xlsx<_> = open_workbook(path)?;
|
|
<a href=#693 id=693 data-nosnippet>693</a> /// let mut sheet = workbook.worksheet_range("Sheet1")?;
|
|
<a href=#694 id=694 data-nosnippet>694</a> /// let mut iter = sheet.deserialize()?;
|
|
<a href=#695 id=695 data-nosnippet>695</a> ///
|
|
<a href=#696 id=696 data-nosnippet>696</a> /// if let Some(result) = iter.next() {
|
|
<a href=#697 id=697 data-nosnippet>697</a> /// let (label, value): (String, f64) = result?;
|
|
<a href=#698 id=698 data-nosnippet>698</a> /// assert_eq!(label, "celsius");
|
|
<a href=#699 id=699 data-nosnippet>699</a> /// assert_eq!(value, 22.2222);
|
|
<a href=#700 id=700 data-nosnippet>700</a> ///
|
|
<a href=#701 id=701 data-nosnippet>701</a> /// Ok(())
|
|
<a href=#702 id=702 data-nosnippet>702</a> /// } else {
|
|
<a href=#703 id=703 data-nosnippet>703</a> /// return Err(From::from("expected at least one record but got none"));
|
|
<a href=#704 id=704 data-nosnippet>704</a> /// }
|
|
<a href=#705 id=705 data-nosnippet>705</a> /// }
|
|
<a href=#706 id=706 data-nosnippet>706</a> /// ```
|
|
<a href=#707 id=707 data-nosnippet>707</a> </span><span class="kw">pub fn </span>deserialize<<span class="lifetime">'a</span>, D>(<span class="kw-2">&</span><span class="lifetime">'a </span><span class="self">self</span>) -> <span class="prelude-ty">Result</span><RangeDeserializer<<span class="lifetime">'a</span>, T, D>, DeError>
|
|
<a href=#708 id=708 data-nosnippet>708</a> <span class="kw">where
|
|
<a href=#709 id=709 data-nosnippet>709</a> </span>T: ToCellDeserializer<<span class="lifetime">'a</span>>,
|
|
<a href=#710 id=710 data-nosnippet>710</a> D: DeserializeOwned,
|
|
<a href=#711 id=711 data-nosnippet>711</a> {
|
|
<a href=#712 id=712 data-nosnippet>712</a> RangeDeserializerBuilder::new().from_range(<span class="self">self</span>)
|
|
<a href=#713 id=713 data-nosnippet>713</a> }
|
|
<a href=#714 id=714 data-nosnippet>714</a>
|
|
<a href=#715 id=715 data-nosnippet>715</a> <span class="doccomment">/// Build a new `Range` out of this range
|
|
<a href=#716 id=716 data-nosnippet>716</a> ///
|
|
<a href=#717 id=717 data-nosnippet>717</a> /// # Remarks
|
|
<a href=#718 id=718 data-nosnippet>718</a> ///
|
|
<a href=#719 id=719 data-nosnippet>719</a> /// Cells within this range will be cloned, cells out of it will be set to Empty
|
|
<a href=#720 id=720 data-nosnippet>720</a> ///
|
|
<a href=#721 id=721 data-nosnippet>721</a> /// # Example
|
|
<a href=#722 id=722 data-nosnippet>722</a> ///
|
|
<a href=#723 id=723 data-nosnippet>723</a> /// ```
|
|
<a href=#724 id=724 data-nosnippet>724</a> /// # use calamine::{Range, Data};
|
|
<a href=#725 id=725 data-nosnippet>725</a> /// let mut a = Range::new((1, 1), (3, 3));
|
|
<a href=#726 id=726 data-nosnippet>726</a> /// a.set_value((1, 1), Data::Bool(true));
|
|
<a href=#727 id=727 data-nosnippet>727</a> /// a.set_value((2, 2), Data::Bool(true));
|
|
<a href=#728 id=728 data-nosnippet>728</a> ///
|
|
<a href=#729 id=729 data-nosnippet>729</a> /// let b = a.range((2, 2), (5, 5));
|
|
<a href=#730 id=730 data-nosnippet>730</a> /// assert_eq!(b.get_value((2, 2)), Some(&Data::Bool(true)));
|
|
<a href=#731 id=731 data-nosnippet>731</a> /// assert_eq!(b.get_value((3, 3)), Some(&Data::Empty));
|
|
<a href=#732 id=732 data-nosnippet>732</a> ///
|
|
<a href=#733 id=733 data-nosnippet>733</a> /// let c = a.range((0, 0), (2, 2));
|
|
<a href=#734 id=734 data-nosnippet>734</a> /// assert_eq!(c.get_value((0, 0)), Some(&Data::Empty));
|
|
<a href=#735 id=735 data-nosnippet>735</a> /// assert_eq!(c.get_value((1, 1)), Some(&Data::Bool(true)));
|
|
<a href=#736 id=736 data-nosnippet>736</a> /// assert_eq!(c.get_value((2, 2)), Some(&Data::Bool(true)));
|
|
<a href=#737 id=737 data-nosnippet>737</a> /// ```
|
|
<a href=#738 id=738 data-nosnippet>738</a> </span><span class="kw">pub fn </span>range(<span class="kw-2">&</span><span class="self">self</span>, start: (u32, u32), end: (u32, u32)) -> Range<T> {
|
|
<a href=#739 id=739 data-nosnippet>739</a> <span class="kw">let </span><span class="kw-2">mut </span>other = Range::new(start, end);
|
|
<a href=#740 id=740 data-nosnippet>740</a> <span class="kw">let </span>(self_start_row, self_start_col) = <span class="self">self</span>.start;
|
|
<a href=#741 id=741 data-nosnippet>741</a> <span class="kw">let </span>(self_end_row, self_end_col) = <span class="self">self</span>.end;
|
|
<a href=#742 id=742 data-nosnippet>742</a> <span class="kw">let </span>(other_start_row, other_start_col) = other.start;
|
|
<a href=#743 id=743 data-nosnippet>743</a> <span class="kw">let </span>(other_end_row, other_end_col) = other.end;
|
|
<a href=#744 id=744 data-nosnippet>744</a>
|
|
<a href=#745 id=745 data-nosnippet>745</a> <span class="comment">// copy data from self to other
|
|
<a href=#746 id=746 data-nosnippet>746</a> </span><span class="kw">let </span>start_row = max(self_start_row, other_start_row);
|
|
<a href=#747 id=747 data-nosnippet>747</a> <span class="kw">let </span>end_row = min(self_end_row, other_end_row);
|
|
<a href=#748 id=748 data-nosnippet>748</a> <span class="kw">let </span>start_col = max(self_start_col, other_start_col);
|
|
<a href=#749 id=749 data-nosnippet>749</a> <span class="kw">let </span>end_col = min(self_end_col, other_end_col);
|
|
<a href=#750 id=750 data-nosnippet>750</a>
|
|
<a href=#751 id=751 data-nosnippet>751</a> <span class="kw">if </span>start_row > end_row || start_col > end_col {
|
|
<a href=#752 id=752 data-nosnippet>752</a> <span class="kw">return </span>other;
|
|
<a href=#753 id=753 data-nosnippet>753</a> }
|
|
<a href=#754 id=754 data-nosnippet>754</a>
|
|
<a href=#755 id=755 data-nosnippet>755</a> <span class="kw">let </span>self_width = <span class="self">self</span>.width();
|
|
<a href=#756 id=756 data-nosnippet>756</a> <span class="kw">let </span>other_width = other.width();
|
|
<a href=#757 id=757 data-nosnippet>757</a>
|
|
<a href=#758 id=758 data-nosnippet>758</a> <span class="comment">// change referential
|
|
<a href=#759 id=759 data-nosnippet>759</a> //
|
|
<a href=#760 id=760 data-nosnippet>760</a> // we want to copy range: start_row..(end_row + 1)
|
|
<a href=#761 id=761 data-nosnippet>761</a> // In self referential it is (start_row - self_start_row)..(end_row + 1 - self_start_row)
|
|
<a href=#762 id=762 data-nosnippet>762</a> </span><span class="kw">let </span>self_row_start = (start_row - self_start_row) <span class="kw">as </span>usize;
|
|
<a href=#763 id=763 data-nosnippet>763</a> <span class="kw">let </span>self_row_end = (end_row + <span class="number">1 </span>- self_start_row) <span class="kw">as </span>usize;
|
|
<a href=#764 id=764 data-nosnippet>764</a> <span class="kw">let </span>self_col_start = (start_col - self_start_col) <span class="kw">as </span>usize;
|
|
<a href=#765 id=765 data-nosnippet>765</a> <span class="kw">let </span>self_col_end = (end_col + <span class="number">1 </span>- self_start_col) <span class="kw">as </span>usize;
|
|
<a href=#766 id=766 data-nosnippet>766</a>
|
|
<a href=#767 id=767 data-nosnippet>767</a> <span class="kw">let </span>other_row_start = (start_row - other_start_row) <span class="kw">as </span>usize;
|
|
<a href=#768 id=768 data-nosnippet>768</a> <span class="kw">let </span>other_row_end = (end_row + <span class="number">1 </span>- other_start_row) <span class="kw">as </span>usize;
|
|
<a href=#769 id=769 data-nosnippet>769</a> <span class="kw">let </span>other_col_start = (start_col - other_start_col) <span class="kw">as </span>usize;
|
|
<a href=#770 id=770 data-nosnippet>770</a> <span class="kw">let </span>other_col_end = (end_col + <span class="number">1 </span>- other_start_col) <span class="kw">as </span>usize;
|
|
<a href=#771 id=771 data-nosnippet>771</a>
|
|
<a href=#772 id=772 data-nosnippet>772</a> {
|
|
<a href=#773 id=773 data-nosnippet>773</a> <span class="kw">let </span>self_rows = <span class="self">self
|
|
<a href=#774 id=774 data-nosnippet>774</a> </span>.inner
|
|
<a href=#775 id=775 data-nosnippet>775</a> .chunks(self_width)
|
|
<a href=#776 id=776 data-nosnippet>776</a> .take(self_row_end)
|
|
<a href=#777 id=777 data-nosnippet>777</a> .skip(self_row_start);
|
|
<a href=#778 id=778 data-nosnippet>778</a>
|
|
<a href=#779 id=779 data-nosnippet>779</a> <span class="kw">let </span>other_rows = other
|
|
<a href=#780 id=780 data-nosnippet>780</a> .inner
|
|
<a href=#781 id=781 data-nosnippet>781</a> .chunks_mut(other_width)
|
|
<a href=#782 id=782 data-nosnippet>782</a> .take(other_row_end)
|
|
<a href=#783 id=783 data-nosnippet>783</a> .skip(other_row_start);
|
|
<a href=#784 id=784 data-nosnippet>784</a>
|
|
<a href=#785 id=785 data-nosnippet>785</a> <span class="kw">for </span>(self_row, other_row) <span class="kw">in </span>self_rows.zip(other_rows) {
|
|
<a href=#786 id=786 data-nosnippet>786</a> <span class="kw">let </span>self_cols = <span class="kw-2">&</span>self_row[self_col_start..self_col_end];
|
|
<a href=#787 id=787 data-nosnippet>787</a> <span class="kw">let </span>other_cols = <span class="kw-2">&mut </span>other_row[other_col_start..other_col_end];
|
|
<a href=#788 id=788 data-nosnippet>788</a> other_cols.clone_from_slice(self_cols);
|
|
<a href=#789 id=789 data-nosnippet>789</a> }
|
|
<a href=#790 id=790 data-nosnippet>790</a> }
|
|
<a href=#791 id=791 data-nosnippet>791</a>
|
|
<a href=#792 id=792 data-nosnippet>792</a> other
|
|
<a href=#793 id=793 data-nosnippet>793</a> }
|
|
<a href=#794 id=794 data-nosnippet>794</a>}
|
|
<a href=#795 id=795 data-nosnippet>795</a>
|
|
<a href=#796 id=796 data-nosnippet>796</a><span class="kw">impl</span><T: CellType + fmt::Display> Range<T> {
|
|
<a href=#797 id=797 data-nosnippet>797</a> <span class="doccomment">/// Get range headers.
|
|
<a href=#798 id=798 data-nosnippet>798</a> ///
|
|
<a href=#799 id=799 data-nosnippet>799</a> /// # Examples
|
|
<a href=#800 id=800 data-nosnippet>800</a> /// ```
|
|
<a href=#801 id=801 data-nosnippet>801</a> /// use calamine::{Range, Data};
|
|
<a href=#802 id=802 data-nosnippet>802</a> ///
|
|
<a href=#803 id=803 data-nosnippet>803</a> /// let mut range = Range::new((0, 0), (5, 2));
|
|
<a href=#804 id=804 data-nosnippet>804</a> /// range.set_value((0, 0), Data::String(String::from("a")));
|
|
<a href=#805 id=805 data-nosnippet>805</a> /// range.set_value((0, 1), Data::Int(1));
|
|
<a href=#806 id=806 data-nosnippet>806</a> /// range.set_value((0, 2), Data::Bool(true));
|
|
<a href=#807 id=807 data-nosnippet>807</a> /// let headers = range.headers();
|
|
<a href=#808 id=808 data-nosnippet>808</a> /// assert_eq!(
|
|
<a href=#809 id=809 data-nosnippet>809</a> /// headers,
|
|
<a href=#810 id=810 data-nosnippet>810</a> /// Some(vec![
|
|
<a href=#811 id=811 data-nosnippet>811</a> /// String::from("a"),
|
|
<a href=#812 id=812 data-nosnippet>812</a> /// String::from("1"),
|
|
<a href=#813 id=813 data-nosnippet>813</a> /// String::from("true")
|
|
<a href=#814 id=814 data-nosnippet>814</a> /// ])
|
|
<a href=#815 id=815 data-nosnippet>815</a> /// );
|
|
<a href=#816 id=816 data-nosnippet>816</a> /// ```
|
|
<a href=#817 id=817 data-nosnippet>817</a> </span><span class="kw">pub fn </span>headers(<span class="kw-2">&</span><span class="self">self</span>) -> <span class="prelude-ty">Option</span><Vec<String>> {
|
|
<a href=#818 id=818 data-nosnippet>818</a> <span class="self">self</span>.rows()
|
|
<a href=#819 id=819 data-nosnippet>819</a> .next()
|
|
<a href=#820 id=820 data-nosnippet>820</a> .map(|row| row.iter().map(ToString::to_string).collect())
|
|
<a href=#821 id=821 data-nosnippet>821</a> }
|
|
<a href=#822 id=822 data-nosnippet>822</a>}
|
|
<a href=#823 id=823 data-nosnippet>823</a>
|
|
<a href=#824 id=824 data-nosnippet>824</a><span class="kw">impl</span><T: CellType> Index<usize> <span class="kw">for </span>Range<T> {
|
|
<a href=#825 id=825 data-nosnippet>825</a> <span class="kw">type </span>Output = [T];
|
|
<a href=#826 id=826 data-nosnippet>826</a> <span class="kw">fn </span>index(<span class="kw-2">&</span><span class="self">self</span>, index: usize) -> <span class="kw-2">&</span>[T] {
|
|
<a href=#827 id=827 data-nosnippet>827</a> <span class="kw">let </span>width = <span class="self">self</span>.width();
|
|
<a href=#828 id=828 data-nosnippet>828</a> <span class="kw-2">&</span><span class="self">self</span>.inner[index * width..(index + <span class="number">1</span>) * width]
|
|
<a href=#829 id=829 data-nosnippet>829</a> }
|
|
<a href=#830 id=830 data-nosnippet>830</a>}
|
|
<a href=#831 id=831 data-nosnippet>831</a>
|
|
<a href=#832 id=832 data-nosnippet>832</a><span class="kw">impl</span><T: CellType> Index<(usize, usize)> <span class="kw">for </span>Range<T> {
|
|
<a href=#833 id=833 data-nosnippet>833</a> <span class="kw">type </span>Output = T;
|
|
<a href=#834 id=834 data-nosnippet>834</a> <span class="kw">fn </span>index(<span class="kw-2">&</span><span class="self">self</span>, index: (usize, usize)) -> <span class="kw-2">&</span>T {
|
|
<a href=#835 id=835 data-nosnippet>835</a> <span class="kw">let </span>(height, width) = <span class="self">self</span>.get_size();
|
|
<a href=#836 id=836 data-nosnippet>836</a> <span class="macro">assert!</span>(index.<span class="number">1 </span>< width && index.<span class="number">0 </span>< height, <span class="string">"index out of bounds"</span>);
|
|
<a href=#837 id=837 data-nosnippet>837</a> <span class="kw-2">&</span><span class="self">self</span>.inner[index.<span class="number">0 </span>* width + index.<span class="number">1</span>]
|
|
<a href=#838 id=838 data-nosnippet>838</a> }
|
|
<a href=#839 id=839 data-nosnippet>839</a>}
|
|
<a href=#840 id=840 data-nosnippet>840</a>
|
|
<a href=#841 id=841 data-nosnippet>841</a><span class="kw">impl</span><T: CellType> IndexMut<usize> <span class="kw">for </span>Range<T> {
|
|
<a href=#842 id=842 data-nosnippet>842</a> <span class="kw">fn </span>index_mut(<span class="kw-2">&mut </span><span class="self">self</span>, index: usize) -> <span class="kw-2">&mut </span>[T] {
|
|
<a href=#843 id=843 data-nosnippet>843</a> <span class="kw">let </span>width = <span class="self">self</span>.width();
|
|
<a href=#844 id=844 data-nosnippet>844</a> <span class="kw-2">&mut </span><span class="self">self</span>.inner[index * width..(index + <span class="number">1</span>) * width]
|
|
<a href=#845 id=845 data-nosnippet>845</a> }
|
|
<a href=#846 id=846 data-nosnippet>846</a>}
|
|
<a href=#847 id=847 data-nosnippet>847</a>
|
|
<a href=#848 id=848 data-nosnippet>848</a><span class="kw">impl</span><T: CellType> IndexMut<(usize, usize)> <span class="kw">for </span>Range<T> {
|
|
<a href=#849 id=849 data-nosnippet>849</a> <span class="kw">fn </span>index_mut(<span class="kw-2">&mut </span><span class="self">self</span>, index: (usize, usize)) -> <span class="kw-2">&mut </span>T {
|
|
<a href=#850 id=850 data-nosnippet>850</a> <span class="kw">let </span>(height, width) = <span class="self">self</span>.get_size();
|
|
<a href=#851 id=851 data-nosnippet>851</a> <span class="macro">assert!</span>(index.<span class="number">1 </span>< width && index.<span class="number">0 </span>< height, <span class="string">"index out of bounds"</span>);
|
|
<a href=#852 id=852 data-nosnippet>852</a> <span class="kw-2">&mut </span><span class="self">self</span>.inner[index.<span class="number">0 </span>* width + index.<span class="number">1</span>]
|
|
<a href=#853 id=853 data-nosnippet>853</a> }
|
|
<a href=#854 id=854 data-nosnippet>854</a>}
|
|
<a href=#855 id=855 data-nosnippet>855</a>
|
|
<a href=#856 id=856 data-nosnippet>856</a><span class="doccomment">/// A struct to iterate over all cells
|
|
<a href=#857 id=857 data-nosnippet>857</a></span><span class="attr">#[derive(Clone, Debug)]
|
|
<a href=#858 id=858 data-nosnippet>858</a></span><span class="kw">pub struct </span>Cells<<span class="lifetime">'a</span>, T: CellType> {
|
|
<a href=#859 id=859 data-nosnippet>859</a> width: usize,
|
|
<a href=#860 id=860 data-nosnippet>860</a> inner: std::iter::Enumerate<std::slice::Iter<<span class="lifetime">'a</span>, T>>,
|
|
<a href=#861 id=861 data-nosnippet>861</a>}
|
|
<a href=#862 id=862 data-nosnippet>862</a>
|
|
<a href=#863 id=863 data-nosnippet>863</a><span class="kw">impl</span><<span class="lifetime">'a</span>, T: <span class="lifetime">'a </span>+ CellType> Iterator <span class="kw">for </span>Cells<<span class="lifetime">'a</span>, T> {
|
|
<a href=#864 id=864 data-nosnippet>864</a> <span class="kw">type </span>Item = (usize, usize, <span class="kw-2">&</span><span class="lifetime">'a </span>T);
|
|
<a href=#865 id=865 data-nosnippet>865</a> <span class="kw">fn </span>next(<span class="kw-2">&mut </span><span class="self">self</span>) -> <span class="prelude-ty">Option</span><<span class="self">Self</span>::Item> {
|
|
<a href=#866 id=866 data-nosnippet>866</a> <span class="self">self</span>.inner.next().map(|(i, v)| {
|
|
<a href=#867 id=867 data-nosnippet>867</a> <span class="kw">let </span>row = i / <span class="self">self</span>.width;
|
|
<a href=#868 id=868 data-nosnippet>868</a> <span class="kw">let </span>col = i % <span class="self">self</span>.width;
|
|
<a href=#869 id=869 data-nosnippet>869</a> (row, col, v)
|
|
<a href=#870 id=870 data-nosnippet>870</a> })
|
|
<a href=#871 id=871 data-nosnippet>871</a> }
|
|
<a href=#872 id=872 data-nosnippet>872</a> <span class="kw">fn </span>size_hint(<span class="kw-2">&</span><span class="self">self</span>) -> (usize, <span class="prelude-ty">Option</span><usize>) {
|
|
<a href=#873 id=873 data-nosnippet>873</a> <span class="self">self</span>.inner.size_hint()
|
|
<a href=#874 id=874 data-nosnippet>874</a> }
|
|
<a href=#875 id=875 data-nosnippet>875</a>}
|
|
<a href=#876 id=876 data-nosnippet>876</a>
|
|
<a href=#877 id=877 data-nosnippet>877</a><span class="kw">impl</span><<span class="lifetime">'a</span>, T: <span class="lifetime">'a </span>+ CellType> DoubleEndedIterator <span class="kw">for </span>Cells<<span class="lifetime">'a</span>, T> {
|
|
<a href=#878 id=878 data-nosnippet>878</a> <span class="kw">fn </span>next_back(<span class="kw-2">&mut </span><span class="self">self</span>) -> <span class="prelude-ty">Option</span><<span class="self">Self</span>::Item> {
|
|
<a href=#879 id=879 data-nosnippet>879</a> <span class="self">self</span>.inner.next_back().map(|(i, v)| {
|
|
<a href=#880 id=880 data-nosnippet>880</a> <span class="kw">let </span>row = i / <span class="self">self</span>.width;
|
|
<a href=#881 id=881 data-nosnippet>881</a> <span class="kw">let </span>col = i % <span class="self">self</span>.width;
|
|
<a href=#882 id=882 data-nosnippet>882</a> (row, col, v)
|
|
<a href=#883 id=883 data-nosnippet>883</a> })
|
|
<a href=#884 id=884 data-nosnippet>884</a> }
|
|
<a href=#885 id=885 data-nosnippet>885</a>}
|
|
<a href=#886 id=886 data-nosnippet>886</a>
|
|
<a href=#887 id=887 data-nosnippet>887</a><span class="kw">impl</span><<span class="lifetime">'a</span>, T: <span class="lifetime">'a </span>+ CellType> ExactSizeIterator <span class="kw">for </span>Cells<<span class="lifetime">'a</span>, T> {}
|
|
<a href=#888 id=888 data-nosnippet>888</a>
|
|
<a href=#889 id=889 data-nosnippet>889</a><span class="doccomment">/// A struct to iterate over used cells
|
|
<a href=#890 id=890 data-nosnippet>890</a></span><span class="attr">#[derive(Clone, Debug)]
|
|
<a href=#891 id=891 data-nosnippet>891</a></span><span class="kw">pub struct </span>UsedCells<<span class="lifetime">'a</span>, T: CellType> {
|
|
<a href=#892 id=892 data-nosnippet>892</a> width: usize,
|
|
<a href=#893 id=893 data-nosnippet>893</a> inner: std::iter::Enumerate<std::slice::Iter<<span class="lifetime">'a</span>, T>>,
|
|
<a href=#894 id=894 data-nosnippet>894</a>}
|
|
<a href=#895 id=895 data-nosnippet>895</a>
|
|
<a href=#896 id=896 data-nosnippet>896</a><span class="kw">impl</span><<span class="lifetime">'a</span>, T: <span class="lifetime">'a </span>+ CellType> Iterator <span class="kw">for </span>UsedCells<<span class="lifetime">'a</span>, T> {
|
|
<a href=#897 id=897 data-nosnippet>897</a> <span class="kw">type </span>Item = (usize, usize, <span class="kw-2">&</span><span class="lifetime">'a </span>T);
|
|
<a href=#898 id=898 data-nosnippet>898</a> <span class="kw">fn </span>next(<span class="kw-2">&mut </span><span class="self">self</span>) -> <span class="prelude-ty">Option</span><<span class="self">Self</span>::Item> {
|
|
<a href=#899 id=899 data-nosnippet>899</a> <span class="self">self</span>.inner
|
|
<a href=#900 id=900 data-nosnippet>900</a> .by_ref()
|
|
<a href=#901 id=901 data-nosnippet>901</a> .find(|<span class="kw-2">&</span>(<span class="kw">_</span>, v)| <span class="macro">v !</span>= <span class="kw-2">&</span>T::default())
|
|
<a href=#902 id=902 data-nosnippet>902</a> .map(|(i, v)| {
|
|
<a href=#903 id=903 data-nosnippet>903</a> <span class="kw">let </span>row = i / <span class="self">self</span>.width;
|
|
<a href=#904 id=904 data-nosnippet>904</a> <span class="kw">let </span>col = i % <span class="self">self</span>.width;
|
|
<a href=#905 id=905 data-nosnippet>905</a> (row, col, v)
|
|
<a href=#906 id=906 data-nosnippet>906</a> })
|
|
<a href=#907 id=907 data-nosnippet>907</a> }
|
|
<a href=#908 id=908 data-nosnippet>908</a> <span class="kw">fn </span>size_hint(<span class="kw-2">&</span><span class="self">self</span>) -> (usize, <span class="prelude-ty">Option</span><usize>) {
|
|
<a href=#909 id=909 data-nosnippet>909</a> <span class="kw">let </span>(<span class="kw">_</span>, up) = <span class="self">self</span>.inner.size_hint();
|
|
<a href=#910 id=910 data-nosnippet>910</a> (<span class="number">0</span>, up)
|
|
<a href=#911 id=911 data-nosnippet>911</a> }
|
|
<a href=#912 id=912 data-nosnippet>912</a>}
|
|
<a href=#913 id=913 data-nosnippet>913</a>
|
|
<a href=#914 id=914 data-nosnippet>914</a><span class="kw">impl</span><<span class="lifetime">'a</span>, T: <span class="lifetime">'a </span>+ CellType> DoubleEndedIterator <span class="kw">for </span>UsedCells<<span class="lifetime">'a</span>, T> {
|
|
<a href=#915 id=915 data-nosnippet>915</a> <span class="kw">fn </span>next_back(<span class="kw-2">&mut </span><span class="self">self</span>) -> <span class="prelude-ty">Option</span><<span class="self">Self</span>::Item> {
|
|
<a href=#916 id=916 data-nosnippet>916</a> <span class="self">self</span>.inner
|
|
<a href=#917 id=917 data-nosnippet>917</a> .by_ref()
|
|
<a href=#918 id=918 data-nosnippet>918</a> .rfind(|<span class="kw-2">&</span>(<span class="kw">_</span>, v)| <span class="macro">v !</span>= <span class="kw-2">&</span>T::default())
|
|
<a href=#919 id=919 data-nosnippet>919</a> .map(|(i, v)| {
|
|
<a href=#920 id=920 data-nosnippet>920</a> <span class="kw">let </span>row = i / <span class="self">self</span>.width;
|
|
<a href=#921 id=921 data-nosnippet>921</a> <span class="kw">let </span>col = i % <span class="self">self</span>.width;
|
|
<a href=#922 id=922 data-nosnippet>922</a> (row, col, v)
|
|
<a href=#923 id=923 data-nosnippet>923</a> })
|
|
<a href=#924 id=924 data-nosnippet>924</a> }
|
|
<a href=#925 id=925 data-nosnippet>925</a>}
|
|
<a href=#926 id=926 data-nosnippet>926</a>
|
|
<a href=#927 id=927 data-nosnippet>927</a><span class="doccomment">/// An iterator to read `Range` struct row by row
|
|
<a href=#928 id=928 data-nosnippet>928</a></span><span class="attr">#[derive(Clone, Debug)]
|
|
<a href=#929 id=929 data-nosnippet>929</a></span><span class="kw">pub struct </span>Rows<<span class="lifetime">'a</span>, T: CellType> {
|
|
<a href=#930 id=930 data-nosnippet>930</a> inner: <span class="prelude-ty">Option</span><std::slice::Chunks<<span class="lifetime">'a</span>, T>>,
|
|
<a href=#931 id=931 data-nosnippet>931</a>}
|
|
<a href=#932 id=932 data-nosnippet>932</a>
|
|
<a href=#933 id=933 data-nosnippet>933</a><span class="kw">impl</span><<span class="lifetime">'a</span>, T: <span class="lifetime">'a </span>+ CellType> Iterator <span class="kw">for </span>Rows<<span class="lifetime">'a</span>, T> {
|
|
<a href=#934 id=934 data-nosnippet>934</a> <span class="kw">type </span>Item = <span class="kw-2">&</span><span class="lifetime">'a </span>[T];
|
|
<a href=#935 id=935 data-nosnippet>935</a> <span class="kw">fn </span>next(<span class="kw-2">&mut </span><span class="self">self</span>) -> <span class="prelude-ty">Option</span><<span class="self">Self</span>::Item> {
|
|
<a href=#936 id=936 data-nosnippet>936</a> <span class="self">self</span>.inner.as_mut().and_then(std::iter::Iterator::next)
|
|
<a href=#937 id=937 data-nosnippet>937</a> }
|
|
<a href=#938 id=938 data-nosnippet>938</a> <span class="kw">fn </span>size_hint(<span class="kw-2">&</span><span class="self">self</span>) -> (usize, <span class="prelude-ty">Option</span><usize>) {
|
|
<a href=#939 id=939 data-nosnippet>939</a> <span class="self">self</span>.inner
|
|
<a href=#940 id=940 data-nosnippet>940</a> .as_ref()
|
|
<a href=#941 id=941 data-nosnippet>941</a> .map_or((<span class="number">0</span>, <span class="prelude-val">Some</span>(<span class="number">0</span>)), std::iter::Iterator::size_hint)
|
|
<a href=#942 id=942 data-nosnippet>942</a> }
|
|
<a href=#943 id=943 data-nosnippet>943</a>}
|
|
<a href=#944 id=944 data-nosnippet>944</a>
|
|
<a href=#945 id=945 data-nosnippet>945</a><span class="kw">impl</span><<span class="lifetime">'a</span>, T: <span class="lifetime">'a </span>+ CellType> DoubleEndedIterator <span class="kw">for </span>Rows<<span class="lifetime">'a</span>, T> {
|
|
<a href=#946 id=946 data-nosnippet>946</a> <span class="kw">fn </span>next_back(<span class="kw-2">&mut </span><span class="self">self</span>) -> <span class="prelude-ty">Option</span><<span class="self">Self</span>::Item> {
|
|
<a href=#947 id=947 data-nosnippet>947</a> <span class="self">self</span>.inner
|
|
<a href=#948 id=948 data-nosnippet>948</a> .as_mut()
|
|
<a href=#949 id=949 data-nosnippet>949</a> .and_then(std::iter::DoubleEndedIterator::next_back)
|
|
<a href=#950 id=950 data-nosnippet>950</a> }
|
|
<a href=#951 id=951 data-nosnippet>951</a>}
|
|
<a href=#952 id=952 data-nosnippet>952</a>
|
|
<a href=#953 id=953 data-nosnippet>953</a><span class="kw">impl</span><<span class="lifetime">'a</span>, T: <span class="lifetime">'a </span>+ CellType> ExactSizeIterator <span class="kw">for </span>Rows<<span class="lifetime">'a</span>, T> {}
|
|
<a href=#954 id=954 data-nosnippet>954</a>
|
|
<a href=#955 id=955 data-nosnippet>955</a><span class="doccomment">/// Struct with the key elements of a table
|
|
<a href=#956 id=956 data-nosnippet>956</a></span><span class="kw">pub struct </span>Table<T> {
|
|
<a href=#957 id=957 data-nosnippet>957</a> <span class="kw">pub</span>(<span class="kw">crate</span>) name: String,
|
|
<a href=#958 id=958 data-nosnippet>958</a> <span class="kw">pub</span>(<span class="kw">crate</span>) sheet_name: String,
|
|
<a href=#959 id=959 data-nosnippet>959</a> <span class="kw">pub</span>(<span class="kw">crate</span>) columns: Vec<String>,
|
|
<a href=#960 id=960 data-nosnippet>960</a> <span class="kw">pub</span>(<span class="kw">crate</span>) data: Range<T>,
|
|
<a href=#961 id=961 data-nosnippet>961</a>}
|
|
<a href=#962 id=962 data-nosnippet>962</a><span class="kw">impl</span><T> Table<T> {
|
|
<a href=#963 id=963 data-nosnippet>963</a> <span class="doccomment">/// Get the name of the table
|
|
<a href=#964 id=964 data-nosnippet>964</a> </span><span class="kw">pub fn </span>name(<span class="kw-2">&</span><span class="self">self</span>) -> <span class="kw-2">&</span>str {
|
|
<a href=#965 id=965 data-nosnippet>965</a> <span class="kw-2">&</span><span class="self">self</span>.name
|
|
<a href=#966 id=966 data-nosnippet>966</a> }
|
|
<a href=#967 id=967 data-nosnippet>967</a> <span class="doccomment">/// Get the name of the sheet that table exists within
|
|
<a href=#968 id=968 data-nosnippet>968</a> </span><span class="kw">pub fn </span>sheet_name(<span class="kw-2">&</span><span class="self">self</span>) -> <span class="kw-2">&</span>str {
|
|
<a href=#969 id=969 data-nosnippet>969</a> <span class="kw-2">&</span><span class="self">self</span>.sheet_name
|
|
<a href=#970 id=970 data-nosnippet>970</a> }
|
|
<a href=#971 id=971 data-nosnippet>971</a> <span class="doccomment">/// Get the names of the columns in the order they occur
|
|
<a href=#972 id=972 data-nosnippet>972</a> </span><span class="kw">pub fn </span>columns(<span class="kw-2">&</span><span class="self">self</span>) -> <span class="kw-2">&</span>[String] {
|
|
<a href=#973 id=973 data-nosnippet>973</a> <span class="kw-2">&</span><span class="self">self</span>.columns
|
|
<a href=#974 id=974 data-nosnippet>974</a> }
|
|
<a href=#975 id=975 data-nosnippet>975</a> <span class="doccomment">/// Get a range representing the data from the table (excludes column headers)
|
|
<a href=#976 id=976 data-nosnippet>976</a> </span><span class="kw">pub fn </span>data(<span class="kw-2">&</span><span class="self">self</span>) -> <span class="kw-2">&</span>Range<T> {
|
|
<a href=#977 id=977 data-nosnippet>977</a> <span class="kw-2">&</span><span class="self">self</span>.data
|
|
<a href=#978 id=978 data-nosnippet>978</a> }
|
|
<a href=#979 id=979 data-nosnippet>979</a>}
|
|
<a href=#980 id=980 data-nosnippet>980</a>
|
|
<a href=#981 id=981 data-nosnippet>981</a><span class="kw">impl</span><T: CellType> From<Table<T>> <span class="kw">for </span>Range<T> {
|
|
<a href=#982 id=982 data-nosnippet>982</a> <span class="kw">fn </span>from(table: Table<T>) -> Range<T> {
|
|
<a href=#983 id=983 data-nosnippet>983</a> table.data
|
|
<a href=#984 id=984 data-nosnippet>984</a> }
|
|
<a href=#985 id=985 data-nosnippet>985</a>}
|
|
<a href=#986 id=986 data-nosnippet>986</a>
|
|
<a href=#987 id=987 data-nosnippet>987</a><span class="doccomment">/// A helper function to deserialize cell values as `i64`,
|
|
<a href=#988 id=988 data-nosnippet>988</a>/// useful when cells may also contain invalid values (i.e. strings).
|
|
<a href=#989 id=989 data-nosnippet>989</a>/// It applies the [`as_i64`] method to the cell value, and returns
|
|
<a href=#990 id=990 data-nosnippet>990</a>/// `Ok(Some(value_as_i64))` if successful or `Ok(None)` if unsuccessful,
|
|
<a href=#991 id=991 data-nosnippet>991</a>/// therefore never failing. This function is intended to be used with Serde's
|
|
<a href=#992 id=992 data-nosnippet>992</a>/// [`deserialize_with`](https://serde.rs/field-attrs.html) field attribute.
|
|
<a href=#993 id=993 data-nosnippet>993</a></span><span class="kw">pub fn </span>deserialize_as_i64_or_none<<span class="lifetime">'de</span>, D>(deserializer: D) -> <span class="prelude-ty">Result</span><<span class="prelude-ty">Option</span><i64>, D::Error>
|
|
<a href=#994 id=994 data-nosnippet>994</a><span class="kw">where
|
|
<a href=#995 id=995 data-nosnippet>995</a> </span>D: Deserializer<<span class="lifetime">'de</span>>,
|
|
<a href=#996 id=996 data-nosnippet>996</a>{
|
|
<a href=#997 id=997 data-nosnippet>997</a> <span class="kw">let </span>data = Data::deserialize(deserializer)<span class="question-mark">?</span>;
|
|
<a href=#998 id=998 data-nosnippet>998</a> <span class="prelude-val">Ok</span>(data.as_i64())
|
|
<a href=#999 id=999 data-nosnippet>999</a>}
|
|
<a href=#1000 id=1000 data-nosnippet>1000</a>
|
|
<a href=#1001 id=1001 data-nosnippet>1001</a><span class="doccomment">/// A helper function to deserialize cell values as `i64`,
|
|
<a href=#1002 id=1002 data-nosnippet>1002</a>/// useful when cells may also contain invalid values (i.e. strings).
|
|
<a href=#1003 id=1003 data-nosnippet>1003</a>/// It applies the [`as_i64`] method to the cell value, and returns
|
|
<a href=#1004 id=1004 data-nosnippet>1004</a>/// `Ok(Ok(value_as_i64))` if successful or `Ok(Err(value_to_string))` if unsuccessful,
|
|
<a href=#1005 id=1005 data-nosnippet>1005</a>/// therefore never failing. This function is intended to be used with Serde's
|
|
<a href=#1006 id=1006 data-nosnippet>1006</a>/// [`deserialize_with`](https://serde.rs/field-attrs.html) field attribute.
|
|
<a href=#1007 id=1007 data-nosnippet>1007</a></span><span class="kw">pub fn </span>deserialize_as_i64_or_string<<span class="lifetime">'de</span>, D>(
|
|
<a href=#1008 id=1008 data-nosnippet>1008</a> deserializer: D,
|
|
<a href=#1009 id=1009 data-nosnippet>1009</a>) -> <span class="prelude-ty">Result</span><<span class="prelude-ty">Result</span><i64, String>, D::Error>
|
|
<a href=#1010 id=1010 data-nosnippet>1010</a><span class="kw">where
|
|
<a href=#1011 id=1011 data-nosnippet>1011</a> </span>D: Deserializer<<span class="lifetime">'de</span>>,
|
|
<a href=#1012 id=1012 data-nosnippet>1012</a>{
|
|
<a href=#1013 id=1013 data-nosnippet>1013</a> <span class="kw">let </span>data = Data::deserialize(deserializer)<span class="question-mark">?</span>;
|
|
<a href=#1014 id=1014 data-nosnippet>1014</a> <span class="prelude-val">Ok</span>(data.as_i64().ok_or_else(|| data.to_string()))
|
|
<a href=#1015 id=1015 data-nosnippet>1015</a>}
|
|
<a href=#1016 id=1016 data-nosnippet>1016</a>
|
|
<a href=#1017 id=1017 data-nosnippet>1017</a><span class="doccomment">/// A helper function to deserialize cell values as `f64`,
|
|
<a href=#1018 id=1018 data-nosnippet>1018</a>/// useful when cells may also contain invalid values (i.e. strings).
|
|
<a href=#1019 id=1019 data-nosnippet>1019</a>/// It applies the [`as_f64`] method to the cell value, and returns
|
|
<a href=#1020 id=1020 data-nosnippet>1020</a>/// `Ok(Some(value_as_f64))` if successful or `Ok(None)` if unsuccessful,
|
|
<a href=#1021 id=1021 data-nosnippet>1021</a>/// therefore never failing. This function is intended to be used with Serde's
|
|
<a href=#1022 id=1022 data-nosnippet>1022</a>/// [`deserialize_with`](https://serde.rs/field-attrs.html) field attribute.
|
|
<a href=#1023 id=1023 data-nosnippet>1023</a></span><span class="kw">pub fn </span>deserialize_as_f64_or_none<<span class="lifetime">'de</span>, D>(deserializer: D) -> <span class="prelude-ty">Result</span><<span class="prelude-ty">Option</span><f64>, D::Error>
|
|
<a href=#1024 id=1024 data-nosnippet>1024</a><span class="kw">where
|
|
<a href=#1025 id=1025 data-nosnippet>1025</a> </span>D: Deserializer<<span class="lifetime">'de</span>>,
|
|
<a href=#1026 id=1026 data-nosnippet>1026</a>{
|
|
<a href=#1027 id=1027 data-nosnippet>1027</a> <span class="kw">let </span>data = Data::deserialize(deserializer)<span class="question-mark">?</span>;
|
|
<a href=#1028 id=1028 data-nosnippet>1028</a> <span class="prelude-val">Ok</span>(data.as_f64())
|
|
<a href=#1029 id=1029 data-nosnippet>1029</a>}
|
|
<a href=#1030 id=1030 data-nosnippet>1030</a>
|
|
<a href=#1031 id=1031 data-nosnippet>1031</a><span class="doccomment">/// A helper function to deserialize cell values as `f64`,
|
|
<a href=#1032 id=1032 data-nosnippet>1032</a>/// useful when cells may also contain invalid values (i.e. strings).
|
|
<a href=#1033 id=1033 data-nosnippet>1033</a>/// It applies the [`as_f64`] method to the cell value, and returns
|
|
<a href=#1034 id=1034 data-nosnippet>1034</a>/// `Ok(Ok(value_as_f64))` if successful or `Ok(Err(value_to_string))` if unsuccessful,
|
|
<a href=#1035 id=1035 data-nosnippet>1035</a>/// therefore never failing. This function is intended to be used with Serde's
|
|
<a href=#1036 id=1036 data-nosnippet>1036</a>/// [`deserialize_with`](https://serde.rs/field-attrs.html) field attribute.
|
|
<a href=#1037 id=1037 data-nosnippet>1037</a></span><span class="kw">pub fn </span>deserialize_as_f64_or_string<<span class="lifetime">'de</span>, D>(
|
|
<a href=#1038 id=1038 data-nosnippet>1038</a> deserializer: D,
|
|
<a href=#1039 id=1039 data-nosnippet>1039</a>) -> <span class="prelude-ty">Result</span><<span class="prelude-ty">Result</span><f64, String>, D::Error>
|
|
<a href=#1040 id=1040 data-nosnippet>1040</a><span class="kw">where
|
|
<a href=#1041 id=1041 data-nosnippet>1041</a> </span>D: Deserializer<<span class="lifetime">'de</span>>,
|
|
<a href=#1042 id=1042 data-nosnippet>1042</a>{
|
|
<a href=#1043 id=1043 data-nosnippet>1043</a> <span class="kw">let </span>data = Data::deserialize(deserializer)<span class="question-mark">?</span>;
|
|
<a href=#1044 id=1044 data-nosnippet>1044</a> <span class="prelude-val">Ok</span>(data.as_f64().ok_or_else(|| data.to_string()))
|
|
<a href=#1045 id=1045 data-nosnippet>1045</a>}
|
|
<a href=#1046 id=1046 data-nosnippet>1046</a>
|
|
<a href=#1047 id=1047 data-nosnippet>1047</a><span class="doccomment">/// A helper function to deserialize cell values as `chrono::NaiveDate`,
|
|
<a href=#1048 id=1048 data-nosnippet>1048</a>/// useful when cells may also contain invalid values (i.e. strings).
|
|
<a href=#1049 id=1049 data-nosnippet>1049</a>/// It applies the [`as_date`] method to the cell value, and returns
|
|
<a href=#1050 id=1050 data-nosnippet>1050</a>/// `Ok(Some(value_as_date))` if successful or `Ok(None)` if unsuccessful,
|
|
<a href=#1051 id=1051 data-nosnippet>1051</a>/// therefore never failing. This function is intended to be used with Serde's
|
|
<a href=#1052 id=1052 data-nosnippet>1052</a>/// [`deserialize_with`](https://serde.rs/field-attrs.html) field attribute.
|
|
<a href=#1053 id=1053 data-nosnippet>1053</a></span><span class="attr">#[cfg(feature = <span class="string">"dates"</span>)]
|
|
<a href=#1054 id=1054 data-nosnippet>1054</a></span><span class="kw">pub fn </span>deserialize_as_date_or_none<<span class="lifetime">'de</span>, D>(
|
|
<a href=#1055 id=1055 data-nosnippet>1055</a> deserializer: D,
|
|
<a href=#1056 id=1056 data-nosnippet>1056</a>) -> <span class="prelude-ty">Result</span><<span class="prelude-ty">Option</span><chrono::NaiveDate>, D::Error>
|
|
<a href=#1057 id=1057 data-nosnippet>1057</a><span class="kw">where
|
|
<a href=#1058 id=1058 data-nosnippet>1058</a> </span>D: Deserializer<<span class="lifetime">'de</span>>,
|
|
<a href=#1059 id=1059 data-nosnippet>1059</a>{
|
|
<a href=#1060 id=1060 data-nosnippet>1060</a> <span class="kw">let </span>data = Data::deserialize(deserializer)<span class="question-mark">?</span>;
|
|
<a href=#1061 id=1061 data-nosnippet>1061</a> <span class="prelude-val">Ok</span>(data.as_date())
|
|
<a href=#1062 id=1062 data-nosnippet>1062</a>}
|
|
<a href=#1063 id=1063 data-nosnippet>1063</a>
|
|
<a href=#1064 id=1064 data-nosnippet>1064</a><span class="doccomment">/// A helper function to deserialize cell values as `chrono::NaiveDate`,
|
|
<a href=#1065 id=1065 data-nosnippet>1065</a>/// useful when cells may also contain invalid values (i.e. strings).
|
|
<a href=#1066 id=1066 data-nosnippet>1066</a>/// It applies the [`as_date`] method to the cell value, and returns
|
|
<a href=#1067 id=1067 data-nosnippet>1067</a>/// `Ok(Ok(value_as_date))` if successful or `Ok(Err(value_to_string))` if unsuccessful,
|
|
<a href=#1068 id=1068 data-nosnippet>1068</a>/// therefore never failing. This function is intended to be used with Serde's
|
|
<a href=#1069 id=1069 data-nosnippet>1069</a>/// [`deserialize_with`](https://serde.rs/field-attrs.html) field attribute.
|
|
<a href=#1070 id=1070 data-nosnippet>1070</a></span><span class="attr">#[cfg(feature = <span class="string">"dates"</span>)]
|
|
<a href=#1071 id=1071 data-nosnippet>1071</a></span><span class="kw">pub fn </span>deserialize_as_date_or_string<<span class="lifetime">'de</span>, D>(
|
|
<a href=#1072 id=1072 data-nosnippet>1072</a> deserializer: D,
|
|
<a href=#1073 id=1073 data-nosnippet>1073</a>) -> <span class="prelude-ty">Result</span><<span class="prelude-ty">Result</span><chrono::NaiveDate, String>, D::Error>
|
|
<a href=#1074 id=1074 data-nosnippet>1074</a><span class="kw">where
|
|
<a href=#1075 id=1075 data-nosnippet>1075</a> </span>D: Deserializer<<span class="lifetime">'de</span>>,
|
|
<a href=#1076 id=1076 data-nosnippet>1076</a>{
|
|
<a href=#1077 id=1077 data-nosnippet>1077</a> <span class="kw">let </span>data = Data::deserialize(deserializer)<span class="question-mark">?</span>;
|
|
<a href=#1078 id=1078 data-nosnippet>1078</a> <span class="prelude-val">Ok</span>(data.as_date().ok_or_else(|| data.to_string()))
|
|
<a href=#1079 id=1079 data-nosnippet>1079</a>}
|
|
<a href=#1080 id=1080 data-nosnippet>1080</a>
|
|
<a href=#1081 id=1081 data-nosnippet>1081</a><span class="doccomment">/// A helper function to deserialize cell values as `chrono::NaiveTime`,
|
|
<a href=#1082 id=1082 data-nosnippet>1082</a>/// useful when cells may also contain invalid values (i.e. strings).
|
|
<a href=#1083 id=1083 data-nosnippet>1083</a>/// It applies the [`as_time`] method to the cell value, and returns
|
|
<a href=#1084 id=1084 data-nosnippet>1084</a>/// `Ok(Some(value_as_time))` if successful or `Ok(None)` if unsuccessful,
|
|
<a href=#1085 id=1085 data-nosnippet>1085</a>/// therefore never failing. This function is intended to be used with Serde's
|
|
<a href=#1086 id=1086 data-nosnippet>1086</a>/// [`deserialize_with`](https://serde.rs/field-attrs.html) field attribute.
|
|
<a href=#1087 id=1087 data-nosnippet>1087</a></span><span class="attr">#[cfg(feature = <span class="string">"dates"</span>)]
|
|
<a href=#1088 id=1088 data-nosnippet>1088</a></span><span class="kw">pub fn </span>deserialize_as_time_or_none<<span class="lifetime">'de</span>, D>(
|
|
<a href=#1089 id=1089 data-nosnippet>1089</a> deserializer: D,
|
|
<a href=#1090 id=1090 data-nosnippet>1090</a>) -> <span class="prelude-ty">Result</span><<span class="prelude-ty">Option</span><chrono::NaiveTime>, D::Error>
|
|
<a href=#1091 id=1091 data-nosnippet>1091</a><span class="kw">where
|
|
<a href=#1092 id=1092 data-nosnippet>1092</a> </span>D: Deserializer<<span class="lifetime">'de</span>>,
|
|
<a href=#1093 id=1093 data-nosnippet>1093</a>{
|
|
<a href=#1094 id=1094 data-nosnippet>1094</a> <span class="kw">let </span>data = Data::deserialize(deserializer)<span class="question-mark">?</span>;
|
|
<a href=#1095 id=1095 data-nosnippet>1095</a> <span class="prelude-val">Ok</span>(data.as_time())
|
|
<a href=#1096 id=1096 data-nosnippet>1096</a>}
|
|
<a href=#1097 id=1097 data-nosnippet>1097</a>
|
|
<a href=#1098 id=1098 data-nosnippet>1098</a><span class="doccomment">/// A helper function to deserialize cell values as `chrono::NaiveTime`,
|
|
<a href=#1099 id=1099 data-nosnippet>1099</a>/// useful when cells may also contain invalid values (i.e. strings).
|
|
<a href=#1100 id=1100 data-nosnippet>1100</a>/// It applies the [`as_time`] method to the cell value, and returns
|
|
<a href=#1101 id=1101 data-nosnippet>1101</a>/// `Ok(Ok(value_as_time))` if successful or `Ok(Err(value_to_string))` if unsuccessful,
|
|
<a href=#1102 id=1102 data-nosnippet>1102</a>/// therefore never failing. This function is intended to be used with Serde's
|
|
<a href=#1103 id=1103 data-nosnippet>1103</a>/// [`deserialize_with`](https://serde.rs/field-attrs.html) field attribute.
|
|
<a href=#1104 id=1104 data-nosnippet>1104</a></span><span class="attr">#[cfg(feature = <span class="string">"dates"</span>)]
|
|
<a href=#1105 id=1105 data-nosnippet>1105</a></span><span class="kw">pub fn </span>deserialize_as_time_or_string<<span class="lifetime">'de</span>, D>(
|
|
<a href=#1106 id=1106 data-nosnippet>1106</a> deserializer: D,
|
|
<a href=#1107 id=1107 data-nosnippet>1107</a>) -> <span class="prelude-ty">Result</span><<span class="prelude-ty">Result</span><chrono::NaiveTime, String>, D::Error>
|
|
<a href=#1108 id=1108 data-nosnippet>1108</a><span class="kw">where
|
|
<a href=#1109 id=1109 data-nosnippet>1109</a> </span>D: Deserializer<<span class="lifetime">'de</span>>,
|
|
<a href=#1110 id=1110 data-nosnippet>1110</a>{
|
|
<a href=#1111 id=1111 data-nosnippet>1111</a> <span class="kw">let </span>data = Data::deserialize(deserializer)<span class="question-mark">?</span>;
|
|
<a href=#1112 id=1112 data-nosnippet>1112</a> <span class="prelude-val">Ok</span>(data.as_time().ok_or_else(|| data.to_string()))
|
|
<a href=#1113 id=1113 data-nosnippet>1113</a>}
|
|
<a href=#1114 id=1114 data-nosnippet>1114</a>
|
|
<a href=#1115 id=1115 data-nosnippet>1115</a><span class="doccomment">/// A helper function to deserialize cell values as `chrono::Duration`,
|
|
<a href=#1116 id=1116 data-nosnippet>1116</a>/// useful when cells may also contain invalid values (i.e. strings).
|
|
<a href=#1117 id=1117 data-nosnippet>1117</a>/// It applies the [`as_duration`] method to the cell value, and returns
|
|
<a href=#1118 id=1118 data-nosnippet>1118</a>/// `Ok(Some(value_as_duration))` if successful or `Ok(None)` if unsuccessful,
|
|
<a href=#1119 id=1119 data-nosnippet>1119</a>/// therefore never failing. This function is intended to be used with Serde's
|
|
<a href=#1120 id=1120 data-nosnippet>1120</a>/// [`deserialize_with`](https://serde.rs/field-attrs.html) field attribute.
|
|
<a href=#1121 id=1121 data-nosnippet>1121</a></span><span class="attr">#[cfg(feature = <span class="string">"dates"</span>)]
|
|
<a href=#1122 id=1122 data-nosnippet>1122</a></span><span class="kw">pub fn </span>deserialize_as_duration_or_none<<span class="lifetime">'de</span>, D>(
|
|
<a href=#1123 id=1123 data-nosnippet>1123</a> deserializer: D,
|
|
<a href=#1124 id=1124 data-nosnippet>1124</a>) -> <span class="prelude-ty">Result</span><<span class="prelude-ty">Option</span><chrono::Duration>, D::Error>
|
|
<a href=#1125 id=1125 data-nosnippet>1125</a><span class="kw">where
|
|
<a href=#1126 id=1126 data-nosnippet>1126</a> </span>D: Deserializer<<span class="lifetime">'de</span>>,
|
|
<a href=#1127 id=1127 data-nosnippet>1127</a>{
|
|
<a href=#1128 id=1128 data-nosnippet>1128</a> <span class="kw">let </span>data = Data::deserialize(deserializer)<span class="question-mark">?</span>;
|
|
<a href=#1129 id=1129 data-nosnippet>1129</a> <span class="prelude-val">Ok</span>(data.as_duration())
|
|
<a href=#1130 id=1130 data-nosnippet>1130</a>}
|
|
<a href=#1131 id=1131 data-nosnippet>1131</a>
|
|
<a href=#1132 id=1132 data-nosnippet>1132</a><span class="doccomment">/// A helper function to deserialize cell values as `chrono::Duration`,
|
|
<a href=#1133 id=1133 data-nosnippet>1133</a>/// useful when cells may also contain invalid values (i.e. strings).
|
|
<a href=#1134 id=1134 data-nosnippet>1134</a>/// It applies the [`as_duration`] method to the cell value, and returns
|
|
<a href=#1135 id=1135 data-nosnippet>1135</a>/// `Ok(Ok(value_as_duration))` if successful or `Ok(Err(value_to_string))` if unsuccessful,
|
|
<a href=#1136 id=1136 data-nosnippet>1136</a>/// therefore never failing. This function is intended to be used with Serde's
|
|
<a href=#1137 id=1137 data-nosnippet>1137</a>/// [`deserialize_with`](https://serde.rs/field-attrs.html) field attribute.
|
|
<a href=#1138 id=1138 data-nosnippet>1138</a></span><span class="attr">#[cfg(feature = <span class="string">"dates"</span>)]
|
|
<a href=#1139 id=1139 data-nosnippet>1139</a></span><span class="kw">pub fn </span>deserialize_as_duration_or_string<<span class="lifetime">'de</span>, D>(
|
|
<a href=#1140 id=1140 data-nosnippet>1140</a> deserializer: D,
|
|
<a href=#1141 id=1141 data-nosnippet>1141</a>) -> <span class="prelude-ty">Result</span><<span class="prelude-ty">Result</span><chrono::Duration, String>, D::Error>
|
|
<a href=#1142 id=1142 data-nosnippet>1142</a><span class="kw">where
|
|
<a href=#1143 id=1143 data-nosnippet>1143</a> </span>D: Deserializer<<span class="lifetime">'de</span>>,
|
|
<a href=#1144 id=1144 data-nosnippet>1144</a>{
|
|
<a href=#1145 id=1145 data-nosnippet>1145</a> <span class="kw">let </span>data = Data::deserialize(deserializer)<span class="question-mark">?</span>;
|
|
<a href=#1146 id=1146 data-nosnippet>1146</a> <span class="prelude-val">Ok</span>(data.as_duration().ok_or_else(|| data.to_string()))
|
|
<a href=#1147 id=1147 data-nosnippet>1147</a>}
|
|
<a href=#1148 id=1148 data-nosnippet>1148</a>
|
|
<a href=#1149 id=1149 data-nosnippet>1149</a><span class="doccomment">/// A helper function to deserialize cell values as `chrono::NaiveDateTime`,
|
|
<a href=#1150 id=1150 data-nosnippet>1150</a>/// useful when cells may also contain invalid values (i.e. strings).
|
|
<a href=#1151 id=1151 data-nosnippet>1151</a>/// It applies the [`as_datetime`] method to the cell value, and returns
|
|
<a href=#1152 id=1152 data-nosnippet>1152</a>/// `Ok(Some(value_as_datetime))` if successful or `Ok(None)` if unsuccessful,
|
|
<a href=#1153 id=1153 data-nosnippet>1153</a>/// therefore never failing. This function is intended to be used with Serde's
|
|
<a href=#1154 id=1154 data-nosnippet>1154</a>/// [`deserialize_with`](https://serde.rs/field-attrs.html) field attribute.
|
|
<a href=#1155 id=1155 data-nosnippet>1155</a></span><span class="attr">#[cfg(feature = <span class="string">"dates"</span>)]
|
|
<a href=#1156 id=1156 data-nosnippet>1156</a></span><span class="kw">pub fn </span>deserialize_as_datetime_or_none<<span class="lifetime">'de</span>, D>(
|
|
<a href=#1157 id=1157 data-nosnippet>1157</a> deserializer: D,
|
|
<a href=#1158 id=1158 data-nosnippet>1158</a>) -> <span class="prelude-ty">Result</span><<span class="prelude-ty">Option</span><chrono::NaiveDateTime>, D::Error>
|
|
<a href=#1159 id=1159 data-nosnippet>1159</a><span class="kw">where
|
|
<a href=#1160 id=1160 data-nosnippet>1160</a> </span>D: Deserializer<<span class="lifetime">'de</span>>,
|
|
<a href=#1161 id=1161 data-nosnippet>1161</a>{
|
|
<a href=#1162 id=1162 data-nosnippet>1162</a> <span class="kw">let </span>data = Data::deserialize(deserializer)<span class="question-mark">?</span>;
|
|
<a href=#1163 id=1163 data-nosnippet>1163</a> <span class="prelude-val">Ok</span>(data.as_datetime())
|
|
<a href=#1164 id=1164 data-nosnippet>1164</a>}
|
|
<a href=#1165 id=1165 data-nosnippet>1165</a>
|
|
<a href=#1166 id=1166 data-nosnippet>1166</a><span class="doccomment">/// A helper function to deserialize cell values as `chrono::NaiveDateTime`,
|
|
<a href=#1167 id=1167 data-nosnippet>1167</a>/// useful when cells may also contain invalid values (i.e. strings).
|
|
<a href=#1168 id=1168 data-nosnippet>1168</a>/// It applies the [`as_datetime`] method to the cell value, and returns
|
|
<a href=#1169 id=1169 data-nosnippet>1169</a>/// `Ok(Ok(value_as_datetime))` if successful or `Ok(Err(value_to_string))` if unsuccessful,
|
|
<a href=#1170 id=1170 data-nosnippet>1170</a>/// therefore never failing. This function is intended to be used with Serde's
|
|
<a href=#1171 id=1171 data-nosnippet>1171</a>/// [`deserialize_with`](https://serde.rs/field-attrs.html) field attribute.
|
|
<a href=#1172 id=1172 data-nosnippet>1172</a></span><span class="attr">#[cfg(feature = <span class="string">"dates"</span>)]
|
|
<a href=#1173 id=1173 data-nosnippet>1173</a></span><span class="kw">pub fn </span>deserialize_as_datetime_or_string<<span class="lifetime">'de</span>, D>(
|
|
<a href=#1174 id=1174 data-nosnippet>1174</a> deserializer: D,
|
|
<a href=#1175 id=1175 data-nosnippet>1175</a>) -> <span class="prelude-ty">Result</span><<span class="prelude-ty">Result</span><chrono::NaiveDateTime, String>, D::Error>
|
|
<a href=#1176 id=1176 data-nosnippet>1176</a><span class="kw">where
|
|
<a href=#1177 id=1177 data-nosnippet>1177</a> </span>D: Deserializer<<span class="lifetime">'de</span>>,
|
|
<a href=#1178 id=1178 data-nosnippet>1178</a>{
|
|
<a href=#1179 id=1179 data-nosnippet>1179</a> <span class="kw">let </span>data = Data::deserialize(deserializer)<span class="question-mark">?</span>;
|
|
<a href=#1180 id=1180 data-nosnippet>1180</a> <span class="prelude-val">Ok</span>(data.as_datetime().ok_or_else(|| data.to_string()))
|
|
<a href=#1181 id=1181 data-nosnippet>1181</a>}
|
|
</code></pre></div></section></main></body></html> |