<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://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"/>
<title>Kyoto Cabinet: kyotocabinet::StashDB::Cursor Class Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<link href="doxygen.css" rel="stylesheet" type="text/css"/>
</head>
<body>
<!-- Generated by Doxygen 1.6.3 -->
<div class="navigation" id="top">
<div class="tabs">
<ul>
<li><a href="index.html"><span>Main Page</span></a></li>
<li><a href="namespaces.html"><span>Namespaces</span></a></li>
<li class="current"><a href="annotated.html"><span>Classes</span></a></li>
<li><a href="files.html"><span>Files</span></a></li>
</ul>
</div>
<div class="tabs">
<ul>
<li><a href="annotated.html"><span>Class List</span></a></li>
<li><a href="classes.html"><span>Class Index</span></a></li>
<li><a href="hierarchy.html"><span>Class Hierarchy</span></a></li>
<li><a href="functions.html"><span>Class Members</span></a></li>
</ul>
</div>
<div class="navpath"><a class="el" href="namespacekyotocabinet.html">kyotocabinet</a>::<a class="el" href="classkyotocabinet_1_1StashDB.html">StashDB</a>::<a class="el" href="classkyotocabinet_1_1StashDB_1_1Cursor.html">Cursor</a>
</div>
</div>
<div class="contents">
<h1>kyotocabinet::StashDB::Cursor Class Reference</h1><!-- doxytag: class="kyotocabinet::StashDB::Cursor" --><!-- doxytag: inherits="kyotocabinet::BasicDB::Cursor" -->
<p><a class="el" href="classkyotocabinet_1_1StashDB_1_1Cursor.html" title="Cursor to indicate a record.">Cursor</a> to indicate a record.
<a href="#_details">More...</a></p>
<p><code>#include <kcstashdb.h></code></p>
<p><a href="classkyotocabinet_1_1StashDB_1_1Cursor-members.html">List of all members.</a></p>
<table border="0" cellpadding="0" cellspacing="0">
<tr><td colspan="2"><h2>Public Member Functions</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classkyotocabinet_1_1StashDB_1_1Cursor.html#a9afd9e84a6287ee0b4feccfd8b940796">Cursor</a> (<a class="el" href="classkyotocabinet_1_1StashDB.html">StashDB</a> *db)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Constructor. <a href="#a9afd9e84a6287ee0b4feccfd8b940796"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">virtual </td><td class="memItemRight" valign="bottom"><a class="el" href="classkyotocabinet_1_1StashDB_1_1Cursor.html#a8cee3c9907e5b73b9fd8ac18c728d2dd">~Cursor</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Destructor. <a href="#a8cee3c9907e5b73b9fd8ac18c728d2dd"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classkyotocabinet_1_1StashDB_1_1Cursor.html#a8c9818921e87c83e6a77d6d899ce85d3">accept</a> (<a class="el" href="classkyotocabinet_1_1DB_1_1Visitor.html">Visitor</a> *visitor, bool writable=true, bool step=false)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Accept a visitor to the current record. <a href="#a8c9818921e87c83e6a77d6d899ce85d3"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classkyotocabinet_1_1StashDB_1_1Cursor.html#a0667e42f84b7e299f90bcb10da96adfa">jump</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Jump the cursor to the first record for forward scan. <a href="#a0667e42f84b7e299f90bcb10da96adfa"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classkyotocabinet_1_1StashDB_1_1Cursor.html#aa2ae671d99e8938904aaf656cf13e04e">jump</a> (const char *kbuf, size_t ksiz)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Jump the cursor to a record for forward scan. <a href="#aa2ae671d99e8938904aaf656cf13e04e"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classkyotocabinet_1_1StashDB_1_1Cursor.html#a64e245b6339bad59db318933b35447e9">jump</a> (const std::string &key)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Jump the cursor to a record for forward scan. <a href="#a64e245b6339bad59db318933b35447e9"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classkyotocabinet_1_1StashDB_1_1Cursor.html#adf5a30f1405d7e3d47dea9874ca9ed7c">jump_back</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Jump the cursor to the last record for backward scan. <a href="#adf5a30f1405d7e3d47dea9874ca9ed7c"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classkyotocabinet_1_1StashDB_1_1Cursor.html#ab440dcb632e1525ab909adee470ac20d">jump_back</a> (const char *kbuf, size_t ksiz)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Jump the cursor to a record for backward scan. <a href="#ab440dcb632e1525ab909adee470ac20d"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classkyotocabinet_1_1StashDB_1_1Cursor.html#a50fef5f2945b3576acbbd3c80e2c5112">jump_back</a> (const std::string &key)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Jump the cursor to a record for backward scan. <a href="#a50fef5f2945b3576acbbd3c80e2c5112"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classkyotocabinet_1_1StashDB_1_1Cursor.html#a9ed7c428eccf0b70588301104c677e11">step</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Step the cursor to the next record. <a href="#a9ed7c428eccf0b70588301104c677e11"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classkyotocabinet_1_1StashDB_1_1Cursor.html#aafe8e849fea3ce4d8157f12ea0bb42cc">step_back</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Step the cursor to the previous record. <a href="#aafe8e849fea3ce4d8157f12ea0bb42cc"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="classkyotocabinet_1_1StashDB.html">StashDB</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="classkyotocabinet_1_1StashDB_1_1Cursor.html#a5e8436056db9fc5d20c643a745a606ac">db</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Get the database object. <a href="#a5e8436056db9fc5d20c643a745a606ac"></a><br/></td></tr>
<tr><td colspan="2"><h2>Friends</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="aa70c407bb7b33def2a7bce9eb2bfb6e4"></a><!-- doxytag: member="kyotocabinet::StashDB::Cursor::StashDB" ref="aa70c407bb7b33def2a7bce9eb2bfb6e4" args="" -->
class </td><td class="memItemRight" valign="bottom"><b>StashDB</b></td></tr>
</table>
<hr/><a name="_details"></a><h2>Detailed Description</h2>
<p><a class="el" href="classkyotocabinet_1_1StashDB_1_1Cursor.html" title="Cursor to indicate a record.">Cursor</a> to indicate a record. </p>
<hr/><h2>Constructor & Destructor Documentation</h2>
<a class="anchor" id="a9afd9e84a6287ee0b4feccfd8b940796"></a><!-- doxytag: member="kyotocabinet::StashDB::Cursor::Cursor" ref="a9afd9e84a6287ee0b4feccfd8b940796" args="(StashDB *db)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">kyotocabinet::StashDB::Cursor::Cursor </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classkyotocabinet_1_1StashDB.html">StashDB</a> * </td>
<td class="paramname"> <em>db</em></td>
<td> ) </td>
<td><code> [explicit]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Constructor. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>db</em> </td><td>the container database object. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="a8cee3c9907e5b73b9fd8ac18c728d2dd"></a><!-- doxytag: member="kyotocabinet::StashDB::Cursor::~Cursor" ref="a8cee3c9907e5b73b9fd8ac18c728d2dd" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual kyotocabinet::StashDB::Cursor::~Cursor </td>
<td>(</td>
<td class="paramname"></td>
<td> ) </td>
<td><code> [virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Destructor. </p>
<p>Reimplemented from <a class="el" href="classkyotocabinet_1_1BasicDB_1_1Cursor.html#a0e93160f1599c0063b6db4226216cfb3">kyotocabinet::BasicDB::Cursor</a>.</p>
</div>
</div>
<hr/><h2>Member Function Documentation</h2>
<a class="anchor" id="a8c9818921e87c83e6a77d6d899ce85d3"></a><!-- doxytag: member="kyotocabinet::StashDB::Cursor::accept" ref="a8c9818921e87c83e6a77d6d899ce85d3" args="(Visitor *visitor, bool writable=true, bool step=false)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool kyotocabinet::StashDB::Cursor::accept </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classkyotocabinet_1_1DB_1_1Visitor.html">Visitor</a> * </td>
<td class="paramname"> <em>visitor</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">bool </td>
<td class="paramname"> <em>writable</em> = <code>true</code>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">bool </td>
<td class="paramname"> <em>step</em> = <code>false</code></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td><code> [virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Accept a visitor to the current record. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>visitor</em> </td><td>a visitor object. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>writable</em> </td><td>true for writable operation, or false for read-only operation. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>step</em> </td><td>true to move the cursor to the next record, or false for no move. </td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>true on success, or false on failure. </dd></dl>
<dl class="note"><dt><b>Note:</b></dt><dd>The operation for each record is performed atomically and other threads accessing the same record are blocked. To avoid deadlock, any database operation must not be performed in this function. </dd></dl>
<p>Implements <a class="el" href="classkyotocabinet_1_1DB_1_1Cursor.html#af19b3472aeec03686a074dae416c8ed3">kyotocabinet::DB::Cursor</a>.</p>
</div>
</div>
<a class="anchor" id="a0667e42f84b7e299f90bcb10da96adfa"></a><!-- doxytag: member="kyotocabinet::StashDB::Cursor::jump" ref="a0667e42f84b7e299f90bcb10da96adfa" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool kyotocabinet::StashDB::Cursor::jump </td>
<td>(</td>
<td class="paramname"></td>
<td> ) </td>
<td><code> [virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Jump the cursor to the first record for forward scan. </p>
<dl class="return"><dt><b>Returns:</b></dt><dd>true on success, or false on failure. </dd></dl>
<p>Implements <a class="el" href="classkyotocabinet_1_1DB_1_1Cursor.html#a9b7e9982b948d66a4d2a0295229ac4c1">kyotocabinet::DB::Cursor</a>.</p>
</div>
</div>
<a class="anchor" id="aa2ae671d99e8938904aaf656cf13e04e"></a><!-- doxytag: member="kyotocabinet::StashDB::Cursor::jump" ref="aa2ae671d99e8938904aaf656cf13e04e" args="(const char *kbuf, size_t ksiz)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool kyotocabinet::StashDB::Cursor::jump </td>
<td>(</td>
<td class="paramtype">const char * </td>
<td class="paramname"> <em>kbuf</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">size_t </td>
<td class="paramname"> <em>ksiz</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td><code> [virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Jump the cursor to a record for forward scan. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>kbuf</em> </td><td>the pointer to the key region. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>ksiz</em> </td><td>the size of the key region. </td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>true on success, or false on failure. </dd></dl>
<p>Implements <a class="el" href="classkyotocabinet_1_1DB_1_1Cursor.html#af5ce800de2275a5e912265fd9afc896d">kyotocabinet::DB::Cursor</a>.</p>
</div>
</div>
<a class="anchor" id="a64e245b6339bad59db318933b35447e9"></a><!-- doxytag: member="kyotocabinet::StashDB::Cursor::jump" ref="a64e245b6339bad59db318933b35447e9" args="(const std::string &key)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool kyotocabinet::StashDB::Cursor::jump </td>
<td>(</td>
<td class="paramtype">const std::string & </td>
<td class="paramname"> <em>key</em></td>
<td> ) </td>
<td><code> [virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Jump the cursor to a record for forward scan. </p>
<dl class="note"><dt><b>Note:</b></dt><dd>Equal to the original <a class="el" href="classkyotocabinet_1_1StashDB_1_1Cursor.html#a0667e42f84b7e299f90bcb10da96adfa" title="Jump the cursor to the first record for forward scan.">Cursor::jump</a> method except that the parameter is std::string. </dd></dl>
<p>Implements <a class="el" href="classkyotocabinet_1_1DB_1_1Cursor.html#a3b38a11631f37d104209e5feade154b4">kyotocabinet::DB::Cursor</a>.</p>
</div>
</div>
<a class="anchor" id="adf5a30f1405d7e3d47dea9874ca9ed7c"></a><!-- doxytag: member="kyotocabinet::StashDB::Cursor::jump_back" ref="adf5a30f1405d7e3d47dea9874ca9ed7c" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool kyotocabinet::StashDB::Cursor::jump_back </td>
<td>(</td>
<td class="paramname"></td>
<td> ) </td>
<td><code> [virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Jump the cursor to the last record for backward scan. </p>
<dl class="note"><dt><b>Note:</b></dt><dd>This is a dummy implementation for compatibility. </dd></dl>
<p>Implements <a class="el" href="classkyotocabinet_1_1DB_1_1Cursor.html#a65452f182db3cd688885c460a761fa9c">kyotocabinet::DB::Cursor</a>.</p>
</div>
</div>
<a class="anchor" id="ab440dcb632e1525ab909adee470ac20d"></a><!-- doxytag: member="kyotocabinet::StashDB::Cursor::jump_back" ref="ab440dcb632e1525ab909adee470ac20d" args="(const char *kbuf, size_t ksiz)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool kyotocabinet::StashDB::Cursor::jump_back </td>
<td>(</td>
<td class="paramtype">const char * </td>
<td class="paramname"> <em>kbuf</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">size_t </td>
<td class="paramname"> <em>ksiz</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td><code> [virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Jump the cursor to a record for backward scan. </p>
<dl class="note"><dt><b>Note:</b></dt><dd>This is a dummy implementation for compatibility. </dd></dl>
<p>Implements <a class="el" href="classkyotocabinet_1_1DB_1_1Cursor.html#a4456015ac4c0248aebcabb03e195e860">kyotocabinet::DB::Cursor</a>.</p>
</div>
</div>
<a class="anchor" id="a50fef5f2945b3576acbbd3c80e2c5112"></a><!-- doxytag: member="kyotocabinet::StashDB::Cursor::jump_back" ref="a50fef5f2945b3576acbbd3c80e2c5112" args="(const std::string &key)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool kyotocabinet::StashDB::Cursor::jump_back </td>
<td>(</td>
<td class="paramtype">const std::string & </td>
<td class="paramname"> <em>key</em></td>
<td> ) </td>
<td><code> [virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Jump the cursor to a record for backward scan. </p>
<dl class="note"><dt><b>Note:</b></dt><dd>This is a dummy implementation for compatibility. </dd></dl>
<p>Implements <a class="el" href="classkyotocabinet_1_1DB_1_1Cursor.html#a9d392717ad801064a36220a91f907c1d">kyotocabinet::DB::Cursor</a>.</p>
</div>
</div>
<a class="anchor" id="a9ed7c428eccf0b70588301104c677e11"></a><!-- doxytag: member="kyotocabinet::StashDB::Cursor::step" ref="a9ed7c428eccf0b70588301104c677e11" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool kyotocabinet::StashDB::Cursor::step </td>
<td>(</td>
<td class="paramname"></td>
<td> ) </td>
<td><code> [virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Step the cursor to the next record. </p>
<dl class="return"><dt><b>Returns:</b></dt><dd>true on success, or false on failure. </dd></dl>
<p>Implements <a class="el" href="classkyotocabinet_1_1DB_1_1Cursor.html#a312228bd858d3091e32b65f1128faab4">kyotocabinet::DB::Cursor</a>.</p>
</div>
</div>
<a class="anchor" id="aafe8e849fea3ce4d8157f12ea0bb42cc"></a><!-- doxytag: member="kyotocabinet::StashDB::Cursor::step_back" ref="aafe8e849fea3ce4d8157f12ea0bb42cc" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool kyotocabinet::StashDB::Cursor::step_back </td>
<td>(</td>
<td class="paramname"></td>
<td> ) </td>
<td><code> [virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Step the cursor to the previous record. </p>
<dl class="note"><dt><b>Note:</b></dt><dd>This is a dummy implementation for compatibility. </dd></dl>
<p>Implements <a class="el" href="classkyotocabinet_1_1DB_1_1Cursor.html#a1eb720a41b9bad81f3dd6621870133d5">kyotocabinet::DB::Cursor</a>.</p>
</div>
</div>
<a class="anchor" id="a5e8436056db9fc5d20c643a745a606ac"></a><!-- doxytag: member="kyotocabinet::StashDB::Cursor::db" ref="a5e8436056db9fc5d20c643a745a606ac" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classkyotocabinet_1_1StashDB.html">StashDB</a>* kyotocabinet::StashDB::Cursor::db </td>
<td>(</td>
<td class="paramname"></td>
<td> ) </td>
<td><code> [virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Get the database object. </p>
<dl class="return"><dt><b>Returns:</b></dt><dd>the database object. </dd></dl>
<p>Implements <a class="el" href="classkyotocabinet_1_1BasicDB_1_1Cursor.html#a79e3904e5b10ed3d356545ed4259160e">kyotocabinet::BasicDB::Cursor</a>.</p>
</div>
</div>
</div>
<hr class="footer"/><address style="text-align: right;"><small>Generated on Mon Jan 3 13:02:28 2011 for Kyoto Cabinet by
<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.6.3 </small></address>
</body>
</html>
