274 lines
42 KiB
HTML
274 lines
42 KiB
HTML
<!-- HTML header for doxygen 1.8.18-->
|
|
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
|
|
<html xmlns="http://www.w3.org/1999/xhtml">
|
|
<head>
|
|
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
|
|
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
|
|
<meta name="generator" content="Doxygen 1.9.2"/>
|
|
<meta name="viewport" content="width=device-width, initial-scale=1"/>
|
|
<title>OR-Tools: file_util.h Source File</title>
|
|
<link href="tabs.css" rel="stylesheet" type="text/css"/>
|
|
<script type="text/javascript" src="jquery.js"></script>
|
|
<script type="text/javascript" src="dynsections.js"></script>
|
|
<link href="navtree.css" rel="stylesheet" type="text/css"/>
|
|
<script type="text/javascript" src="resize.js"></script>
|
|
<script type="text/javascript" src="navtreedata.js"></script>
|
|
<script type="text/javascript" src="navtree.js"></script>
|
|
<link href="search/search.css" rel="stylesheet" type="text/css"/>
|
|
<script type="text/javascript" src="search/searchdata.js"></script>
|
|
<script type="text/javascript" src="search/search.js"></script>
|
|
<link href="doxygen.css" rel="stylesheet" type="text/css" />
|
|
<link href="styleSheet.tmp.css" rel="stylesheet" type="text/css"/>
|
|
</head>
|
|
<body>
|
|
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
|
|
<div id="titlearea">
|
|
<table cellspacing="0" cellpadding="0">
|
|
<tbody>
|
|
<tr style="height: 56px;">
|
|
<td id="projectlogo"><img alt="Logo" src="orLogo.png"/></td>
|
|
<td id="projectalign" style="padding-left: 0.5em;">
|
|
<div id="projectname">OR-Tools
|
|
 <span id="projectnumber">9.1</span>
