Unity Scopes API
CompletionDetails.h
1 /*
2  * Copyright (C) 2014 Canonical Ltd
3  *
4  * This program is free software: you can redistribute it and/or modify
5  * it under the terms of the GNU Lesser General Public License version 3 as
6  * published by the Free Software Foundation.
7  *
8  * This program is distributed in the hope that it will be useful,
9  * but WITHOUT ANY WARRANTY; without even the implied warranty of
10  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
11  * GNU Lesser General Public License for more details.
12  *
13  * You should have received a copy of the GNU Lesser General Public License
14  * along with this program. If not, see <http://www.gnu.org/licenses/>.
15  *
16  * Authored by: Marcus Tomlinson <marcus.tomlinson@canonical.com>
17  */
18 
19 #pragma once
20 
21 #include <unity/scopes/OperationInfo.h>
22 
23 #include <memory>
24 #include <string>
25 #include <vector>
26 
27 namespace unity
28 {
29 
30 namespace scopes
31 {
32 
33 namespace internal
34 {
35 
36 class CompletionDetailsImpl;
37 
38 }
39 
45 class CompletionDetails final
46 {
47 public:
54  enum CompletionStatus { OK, Cancelled, Error };
55 
61 
67  CompletionDetails(CompletionStatus status, std::string const& message);
68 
72  //{@
75 
76  CompletionDetails& operator=(CompletionDetails const& other);
79 
83 
88  CompletionStatus status() const noexcept;
89 
94  std::string message() const;
95 
101  void add_info(OperationInfo const& info);
102 
107  std::vector<OperationInfo> info_list() const;
108 
109 private:
110  std::unique_ptr<internal::CompletionDetailsImpl> p;
111 };
112 
118 
119 } // namespace scopes
120 
121 } // namespace unity
CompletionStatus
Indicates the completion status for a query.
Definition: CompletionDetails.h:54
CompletionDetails(CompletionStatus status)
Create CompletionDetails with the given completion status.
Definition: CompletionDetails.cpp:31
std::string message() const
Get the completion message string.
Definition: CompletionDetails.cpp:70
char const * to_string(CompletionDetails::CompletionStatus status)
Convenience function to convert a CompletionDetails::CompletionStatus enumerator to a string...
Definition: CompletionDetails.cpp:95
std::vector< OperationInfo > info_list() const
Get a list of all additional operation info.
Definition: CompletionDetails.cpp:80
void add_info(OperationInfo const &info)
Add additional operation info to the info list.
Definition: CompletionDetails.cpp:75
Top-level namespace for all things Unity-related.
Definition: Version.h:49
Definition: ActionMetadata.h:31
A container for details about the completion status of a query as well as any additional information ...
Definition: CompletionDetails.h:45
CompletionStatus status() const noexcept
Get the completion status.
Definition: CompletionDetails.cpp:65
A container for details about something of interest that occurs during the operation of a request...
Definition: OperationInfo.h:42