xref: /freebsd/contrib/kyua/store/layout_fwd.hpp (revision 43a5ec4eb41567cc92586503212743d89686d78f)
1 // Copyright 2015 The Kyua Authors.
2 // All rights reserved.
3 //
4 // Redistribution and use in source and binary forms, with or without
5 // modification, are permitted provided that the following conditions are
6 // met:
7 //
8 // * Redistributions of source code must retain the above copyright
9 //   notice, this list of conditions and the following disclaimer.
10 // * Redistributions in binary form must reproduce the above copyright
11 //   notice, this list of conditions and the following disclaimer in the
12 //   documentation and/or other materials provided with the distribution.
13 // * Neither the name of Google Inc. nor the names of its contributors
14 //   may be used to endorse or promote products derived from this software
15 //   without specific prior written permission.
16 //
17 // THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
18 // "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
19 // LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
20 // A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
21 // OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
22 // SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
23 // LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
24 // DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
25 // THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
26 // (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
27 // OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
28 
29 /// \file store/layout_fwd.hpp
30 /// Forward declarations for store/layout.hpp
31 
32 #if !defined(STORE_LAYOUT_FWD_HPP)
33 #define STORE_LAYOUT_FWD_HPP
34 
35 #include <string>
36 #include <utility>
37 
38 #include "utils/fs/path_fwd.hpp"
39 
40 namespace store {
41 namespace layout {
42 
43 
44 /// A pair with the user-visible ID of the results file and its path.
45 ///
46 /// It is possible for the ID (first component) to be empty in the cases where
47 /// the user explicitly requested to create the database in a specific path.
48 typedef std::pair< std::string, utils::fs::path > results_id_file_pair;
49 
50 
51 }  // namespace layout
52 }  // namespace store
53 
54 #endif  // !defined(STORE_LAYOUT_FWD_HPP)
55