/sqlite3cc

To get this branch, use:
bzr branch http://bzr.ed.am/sqlite3cc

« back to all changes in this revision

Viewing changes to include/sqlite3cc/manipulator.h

  • Committer: edam
  • Date: 2012-04-23 18:41:32 UTC
  • Revision ID: tim@ed.am-20120423184132-uuicu56b79w0xxdp
updated autotools

Show diffs side-by-side

added added

removed removed

Lines of Context:
include/sqlite3cc/manipulator.h
 
1
/*
 
2
 * manipulator.h
 
3
 *
 
4
 * Copyright (C) 2009 Tim Marston <tim@ed.am>
 
5
 *
 
6
 * This file is part of sqlite3cc (hereafter referred to as "this program").
 
7
 * See http://ed.am/dev/sqlite3cc for more information.
 
8
 *
 
9
 * This program is free software: you can redistribute it and/or modify it under
 
10
 * the terms of the GNU Lesser General Public License as published by the Free
 
11
 * Software Foundation, either version 3 of the License, or (at your option) any
 
12
 * later version.
 
13
 *
 
14
 * This program is distributed in the hope that it will be useful, but WITHOUT
 
15
 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
 
16
 * FOR A PARTICULAR PURPOSE.  See the GNU Lesser General Public License for more
 
17
 * details.
 
18
 *
 
19
 * You should have received a copy of the GNU Lesser General Public License
 
20
 * along with this program.  If not, see <http://www.gnu.org/licenses/>.
 
21
 */
 
22
 
 
23
#ifndef SQLITE3CC_MANIPULATOR_H_
 
24
#define SQLITE3CC_MANIPULATOR_H_
 
25
 
 
26
 
 
27
namespace sqlite
 
28
{
 
29
 
 
30
 
 
31
namespace detail
 
32
{
 
33
        // types to represent special manipulators for use with stream operators
 
34
        struct null_t { };
 
35
        struct exec_t { };
 
36
        struct set_index_t { unsigned int _index; };
 
37
}
 
38
 
 
39
 
 
40
/**
 
41
 * Stream manipulator.  When used with a statment's stream operator, this
 
42
 * specifies a NULL value to bind to a parameter.  When used with a row's stream
 
43
 * operator, no value is fetched for a column.
 
44
 */
 
45
extern detail::null_t null;
 
46
 
 
47
/**
 
48
 * Stream manipulator.  When used with a statment's stream operator, this
 
49
 * indicates that the statement should be executed immediately.  Unlike a
 
50
 * statment's exec() method, this will throw on error.  Also, it will throw if
 
51
 * the execution returns any result rows.  When used with a query's stream
 
52
 * operator, behaviour is the same except that it will not throw when the
 
53
 * execution returns results.
 
54
 */
 
55
extern detail::exec_t exec;
 
56
 
 
57
/**
 
58
 * Stream manipulator.  When used with a statment's or a row's stream operator,
 
59
 * this manipulator sets the index used to automatically bind values or get
 
60
 * column values.
 
61
 *
 
62
 * @param index the new index
 
63
 */
 
64
detail::set_index_t set_index(
 
65
        unsigned int index );
 
66
 
 
67
 
 
68
} // namespace sqlite
 
69
 
 
70
 
 
71
#endif /* SQLITE3CC_MANIPULATOR_H_ */