openshot-audio  0.1.6
juce_Result.h
Go to the documentation of this file.
1 /*
2  ==============================================================================
3 
4  This file is part of the juce_core module of the JUCE library.
5  Copyright (c) 2015 - ROLI Ltd.
6 
7  Permission to use, copy, modify, and/or distribute this software for any purpose with
8  or without fee is hereby granted, provided that the above copyright notice and this
9  permission notice appear in all copies.
10 
11  THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES WITH REGARD
12  TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS. IN
13  NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL
14  DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER
15  IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN
16  CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
17 
18  ------------------------------------------------------------------------------
19 
20  NOTE! This permissive ISC license applies ONLY to files within the juce_core module!
21  All other JUCE modules are covered by a dual GPL/commercial license, so if you are
22  using any other modules, be sure to check that you also comply with their license.
23 
24  For more details, visit www.juce.com
25 
26  ==============================================================================
27 */
28 
29 #ifndef JUCE_RESULT_H_INCLUDED
30 #define JUCE_RESULT_H_INCLUDED
31 
32 
33 //==============================================================================
62 {
63 public:
64  //==============================================================================
66  static Result ok() noexcept { return Result(); }
67 
72  static Result fail (const String& errorMessage) noexcept;
73 
74  //==============================================================================
76  bool wasOk() const noexcept;
77 
82  bool failed() const noexcept;
83 
87  operator bool() const noexcept;
88 
92  bool operator!() const noexcept;
93 
97  const String& getErrorMessage() const noexcept;
98 
99  //==============================================================================
100  Result (const Result&);
101  Result& operator= (const Result&);
102 
103  #if JUCE_COMPILER_SUPPORTS_MOVE_SEMANTICS
104  Result (Result&&) noexcept;
105  Result& operator= (Result&&) noexcept;
106  #endif
107 
108  bool operator== (const Result& other) const noexcept;
109  bool operator!= (const Result& other) const noexcept;
110 
111 private:
112  String errorMessage;
113 
114  // The default constructor is not for public use!
115  // Instead, use Result::ok() or Result::fail()
116  Result() noexcept;
117  explicit Result (const String&) noexcept;
118 
119  // These casts are private to prevent people trying to use the Result object in numeric contexts
120  operator int() const;
121  operator void*() const;
122 };
123 
124 
125 #endif // JUCE_RESULT_H_INCLUDED
#define noexcept
Definition: juce_CompilerSupport.h:141
Definition: juce_String.h:43
Definition: juce_Result.h:61
#define JUCE_API
Definition: juce_StandardHeader.h:139
bool operator==(const var &v1, const var &v2) noexcept
Definition: juce_Variant.cpp:565
static Result ok() noexcept
Definition: juce_Result.h:66
bool operator!=(const var &v1, const var &v2) noexcept
Definition: juce_Variant.cpp:566