|
|
</div>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<!-- end header part -->
|
|
<!-- Generated by Doxygen 1.9.2 -->
|
|
<script type="text/javascript">
|
|
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&dn=expat.txt MIT */
|
|
var searchBox = new SearchBox("searchBox", "search",'Search','.html');
|
|
/* @license-end */
|
|
</script>
|
|
<script type="text/javascript" src="menudata.js"></script>
|
|
<script type="text/javascript" src="menu.js"></script>
|
|
<script type="text/javascript">
|
|
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&dn=expat.txt MIT */
|
|
$(function() {
|
|
initMenu('',true,false,'search.php','Search');
|
|
$(document).ready(function() { init_search(); });
|
|
});
|
|
/* @license-end */
|
|
</script>
|
|
<div id="main-nav"></div>
|
|
</div><!-- top -->
|
|
<div id="side-nav" class="ui-resizable side-nav-resizable">
|
|
<div id="nav-tree">
|
|
<div id="nav-tree-contents">
|
|
<div id="nav-sync" class="sync"></div>
|
|
</div>
|
|
</div>
|
|
<div id="splitbar" style="-moz-user-select:none;"
|
|
class="ui-resizable-handle">
|
|
</div>
|
|
</div>
|
|
<script type="text/javascript">
|
|
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&dn=expat.txt MIT */
|
|
$(document).ready(function(){initNavTree('file__util_8h_source.html',''); initResizable(); });
|
|
/* @license-end */
|
|
</script>
|
|
<div id="doc-content">
|
|
<!-- window showing the filter options -->
|
|
<div id="MSearchSelectWindow"
|
|
onmouseover="return searchBox.OnSearchSelectShow()"
|
|
onmouseout="return searchBox.OnSearchSelectHide()"
|
|
onkeydown="return searchBox.OnSearchSelectKey(event)">
|
|
</div>
|
|
|
|
<!-- iframe showing the search results (closed by default) -->
|
|
<div id="MSearchResultsWindow">
|
|
<iframe src="javascript:void(0)" frameborder="0"
|
|
name="MSearchResults" id="MSearchResults">
|
|
</iframe>
|
|
</div>
|
|
|
|
<div class="header">
|
|
<div class="headertitle"><div class="title">file_util.h</div></div>
|
|
</div><!--header-->
|
|
<div class="contents">
|
|
<a href="file__util_8h.html">Go to the documentation of this file.</a><div class="fragment"><div class="line"><a id="l00001" name="l00001"></a><span class="lineno"> 1</span><span class="comment">// Copyright 2010-2021 Google LLC</span></div>
|
|
<div class="line"><a id="l00002" name="l00002"></a><span class="lineno"> 2</span><span class="comment">// Licensed under the Apache License, Version 2.0 (the "License");</span></div>
|
|
<div class="line"><a id="l00003" name="l00003"></a><span class="lineno"> 3</span><span class="comment">// you may not use this file except in compliance with the License.</span></div>
|
|
<div class="line"><a id="l00004" name="l00004"></a><span class="lineno"> 4</span><span class="comment">// You may obtain a copy of the License at</span></div>
|
|
<div class="line"><a id="l00005" name="l00005"></a><span class="lineno"> 5</span><span class="comment">//</span></div>
|
|
<div class="line"><a id="l00006" name="l00006"></a><span class="lineno"> 6</span><span class="comment">// http://www.apache.org/licenses/LICENSE-2.0</span></div>
|
|
<div class="line"><a id="l00007" name="l00007"></a><span class="lineno"> 7</span><span class="comment">//</span></div>
|
|
<div class="line"><a id="l00008" name="l00008"></a><span class="lineno"> 8</span><span class="comment">// Unless required by applicable law or agreed to in writing, software</span></div>
|
|
<div class="line"><a id="l00009" name="l00009"></a><span class="lineno"> 9</span><span class="comment">// distributed under the License is distributed on an "AS IS" BASIS,</span></div>
|
|
<div class="line"><a id="l00010" name="l00010"></a><span class="lineno"> 10</span><span class="comment">// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.</span></div>
|
|
<div class="line"><a id="l00011" name="l00011"></a><span class="lineno"> 11</span><span class="comment">// See the License for the specific language governing permissions and</span></div>
|
|
<div class="line"><a id="l00012" name="l00012"></a><span class="lineno"> 12</span><span class="comment">// limitations under the License.</span></div>
|
|
<div class="line"><a id="l00013" name="l00013"></a><span class="lineno"> 13</span> </div>
|
|
<div class="line"><a id="l00014" name="l00014"></a><span class="lineno"> 14</span><span class="preprocessor">#ifndef OR_TOOLS_UTIL_FILE_UTIL_H_</span></div>
|
|
<div class="line"><a id="l00015" name="l00015"></a><span class="lineno"> 15</span><span class="preprocessor">#define OR_TOOLS_UTIL_FILE_UTIL_H_</span></div>
|
|
<div class="line"><a id="l00016" name="l00016"></a><span class="lineno"> 16</span> </div>
|
|
<div class="line"><a id="l00017" name="l00017"></a><span class="lineno"> 17</span><span class="preprocessor">#include <limits></span></div>
|
|
<div class="line"><a id="l00018" name="l00018"></a><span class="lineno"> 18</span><span class="preprocessor">#include <vector></span></div>
|
|
<div class="line"><a id="l00019" name="l00019"></a><span class="lineno"> 19</span> </div>
|
|
<div class="line"><a id="l00020" name="l00020"></a><span class="lineno"> 20</span><span class="preprocessor">#include "absl/status/statusor.h"</span></div>
|
|
<div class="line"><a id="l00021" name="l00021"></a><span class="lineno"> 21</span><span class="preprocessor">#include "absl/strings/string_view.h"</span></div>
|
|
<div class="line"><a id="l00022" name="l00022"></a><span class="lineno"> 22</span><span class="preprocessor">#include "google/protobuf/message.h"</span></div>
|
|
<div class="line"><a id="l00023" name="l00023"></a><span class="lineno"> 23</span><span class="preprocessor">#include "<a class="code" href="base_2file_8h.html">ortools/base/file.h</a>"</span></div>
|
|
<div class="line"><a id="l00024" name="l00024"></a><span class="lineno"> 24</span><span class="preprocessor">#include "<a class="code" href="recordio_8h.html">ortools/base/recordio.h</a>"</span></div>
|
|
<div class="line"><a id="l00025" name="l00025"></a><span class="lineno"> 25</span> </div>
|
|
<div class="line"><a id="l00026" name="l00026"></a><span class="lineno"> 26</span><span class="keyword">namespace </span><a class="code hl_namespace" href="namespaceoperations__research.html">operations_research</a> {</div>
|
|
<div class="line"><a id="l00027" name="l00027"></a><span class="lineno"> 27</span> </div>
|
|
<div class="line"><a id="l00028" name="l00028"></a><span class="lineno"> 28</span><span class="comment">// Reads a file, optionally gzipped, to a string.</span></div>
|
|
<div class="line"><a id="l00029" name="l00029"></a><span class="lineno"> 29</span>absl::StatusOr<std::string> <a class="code hl_function" href="namespaceoperations__research.html#a319f5b5c935d6fb479624ae04d60d5ea">ReadFileToString</a>(absl::string_view filename);</div>
|
|
<div class="line"><a id="l00030" name="l00030"></a><span class="lineno"> 30</span> </div>
|
|
<div class="line"><a id="l00031" name="l00031"></a><span class="lineno"> 31</span><span class="comment">// Reads a proto from a file. Supports the following formats: binary, text,</span></div>
|
|
<div class="line"><a id="l00032" name="l00032"></a><span class="lineno"> 32</span><span class="comment">// JSON, all of those optionally gzipped. Crashes on filesystem failures, e.g.</span></div>
|
|
<div class="line"><a id="l00033" name="l00033"></a><span class="lineno"> 33</span><span class="comment">// file unreadable. Returns false on format failures, e.g. the file could be</span></div>
|
|
<div class="line"><a id="l00034" name="l00034"></a><span class="lineno"> 34</span><span class="comment">// read, but the contents couldn't be parsed -- or maybe it was a valid JSON,</span></div>
|
|
<div class="line"><a id="l00035" name="l00035"></a><span class="lineno"> 35</span><span class="comment">// text proto, or binary proto, but not of the right proto message.</span></div>
|
|
<div class="line"><a id="l00036" name="l00036"></a><span class="lineno"> 36</span><span class="comment">// Returns true on success.</span></div>
|
|
<div class="line"><a id="l00037" name="l00037"></a><span class="lineno"> 37</span><span class="keywordtype">bool</span> <a class="code hl_function" href="namespaceoperations__research.html#ac9d6b171922e3bb93b3795f4241c70e4">ReadFileToProto</a>(absl::string_view filename,</div>
|
|
<div class="line"><a id="l00038" name="l00038"></a><span class="lineno"> 38</span> google::protobuf::Message* <a class="code hl_variable" href="cp__model__fz__solver_8cc.html#aed003f5eb5197bc586b7ef2c36a63da2">proto</a>);</div>
|
|
<div class="line"><a id="l00039" name="l00039"></a><span class="lineno"> 39</span> </div>
|
|
<div class="line"><a id="l00040" name="l00040"></a><span class="lineno"> 40</span><span class="keyword">template</span> <<span class="keyword">typename</span> Proto></div>
|
|
<div class="line"><a id="l00041" name="l00041"></a><span class="lineno"><a class="line" href="namespaceoperations__research.html#a0512869fd2f9e687199df5ceb9d04859"> 41</a></span>Proto <a class="code hl_function" href="namespaceoperations__research.html#a0512869fd2f9e687199df5ceb9d04859">ReadFileToProtoOrDie</a>(absl::string_view filename) {</div>
|
|
<div class="line"><a id="l00042" name="l00042"></a><span class="lineno"> 42</span> Proto <a class="code hl_variable" href="cp__model__fz__solver_8cc.html#aed003f5eb5197bc586b7ef2c36a63da2">proto</a>;</div>
|
|
<div class="line"><a id="l00043" name="l00043"></a><span class="lineno"> 43</span> <a class="code hl_define" href="base_2logging_8h.html#a3e1cfef60e774a81f30eaddf26a3a274">CHECK</a>(<a class="code hl_function" href="namespaceoperations__research.html#ac9d6b171922e3bb93b3795f4241c70e4">ReadFileToProto</a>(filename, &<a class="code hl_variable" href="cp__model__fz__solver_8cc.html#aed003f5eb5197bc586b7ef2c36a63da2">proto</a>)) << <span class="stringliteral">"with file: '"</span> << filename << <span class="stringliteral">"'"</span>;</div>
|
|
<div class="line"><a id="l00044" name="l00044"></a><span class="lineno"> 44</span> <span class="keywordflow">return</span> <a class="code hl_variable" href="cp__model__fz__solver_8cc.html#aed003f5eb5197bc586b7ef2c36a63da2">proto</a>;</div>
|
|
<div class="line"><a id="l00045" name="l00045"></a><span class="lineno"> 45</span>}</div>
|
|
<div class="line"><a id="l00046" name="l00046"></a><span class="lineno"> 46</span> </div>
|
|
<div class="line"><a id="l00047" name="l00047"></a><span class="lineno"> 47</span><span class="comment">// Specifies how the proto should be formatted when writing it to a file.</span></div>
|
|
<div class="line"><a id="l00048" name="l00048"></a><span class="lineno"> 48</span><span class="comment">// kCanonicalJson applies Proto3 to JSON encoding conventions and converts field</span></div>
|
|
<div class="line"><a id="l00049" name="l00049"></a><span class="lineno"> 49</span><span class="comment">// names to lower camel-case.</span></div>
|
|
<div class="line"><a id="l00050" name="l00050"></a><span class="lineno"><a class="line" href="namespaceoperations__research.html#aaf9694f57960ede8c406e3bd923bcd72"> 50</a></span><span class="keyword">enum class</span> <a class="code hl_enumeration" href="namespaceoperations__research.html#aaf9694f57960ede8c406e3bd923bcd72">ProtoWriteFormat</a> { <a class="code hl_enumvalue" href="namespaceoperations__research.html#aaf9694f57960ede8c406e3bd923bcd72adfcd8e748f506324dff6a9d5e7aea00b">kProtoText</a>, <a class="code hl_enumvalue" href="namespaceoperations__research.html#aaf9694f57960ede8c406e3bd923bcd72aa0af2ac06be96f6784af5295aab62c76">kProtoBinary</a>, <a class="code hl_enumvalue" href="namespaceoperations__research.html#aaf9694f57960ede8c406e3bd923bcd72a319f3b99b8d96c21e2f6b7ebc6fe8d8f">kJson</a>, <a class="code hl_enumvalue" href="namespaceoperations__research.html#aaf9694f57960ede8c406e3bd923bcd72adb5cce9ced76fea1f9c1e9f3e5cb1d90">kCanonicalJson</a> };</div>
|
|
<div class="line"><a id="l00051" name="l00051"></a><span class="lineno"> 51</span> </div>
|
|
<div class="line"><a id="l00052" name="l00052"></a><span class="lineno"> 52</span><span class="comment">// Writes a proto to a file. Supports the following formats: binary, text, JSON,</span></div>
|
|
<div class="line"><a id="l00053" name="l00053"></a><span class="lineno"> 53</span><span class="comment">// all of those optionally gzipped. Returns false on failure.</span></div>
|
|
<div class="line"><a id="l00054" name="l00054"></a><span class="lineno"> 54</span><span class="comment">// If 'proto_write_format' is kProtoBinary, ".bin" is appended to file_name. If</span></div>
|
|
<div class="line"><a id="l00055" name="l00055"></a><span class="lineno"> 55</span><span class="comment">// 'proto_write_format' is kJson or kCanonicalJson, ".json" is appended to</span></div>
|
|
<div class="line"><a id="l00056" name="l00056"></a><span class="lineno"> 56</span><span class="comment">// file_name. If 'gzipped' is true, ".gz" is appended to file_name.</span></div>
|
|
<div class="line"><a id="l00057" name="l00057"></a><span class="lineno"> 57</span><span class="keywordtype">bool</span> <a class="code hl_function" href="namespaceoperations__research.html#a57741d0280e266642d7d146d0d0beedb">WriteProtoToFile</a>(absl::string_view filename,</div>
|
|
<div class="line"><a id="l00058" name="l00058"></a><span class="lineno"> 58</span> <span class="keyword">const</span> google::protobuf::Message& <a class="code hl_variable" href="cp__model__fz__solver_8cc.html#aed003f5eb5197bc586b7ef2c36a63da2">proto</a>,</div>
|
|
<div class="line"><a id="l00059" name="l00059"></a><span class="lineno"> 59</span> <a class="code hl_enumeration" href="namespaceoperations__research.html#aaf9694f57960ede8c406e3bd923bcd72">ProtoWriteFormat</a> proto_write_format, <span class="keywordtype">bool</span> gzipped = <span class="keyword">false</span>,</div>
|
|
<div class="line"><a id="l00060" name="l00060"></a><span class="lineno"> 60</span> <span class="keywordtype">bool</span> append_extension_to_file_name = <span class="keyword">true</span>);</div>
|
|
<div class="line"><a id="l00061" name="l00061"></a><span class="lineno"> 61</span> </div>
|
|
<div class="line"><a id="l00062" name="l00062"></a><span class="lineno"> 62</span><span class="keyword">namespace </span><a class="code hl_namespace" href="namespaceinternal.html">internal</a> {</div>
|
|
<div class="line"><a id="l00063" name="l00063"></a><span class="lineno"> 63</span><span class="comment">// General method to read expected_num_records from a file. If</span></div>
|
|
<div class="line"><a id="l00064" name="l00064"></a><span class="lineno"> 64</span><span class="comment">// expected_num_records is -1, then reads all records from the file. If not,</span></div>
|
|
<div class="line"><a id="l00065" name="l00065"></a><span class="lineno"> 65</span><span class="comment">// dies if the file doesn't contain exactly expected_num_records.</span></div>
|
|
<div class="line"><a id="l00066" name="l00066"></a><span class="lineno"> 66</span><span class="keyword">template</span> <<span class="keyword">typename</span> Proto></div>
|
|
<div class="line"><a id="l00067" name="l00067"></a><span class="lineno"><a class="line" href="namespaceoperations__research_1_1internal.html#a69fdb007201984e0caf5498e5a05490f"> 67</a></span>std::vector<Proto> <a class="code hl_function" href="namespaceoperations__research_1_1internal.html#a69fdb007201984e0caf5498e5a05490f">ReadNumRecords</a>(<a class="code hl_class" href="class_file.html">File</a>* <a class="code hl_namespace" href="namespacefile.html">file</a>, <span class="keywordtype">int</span> expected_num_records) {</div>
|
|
<div class="line"><a id="l00068" name="l00068"></a><span class="lineno"> 68</span> <a class="code hl_class" href="classrecordio_1_1_record_reader.html">recordio::RecordReader</a> reader(<a class="code hl_namespace" href="namespacefile.html">file</a>);</div>
|
|
<div class="line"><a id="l00069" name="l00069"></a><span class="lineno"> 69</span> std::vector<Proto> protos;</div>
|
|
<div class="line"><a id="l00070" name="l00070"></a><span class="lineno"> 70</span> Proto <a class="code hl_variable" href="cp__model__fz__solver_8cc.html#aed003f5eb5197bc586b7ef2c36a63da2">proto</a>;</div>
|
|
<div class="line"><a id="l00071" name="l00071"></a><span class="lineno"> 71</span> <span class="keywordtype">int</span> num_read = 0;</div>
|
|
<div class="line"><a id="l00072" name="l00072"></a><span class="lineno"> 72</span> <span class="keywordflow">while</span> (num_read != expected_num_records &&</div>
|
|
<div class="line"><a id="l00073" name="l00073"></a><span class="lineno"> 73</span> reader.<a class="code hl_function" href="classrecordio_1_1_record_reader.html#aefd9688ad8e40608a91e2189aed986b5">ReadProtocolMessage</a>(&<a class="code hl_variable" href="cp__model__fz__solver_8cc.html#aed003f5eb5197bc586b7ef2c36a63da2">proto</a>)) {</div>
|
|
<div class="line"><a id="l00074" name="l00074"></a><span class="lineno"> 74</span> protos.push_back(<a class="code hl_variable" href="cp__model__fz__solver_8cc.html#aed003f5eb5197bc586b7ef2c36a63da2">proto</a>);</div>
|
|
<div class="line"><a id="l00075" name="l00075"></a><span class="lineno"> 75</span> ++num_read;</div>
|
|
<div class="line"><a id="l00076" name="l00076"></a><span class="lineno"> 76</span> }</div>
|
|
<div class="line"><a id="l00077" name="l00077"></a><span class="lineno"> 77</span> </div>
|
|
<div class="line"><a id="l00078" name="l00078"></a><span class="lineno"> 78</span> <a class="code hl_define" href="base_2logging_8h.html#a3e1cfef60e774a81f30eaddf26a3a274">CHECK</a>(reader.<a class="code hl_function" href="classrecordio_1_1_record_reader.html#aef7e3d18ef267f23f64ad397fa359cc1">Close</a>())</div>
|
|
<div class="line"><a id="l00079" name="l00079"></a><span class="lineno"> 79</span> << <span class="stringliteral">"File '"</span> << <a class="code hl_namespace" href="namespacefile.html">file</a>->filename()</div>
|
|
<div class="line"><a id="l00080" name="l00080"></a><span class="lineno"> 80</span> << <span class="stringliteral">"'was not fully read, or something went wrong when closing "</span></div>
|
|
<div class="line"><a id="l00081" name="l00081"></a><span class="lineno"> 81</span> <span class="stringliteral">"it. Is it the right format? (RecordIO of Protocol Buffers)."</span>;</div>
|
|
<div class="line"><a id="l00082" name="l00082"></a><span class="lineno"> 82</span> </div>
|
|
<div class="line"><a id="l00083" name="l00083"></a><span class="lineno"> 83</span> <span class="keywordflow">if</span> (expected_num_records >= 0) {</div>
|
|
<div class="line"><a id="l00084" name="l00084"></a><span class="lineno"> 84</span> <a class="code hl_define" href="base_2logging_8h.html#a7c0ce053b28d53aa4eaf3eb7fb71663b">CHECK_EQ</a>(num_read, expected_num_records)</div>
|
|
<div class="line"><a id="l00085" name="l00085"></a><span class="lineno"> 85</span> << <span class="stringliteral">"There were less than the expected "</span> << expected_num_records</div>
|
|
<div class="line"><a id="l00086" name="l00086"></a><span class="lineno"> 86</span> << <span class="stringliteral">" in the file."</span>;</div>
|
|
<div class="line"><a id="l00087" name="l00087"></a><span class="lineno"> 87</span> }</div>
|
|
<div class="line"><a id="l00088" name="l00088"></a><span class="lineno"> 88</span> </div>
|
|
<div class="line"><a id="l00089" name="l00089"></a><span class="lineno"> 89</span> <span class="keywordflow">return</span> protos;</div>
|
|
<div class="line"><a id="l00090" name="l00090"></a><span class="lineno"> 90</span>}</div>
|
|
<div class="line"><a id="l00091" name="l00091"></a><span class="lineno"> 91</span> </div>
|
|
<div class="line"><a id="l00092" name="l00092"></a><span class="lineno"> 92</span><span class="comment">// Ditto, taking a filename as argument.</span></div>
|
|
<div class="line"><a id="l00093" name="l00093"></a><span class="lineno"> 93</span><span class="keyword">template</span> <<span class="keyword">typename</span> Proto></div>
|
|
<div class="line"><a id="l00094" name="l00094"></a><span class="lineno"><a class="line" href="namespaceoperations__research_1_1internal.html#a4c502cb057a0c067c38aff7673965727"> 94</a></span>std::vector<Proto> <a class="code hl_function" href="namespaceoperations__research_1_1internal.html#a69fdb007201984e0caf5498e5a05490f">ReadNumRecords</a>(absl::string_view filename,</div>
|
|
<div class="line"><a id="l00095" name="l00095"></a><span class="lineno"> 95</span> <span class="keywordtype">int</span> expected_num_records) {</div>
|
|
<div class="line"><a id="l00096" name="l00096"></a><span class="lineno"> 96</span> <span class="keywordflow">return</span> ReadNumRecords<Proto>(<a class="code hl_function" href="namespacefile.html#a38270c9b9606599c428aad7d942ba033">file::OpenOrDie</a>(filename, <span class="stringliteral">"r"</span>, <a class="code hl_function" href="namespacefile.html#a1abdf766bb120d38e7a4dfa200972681">file::Defaults</a>()),</div>
|
|
<div class="line"><a id="l00097" name="l00097"></a><span class="lineno"> 97</span> expected_num_records);</div>
|
|
<div class="line"><a id="l00098" name="l00098"></a><span class="lineno"> 98</span>}</div>
|
|
<div class="line"><a id="l00099" name="l00099"></a><span class="lineno"> 99</span>} <span class="comment">// namespace internal</span></div>
|
|
<div class="line"><a id="l00100" name="l00100"></a><span class="lineno"> 100</span> </div>
|
|
<div class="line"><a id="l00101" name="l00101"></a><span class="lineno"> 101</span><span class="comment">// Reads all records in Proto format in 'file'. Silently does nothing if the</span></div>
|
|
<div class="line"><a id="l00102" name="l00102"></a><span class="lineno"> 102</span><span class="comment">// file is empty. Dies if the file doesn't exist or contains something else than</span></div>
|
|
<div class="line"><a id="l00103" name="l00103"></a><span class="lineno"> 103</span><span class="comment">// protos encoded in RecordIO format.</span></div>
|
|
<div class="line"><a id="l00104" name="l00104"></a><span class="lineno"> 104</span><span class="keyword">template</span> <<span class="keyword">typename</span> Proto></div>
|
|
<div class="line"><a id="l00105" name="l00105"></a><span class="lineno"><a class="line" href="namespaceoperations__research.html#ac9031f8daeb1d1211d7524835aaac549"> 105</a></span>std::vector<Proto> <a class="code hl_function" href="namespaceoperations__research.html#ac9031f8daeb1d1211d7524835aaac549">ReadAllRecordsOrDie</a>(absl::string_view filename) {</div>
|
|
<div class="line"><a id="l00106" name="l00106"></a><span class="lineno"> 106</span> <span class="keywordflow">return</span> internal::ReadNumRecords<Proto>(filename, -1);</div>
|
|
<div class="line"><a id="l00107" name="l00107"></a><span class="lineno"> 107</span>}</div>
|
|
<div class="line"><a id="l00108" name="l00108"></a><span class="lineno"> 108</span><span class="keyword">template</span> <<span class="keyword">typename</span> Proto></div>
|
|
<div class="line"><a id="l00109" name="l00109"></a><span class="lineno"><a class="line" href="namespaceoperations__research.html#a0f3f24e096bca7cd6c901f048a1cf61d"> 109</a></span>std::vector<Proto> <a class="code hl_function" href="namespaceoperations__research.html#ac9031f8daeb1d1211d7524835aaac549">ReadAllRecordsOrDie</a>(<a class="code hl_class" href="class_file.html">File</a>* <a class="code hl_namespace" href="namespacefile.html">file</a>) {</div>
|
|
<div class="line"><a id="l00110" name="l00110"></a><span class="lineno"> 110</span> <span class="keywordflow">return</span> internal::ReadNumRecords<Proto>(<a class="code hl_namespace" href="namespacefile.html">file</a>, -1);</div>
|
|
<div class="line"><a id="l00111" name="l00111"></a><span class="lineno"> 111</span>}</div>
|
|
<div class="line"><a id="l00112" name="l00112"></a><span class="lineno"> 112</span> </div>
|
|
<div class="line"><a id="l00113" name="l00113"></a><span class="lineno"> 113</span><span class="comment">// Reads one record from file, which must be in RecordIO binary proto format.</span></div>
|
|
<div class="line"><a id="l00114" name="l00114"></a><span class="lineno"> 114</span><span class="comment">// Dies if the file can't be read, doesn't contain exactly one record, or</span></div>
|
|
<div class="line"><a id="l00115" name="l00115"></a><span class="lineno"> 115</span><span class="comment">// contains something else than the expected proto in RecordIO format.</span></div>
|
|
<div class="line"><a id="l00116" name="l00116"></a><span class="lineno"> 116</span><span class="keyword">template</span> <<span class="keyword">typename</span> Proto></div>
|
|
<div class="line"><a id="l00117" name="l00117"></a><span class="lineno"><a class="line" href="namespaceoperations__research.html#ace54bf84f7270aae9477ad57dcf7ce59"> 117</a></span>Proto <a class="code hl_function" href="namespaceoperations__research.html#ace54bf84f7270aae9477ad57dcf7ce59">ReadOneRecordOrDie</a>(absl::string_view filename) {</div>
|
|
<div class="line"><a id="l00118" name="l00118"></a><span class="lineno"> 118</span> Proto p;</div>
|
|
<div class="line"><a id="l00119" name="l00119"></a><span class="lineno"> 119</span> p.Swap(&internal::ReadNumRecords<Proto>(filename, 1)[0]);</div>
|
|
<div class="line"><a id="l00120" name="l00120"></a><span class="lineno"> 120</span> <span class="keywordflow">return</span> p;</div>
|
|
<div class="line"><a id="l00121" name="l00121"></a><span class="lineno"> 121</span>}</div>
|
|
<div class="line"><a id="l00122" name="l00122"></a><span class="lineno"> 122</span> </div>
|
|
<div class="line"><a id="l00123" name="l00123"></a><span class="lineno"> 123</span><span class="comment">// Writes all records in Proto format to 'file'. Dies if it is unable to open</span></div>
|
|
<div class="line"><a id="l00124" name="l00124"></a><span class="lineno"> 124</span><span class="comment">// the file or write to it.</span></div>
|
|
<div class="line"><a id="l00125" name="l00125"></a><span class="lineno"> 125</span><span class="keyword">template</span> <<span class="keyword">typename</span> Proto></div>
|
|
<div class="line"><a id="l00126" name="l00126"></a><span class="lineno"><a class="line" href="namespaceoperations__research.html#a6b3cadabb0e5354ea2730e10401427f5"> 126</a></span><span class="keywordtype">void</span> <a class="code hl_function" href="namespaceoperations__research.html#a6b3cadabb0e5354ea2730e10401427f5">WriteRecordsOrDie</a>(absl::string_view filename,</div>
|
|
<div class="line"><a id="l00127" name="l00127"></a><span class="lineno"> 127</span> <span class="keyword">const</span> std::vector<Proto>& protos) {</div>
|
|
<div class="line"><a id="l00128" name="l00128"></a><span class="lineno"> 128</span> <a class="code hl_class" href="classrecordio_1_1_record_writer.html">recordio::RecordWriter</a> writer(</div>
|
|
<div class="line"><a id="l00129" name="l00129"></a><span class="lineno"> 129</span> <a class="code hl_function" href="namespacefile.html#a38270c9b9606599c428aad7d942ba033">file::OpenOrDie</a>(filename, <span class="stringliteral">"w"</span>, <a class="code hl_function" href="namespacefile.html#a1abdf766bb120d38e7a4dfa200972681">file::Defaults</a>()));</div>
|
|
<div class="line"><a id="l00130" name="l00130"></a><span class="lineno"> 130</span> <span class="keywordflow">for</span> (<span class="keyword">const</span> Proto& <a class="code hl_variable" href="cp__model__fz__solver_8cc.html#aed003f5eb5197bc586b7ef2c36a63da2">proto</a> : protos) {</div>
|
|
<div class="line"><a id="l00131" name="l00131"></a><span class="lineno"> 131</span> <a class="code hl_define" href="base_2logging_8h.html#a3e1cfef60e774a81f30eaddf26a3a274">CHECK</a>(writer.<a class="code hl_function" href="classrecordio_1_1_record_writer.html#af6c3f5b6e7950cfdda469c66f4d825e8">WriteProtocolMessage</a>(<a class="code hl_variable" href="cp__model__fz__solver_8cc.html#aed003f5eb5197bc586b7ef2c36a63da2">proto</a>));</div>
|
|
<div class="line"><a id="l00132" name="l00132"></a><span class="lineno"> 132</span> }</div>
|
|
<div class="line"><a id="l00133" name="l00133"></a><span class="lineno"> 133</span> <a class="code hl_define" href="base_2logging_8h.html#a3e1cfef60e774a81f30eaddf26a3a274">CHECK</a>(writer.<a class="code hl_function" href="classrecordio_1_1_record_writer.html#aef7e3d18ef267f23f64ad397fa359cc1">Close</a>());</div>
|
|
<div class="line"><a id="l00134" name="l00134"></a><span class="lineno"> 134</span>}</div>
|
|
<div class="line"><a id="l00135" name="l00135"></a><span class="lineno"> 135</span> </div>
|
|
<div class="line"><a id="l00136" name="l00136"></a><span class="lineno"> 136</span>} <span class="comment">// namespace operations_research</span></div>
|
|
<div class="line"><a id="l00137" name="l00137"></a><span class="lineno"> 137</span> </div>
|
|
<div class="line"><a id="l00138" name="l00138"></a><span class="lineno"> 138</span><span class="preprocessor">#endif </span><span class="comment">// OR_TOOLS_UTIL_FILE_UTIL_H_</span></div>
|
|
<div class="ttc" id="abase_2file_8h_html"><div class="ttname"><a href="base_2file_8h.html">file.h</a></div></div>
|
|
<div class="ttc" id="abase_2logging_8h_html_a3e1cfef60e774a81f30eaddf26a3a274"><div class="ttname"><a href="base_2logging_8h.html#a3e1cfef60e774a81f30eaddf26a3a274">CHECK</a></div><div class="ttdeci">#define CHECK(condition)</div><div class="ttdef"><b>Definition:</b> <a href="base_2logging_8h_source.html#l00491">base/logging.h:491</a></div></div>
|
|
<div class="ttc" id="abase_2logging_8h_html_a7c0ce053b28d53aa4eaf3eb7fb71663b"><div class="ttname"><a href="base_2logging_8h.html#a7c0ce053b28d53aa4eaf3eb7fb71663b">CHECK_EQ</a></div><div class="ttdeci">#define CHECK_EQ(val1, val2)</div><div class="ttdef"><b>Definition:</b> <a href="base_2logging_8h_source.html#l00698">base/logging.h:698</a></div></div>
|
|
<div class="ttc" id="aclass_file_html"><div class="ttname"><a href="class_file.html">File</a></div><div class="ttdef"><b>Definition:</b> <a href="base_2file_8h_source.html#l00032">base/file.h:32</a></div></div>
|
|
<div class="ttc" id="aclassrecordio_1_1_record_reader_html"><div class="ttname"><a href="classrecordio_1_1_record_reader.html">recordio::RecordReader</a></div><div class="ttdef"><b>Definition:</b> <a href="recordio_8h_source.html#l00086">recordio.h:86</a></div></div>
|
|
<div class="ttc" id="aclassrecordio_1_1_record_reader_html_aef7e3d18ef267f23f64ad397fa359cc1"><div class="ttname"><a href="classrecordio_1_1_record_reader.html#aef7e3d18ef267f23f64ad397fa359cc1">recordio::RecordReader::Close</a></div><div class="ttdeci">bool Close()</div><div class="ttdef"><b>Definition:</b> <a href="recordio_8cc_source.html#l00054">recordio.cc:54</a></div></div>
|
|
<div class="ttc" id="aclassrecordio_1_1_record_reader_html_aefd9688ad8e40608a91e2189aed986b5"><div class="ttname"><a href="classrecordio_1_1_record_reader.html#aefd9688ad8e40608a91e2189aed986b5">recordio::RecordReader::ReadProtocolMessage</a></div><div class="ttdeci">bool ReadProtocolMessage(P *const proto)</div><div class="ttdef"><b>Definition:</b> <a href="recordio_8h_source.html#l00091">recordio.h:91</a></div></div>
|
|
<div class="ttc" id="aclassrecordio_1_1_record_writer_html"><div class="ttname"><a href="classrecordio_1_1_record_writer.html">recordio::RecordWriter</a></div><div class="ttdef"><b>Definition:</b> <a href="recordio_8h_source.html#l00033">recordio.h:33</a></div></div>
|
|
<div class="ttc" id="aclassrecordio_1_1_record_writer_html_aef7e3d18ef267f23f64ad397fa359cc1"><div class="ttname"><a href="classrecordio_1_1_record_writer.html#aef7e3d18ef267f23f64ad397fa359cc1">recordio::RecordWriter::Close</a></div><div class="ttdeci">bool Close()</div><div class="ttdef"><b>Definition:</b> <a href="recordio_8cc_source.html#l00029">recordio.cc:29</a></div></div>
|
|
<div class="ttc" id="aclassrecordio_1_1_record_writer_html_af6c3f5b6e7950cfdda469c66f4d825e8"><div class="ttname"><a href="classrecordio_1_1_record_writer.html#af6c3f5b6e7950cfdda469c66f4d825e8">recordio::RecordWriter::WriteProtocolMessage</a></div><div class="ttdeci">bool WriteProtocolMessage(const P &proto)</div><div class="ttdef"><b>Definition:</b> <a href="recordio_8h_source.html#l00041">recordio.h:41</a></div></div>
|
|
<div class="ttc" id="acp__model__fz__solver_8cc_html_aed003f5eb5197bc586b7ef2c36a63da2"><div class="ttname"><a href="cp__model__fz__solver_8cc.html#aed003f5eb5197bc586b7ef2c36a63da2">proto</a></div><div class="ttdeci">CpModelProto proto</div><div class="ttdef"><b>Definition:</b> <a href="cp__model__fz__solver_8cc_source.html#l00115">cp_model_fz_solver.cc:115</a></div></div>
|
|
<div class="ttc" id="anamespacefile_html"><div class="ttname"><a href="namespacefile.html">file</a></div><div class="ttdef"><b>Definition:</b> <a href="base_2file_8cc_source.html#l00141">base/file.cc:141</a></div></div>
|
|
<div class="ttc" id="anamespacefile_html_a1abdf766bb120d38e7a4dfa200972681"><div class="ttname"><a href="namespacefile.html#a1abdf766bb120d38e7a4dfa200972681">file::Defaults</a></div><div class="ttdeci">int Defaults()</div><div class="ttdef"><b>Definition:</b> <a href="base_2file_8h_source.html#l00119">base/file.h:119</a></div></div>
|
|
<div class="ttc" id="anamespacefile_html_a38270c9b9606599c428aad7d942ba033"><div class="ttname"><a href="namespacefile.html#a38270c9b9606599c428aad7d942ba033">file::OpenOrDie</a></div><div class="ttdeci">File * OpenOrDie(const absl::string_view &filename, const absl::string_view &mode, int flags)</div><div class="ttdef"><b>Definition:</b> <a href="base_2file_8cc_source.html#l00154">base/file.cc:154</a></div></div>
|
|
<div class="ttc" id="anamespaceinternal_html"><div class="ttname"><a href="namespaceinternal.html">internal</a></div><div class="ttdef"><b>Definition:</b> <a href="bop__parameters_8pb_8h_source.html#l00039">bop_parameters.pb.h:39</a></div></div>
|
|
<div class="ttc" id="anamespaceoperations__research_1_1internal_html_a69fdb007201984e0caf5498e5a05490f"><div class="ttname"><a href="namespaceoperations__research_1_1internal.html#a69fdb007201984e0caf5498e5a05490f">operations_research::internal::ReadNumRecords</a></div><div class="ttdeci">std::vector< Proto > ReadNumRecords(File *file, int expected_num_records)</div><div class="ttdef"><b>Definition:</b> <a href="file__util_8h_source.html#l00067">file_util.h:67</a></div></div>
|
|
<div class="ttc" id="anamespaceoperations__research_html"><div class="ttname"><a href="namespaceoperations__research.html">operations_research</a></div><div class="ttdoc">Collection of objects used to extend the Constraint Solver library.</div><div class="ttdef"><b>Definition:</b> <a href="dense__doubly__linked__list_8h_source.html#l00021">dense_doubly_linked_list.h:21</a></div></div>
|
|
<div class="ttc" id="anamespaceoperations__research_html_a0512869fd2f9e687199df5ceb9d04859"><div class="ttname"><a href="namespaceoperations__research.html#a0512869fd2f9e687199df5ceb9d04859">operations_research::ReadFileToProtoOrDie</a></div><div class="ttdeci">Proto ReadFileToProtoOrDie(absl::string_view filename)</div><div class="ttdef"><b>Definition:</b> <a href="file__util_8h_source.html#l00041">file_util.h:41</a></div></div>
|
|
<div class="ttc" id="anamespaceoperations__research_html_a319f5b5c935d6fb479624ae04d60d5ea"><div class="ttname"><a href="namespaceoperations__research.html#a319f5b5c935d6fb479624ae04d60d5ea">operations_research::ReadFileToString</a></div><div class="ttdeci">absl::StatusOr< std::string > ReadFileToString(absl::string_view filename)</div><div class="ttdef"><b>Definition:</b> <a href="file__util_8cc_source.html#l00034">file_util.cc:34</a></div></div>
|
|
<div class="ttc" id="anamespaceoperations__research_html_a57741d0280e266642d7d146d0d0beedb"><div class="ttname"><a href="namespaceoperations__research.html#a57741d0280e266642d7d146d0d0beedb">operations_research::WriteProtoToFile</a></div><div class="ttdeci">bool WriteProtoToFile(absl::string_view filename, const google::protobuf::Message &proto, ProtoWriteFormat proto_write_format, bool gzipped, bool append_extension_to_file_name)</div><div class="ttdef"><b>Definition:</b> <a href="file__util_8cc_source.html#l00106">file_util.cc:106</a></div></div>
|
|
<div class="ttc" id="anamespaceoperations__research_html_a6b3cadabb0e5354ea2730e10401427f5"><div class="ttname"><a href="namespaceoperations__research.html#a6b3cadabb0e5354ea2730e10401427f5">operations_research::WriteRecordsOrDie</a></div><div class="ttdeci">void WriteRecordsOrDie(absl::string_view filename, const std::vector< Proto > &protos)</div><div class="ttdef"><b>Definition:</b> <a href="file__util_8h_source.html#l00126">file_util.h:126</a></div></div>
|
|
<div class="ttc" id="anamespaceoperations__research_html_aaf9694f57960ede8c406e3bd923bcd72"><div class="ttname"><a href="namespaceoperations__research.html#aaf9694f57960ede8c406e3bd923bcd72">operations_research::ProtoWriteFormat</a></div><div class="ttdeci">ProtoWriteFormat</div><div class="ttdef"><b>Definition:</b> <a href="file__util_8h_source.html#l00050">file_util.h:50</a></div></div>
|
|
<div class="ttc" id="anamespaceoperations__research_html_aaf9694f57960ede8c406e3bd923bcd72a319f3b99b8d96c21e2f6b7ebc6fe8d8f"><div class="ttname"><a href="namespaceoperations__research.html#aaf9694f57960ede8c406e3bd923bcd72a319f3b99b8d96c21e2f6b7ebc6fe8d8f">operations_research::ProtoWriteFormat::kJson</a></div><div class="ttdeci">@ kJson</div></div>
|
|
<div class="ttc" id="anamespaceoperations__research_html_aaf9694f57960ede8c406e3bd923bcd72aa0af2ac06be96f6784af5295aab62c76"><div class="ttname"><a href="namespaceoperations__research.html#aaf9694f57960ede8c406e3bd923bcd72aa0af2ac06be96f6784af5295aab62c76">operations_research::ProtoWriteFormat::kProtoBinary</a></div><div class="ttdeci">@ kProtoBinary</div></div>
|
|
<div class="ttc" id="anamespaceoperations__research_html_aaf9694f57960ede8c406e3bd923bcd72adb5cce9ced76fea1f9c1e9f3e5cb1d90"><div class="ttname"><a href="namespaceoperations__research.html#aaf9694f57960ede8c406e3bd923bcd72adb5cce9ced76fea1f9c1e9f3e5cb1d90">operations_research::ProtoWriteFormat::kCanonicalJson</a></div><div class="ttdeci">@ kCanonicalJson</div></div>
|
|
<div class="ttc" id="anamespaceoperations__research_html_aaf9694f57960ede8c406e3bd923bcd72adfcd8e748f506324dff6a9d5e7aea00b"><div class="ttname"><a href="namespaceoperations__research.html#aaf9694f57960ede8c406e3bd923bcd72adfcd8e748f506324dff6a9d5e7aea00b">operations_research::ProtoWriteFormat::kProtoText</a></div><div class="ttdeci">@ kProtoText</div></div>
|
|
<div class="ttc" id="anamespaceoperations__research_html_ac9031f8daeb1d1211d7524835aaac549"><div class="ttname"><a href="namespaceoperations__research.html#ac9031f8daeb1d1211d7524835aaac549">operations_research::ReadAllRecordsOrDie</a></div><div class="ttdeci">std::vector< Proto > ReadAllRecordsOrDie(absl::string_view filename)</div><div class="ttdef"><b>Definition:</b> <a href="file__util_8h_source.html#l00105">file_util.h:105</a></div></div>
|
|
<div class="ttc" id="anamespaceoperations__research_html_ac9d6b171922e3bb93b3795f4241c70e4"><div class="ttname"><a href="namespaceoperations__research.html#ac9d6b171922e3bb93b3795f4241c70e4">operations_research::ReadFileToProto</a></div><div class="ttdeci">bool ReadFileToProto(absl::string_view filename, google::protobuf::Message *proto)</div><div class="ttdef"><b>Definition:</b> <a href="file__util_8cc_source.html#l00045">file_util.cc:45</a></div></div>
|
|
<div class="ttc" id="anamespaceoperations__research_html_ace54bf84f7270aae9477ad57dcf7ce59"><div class="ttname"><a href="namespaceoperations__research.html#ace54bf84f7270aae9477ad57dcf7ce59">operations_research::ReadOneRecordOrDie</a></div><div class="ttdeci">Proto ReadOneRecordOrDie(absl::string_view filename)</div><div class="ttdef"><b>Definition:</b> <a href="file__util_8h_source.html#l00117">file_util.h:117</a></div></div>
|
|
<div class="ttc" id="arecordio_8h_html"><div class="ttname"><a href="recordio_8h.html">recordio.h</a></div></div>
|
|
</div><!-- fragment --></div><!-- contents -->
|
|
</div><!-- doc-content -->
|
|
<!-- HTML footer for doxygen 1.8.18-->
|
|
<!-- start footer part -->
|
|
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
|
|
<ul>
|
|
<li class="navelem"><a class="el" href="dir_a7cc1eeded8f693d0da6c729bc88c45a.html">ortools</a></li><li class="navelem"><a class="el" href="dir_a3328a0ea67a2aaa160c2783ffbaa5dc.html">util</a></li><li class="navelem"><a class="el" href="file__util_8h.html">file_util.h</a></li>
|
|
<li class="footer">Generated by
|
|
<a href="http://www.doxygen.org/index.html">
|
|
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.9.2 </li>
|
|
</ul>
|
|
</div>
|
|
</body>
|
|
</html>
|