You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
<trid="row_0_6_"><tdclass="entry"><spanstyle="width:32px;display:inline-block;"> </span><spanclass="icona"><spanclass="icon">C</span></span><aclass="el" href="classjinja2_1_1_generic_map.html" target="_self">GenericMap</a></td><tdclass="desc">Helper class for accessing maps specified by the <aclass="el" href="structjinja2_1_1_map_item_accessor.html">MapItemAccessor</a> interface </td></tr>
<trid="row_0_12_"><tdclass="entry"><spanstyle="width:32px;display:inline-block;"> </span><spanclass="icona"><spanclass="icon">C</span></span><aclass="el" href="structjinja2_1_1_map_item_accessor.html" target="_self">MapItemAccessor</a></td><tdclass="desc">Interface to the generic dictionary type which maps string to some value </td></tr>
<trid="row_0_13_" class="even"><tdclass="entry"><spanstyle="width:32px;display:inline-block;"> </span><spanclass="icona"><spanclass="icon">C</span></span><aclass="el" href="classjinja2_1_1_memory_file_system.html" target="_self">MemoryFileSystem</a></td><tdclass="desc">Filesystem handler for files stored in memory </td></tr>
128
+
<trid="row_0_14_"><tdclass="entry"><spanstyle="width:32px;display:inline-block;"> </span><spanclass="icona"><spanclass="icon">C</span></span><aclass="el" href="classjinja2_1_1_real_file_system.html" target="_self">RealFileSystem</a></td><tdclass="desc">Filesystem handler for files stored on the filesystem </td></tr>
Copy file name to clipboardExpand all lines: docs/reference/1.0/html/classjinja2_1_1_i_filesystem_handler-members.html
+4-3Lines changed: 4 additions & 3 deletions
Original file line number
Diff line number
Diff line change
@@ -101,9 +101,10 @@
101
101
102
102
<p>This is the complete list of members for <aclass="el" href="classjinja2_1_1_i_filesystem_handler.html">jinja2::IFilesystemHandler</a>, including all inherited members.</p>
<areahref="classjinja2_1_1_memory_file_system.html" title="Filesystem handler for files stored in memory." alt="jinja2::MemoryFileSystem" shape="rect" coords="0,56,155,80"/>
116
+
<areahref="classjinja2_1_1_real_file_system.html" title="Filesystem handler for files stored on the filesystem." alt="jinja2::RealFileSystem" shape="rect" coords="165,56,320,80"/>
<trclass="memdesc:ab20beae340570f352193bd12819d8efd"><tdclass="mdescLeft"> </td><tdclass="mdescRight">Method is called to open the file with the specified name in 'narrow-char' mode. <ahref="classjinja2_1_1_i_filesystem_handler.html#ab20beae340570f352193bd12819d8efd">More...</a><br/></td></tr>
<trclass="memdesc:a76b088ac5bcff7ecd673b45ef59906cb"><tdclass="mdescLeft"> </td><tdclass="mdescRight">Method is called to open the file with the specified name in 'wide-char' mode. <ahref="classjinja2_1_1_i_filesystem_handler.html#a76b088ac5bcff7ecd673b45ef59906cb">More...</a><br/></td></tr>
<trclass="memdesc:a9bceaeb724626d1f9055e5be8ee5cc9f"><tdclass="mdescLeft"> </td><tdclass="mdescRight">Method is called to obtain the modification date of the specified file (if applicable) <ahref="classjinja2_1_1_i_filesystem_handler.html#a9bceaeb724626d1f9055e5be8ee5cc9f">More...</a><br/></td></tr>
<divclass="textblock"><p>Generic interface to filesystem handlers (loaders) </p>
137
+
<p>This interface should be implemented in order to provide custom file system handler. Interface provides most-common methods which are called by the template environment to load the particular template. <code>OpenStream</code> methods return the unique pointer to the generic <code>istream</code> object implementation. So, the exact type (ex. <code>ifstream</code>, <code>istringstream</code> etc.) of input stream is unspecified. In order to delete stream object correctly returned pointer provide the custom deleter which should properly delete the stream object. </p>
138
+
</div><h2class="groupheader">Constructor & Destructor Documentation</h2>
<p>Method is called to obtain the modification date of the specified file (if applicable) </p>
192
+
<p>If the underlaying filesystem supports retrival of the last modification date of the file this method should return this date when called. In other case it should return the empty optional object. Main purpose of this method is to help templates loader to determine the necessity of cached template reload</p>
193
+
<dlclass="params"><dt>Parameters</dt><dd>
194
+
<tableclass="params">
195
+
<tr><tdclass="paramname">name</td><td>Name of the file to get the last modification date </td></tr>
196
+
</table>
197
+
</dd>
198
+
</dl>
199
+
<dlclass="section return"><dt>Returns</dt><dd>Last modification date (if applicable) or empty optional object otherwise </dd></dl>
200
+
201
+
<p>Implemented in <aclass="el" href="classjinja2_1_1_real_file_system.html#a5c0ceaf6dbc6dd19875107431f77e528">jinja2::RealFileSystem</a>, and <aclass="el" href="classjinja2_1_1_memory_file_system.html#aa2552ba005db25f41d4c7b3d589d3092">jinja2::MemoryFileSystem</a>.</p>
<p>Method is called to open the file with the specified name in 'narrow-char' mode. </p>
230
+
<p>Method should return unique pointer to the std::istream object with custom deleter (<aclass="el" href="namespacejinja2.html#ab5d363d70df829219a7b5652328977c6">CharFileStreamPtr</a>) . Deleter should properly delete pointee stream object.</p>
231
+
<dlclass="params"><dt>Parameters</dt><dd>
232
+
<tableclass="params">
233
+
<tr><tdclass="paramname">name</td><td>Name of the file to open </td></tr>
234
+
</table>
235
+
</dd>
236
+
</dl>
237
+
<dlclass="section return"><dt>Returns</dt><dd>Opened stream object or empty pointer in case of any error </dd></dl>
238
+
177
239
<p>Implemented in <aclass="el" href="classjinja2_1_1_real_file_system.html#aa92284a328d2adfa13ef05049862b284">jinja2::RealFileSystem</a>, and <aclass="el" href="classjinja2_1_1_memory_file_system.html#aef0bb8aecde68e0aeff2e530461d39b8">jinja2::MemoryFileSystem</a>.</p>
<p>Method is called to open the file with the specified name in 'wide-char' mode. </p>
268
+
<p>Method should return unique pointer to the std::wistream object with custom deleter (<aclass="el" href="namespacejinja2.html#ad07d25b586e095c48d73b504a49d4697">WCharFileStreamPtr</a>) . Deleter should properly delete pointee stream object.</p>
269
+
<dlclass="params"><dt>Parameters</dt><dd>
270
+
<tableclass="params">
271
+
<tr><tdclass="paramname">name</td><td>Name of the file to open </td></tr>
272
+
</table>
273
+
</dd>
274
+
</dl>
275
+
<dlclass="section return"><dt>Returns</dt><dd>Opened stream object or empty pointer in case of any error </dd></dl>
276
+
205
277
<p>Implemented in <aclass="el" href="classjinja2_1_1_real_file_system.html#ae463b6ab90e75c2bd5f540347ff91f9f">jinja2::RealFileSystem</a>, and <aclass="el" href="classjinja2_1_1_memory_file_system.html#a008a9a04f0961215e0cbc5d739d2df7f">jinja2::MemoryFileSystem</a>.</p>
0 commit comments