OpenShot Library | libopenshot-audio  0.1.9
juce::Result Class Reference

Represents the 'success' or 'failure' of an operation, and holds an associated error message to describe the error when there's a failure. More...

#include <juce_Result.h>

Public Member Functions

bool wasOk () const noexcept
 Returns true if this result indicates a success. More...
 
bool failed () const noexcept
 Returns true if this result indicates a failure. More...
 
 operator bool () const noexcept
 Returns true if this result indicates a success. More...
 
bool operator! () const noexcept
 Returns true if this result indicates a failure. More...
 
const StringgetErrorMessage () const noexcept
 Returns the error message that was set when this result was created. More...
 
 Result (const Result &)
 
Resultoperator= (const Result &)
 
 Result (Result &&) noexcept
 
Resultoperator= (Result &&) noexcept
 
bool operator== (const Result &other) const noexcept
 
bool operator!= (const Result &other) const noexcept
 

Static Public Member Functions

static Result ok () noexcept
 Creates and returns a 'successful' result. More...
 
static Result fail (const String &errorMessage) noexcept
 Creates a 'failure' result. More...
 

Detailed Description

Represents the 'success' or 'failure' of an operation, and holds an associated error message to describe the error when there's a failure.

E.g.

Result myOperation()
{
if (doSomeKindOfFoobar())
return Result::ok();
else
return Result::fail ("foobar didn't work!");
}
const Result result (myOperation());
if (result.wasOk())
{
...it's all good...
}
else
{
warnUserAboutFailure ("The foobar operation failed! Error message was: "
+ result.getErrorMessage());
}

Definition at line 60 of file juce_Result.h.

Member Function Documentation

◆ ok()

static Result juce::Result::ok ( )
inlinestaticnoexcept

◆ fail()

Result juce::Result::fail ( const String errorMessage)
staticnoexcept

Creates a 'failure' result.

If you pass a blank error message in here, a default "Unknown Error" message will be used instead.

Definition at line 65 of file juce_Result.cpp.

Referenced by juce::File::create(), juce::File::createDirectory(), juce::JSON::parseQuotedString(), and juce::ZipFile::uncompressEntry().

◆ wasOk()

bool juce::Result::wasOk ( ) const
noexcept

Returns true if this result indicates a success.

Definition at line 75 of file juce_Result.cpp.

◆ failed()

bool juce::Result::failed ( ) const
noexcept

Returns true if this result indicates a failure.

You can use getErrorMessage() to retrieve the error message associated with the failure.

Definition at line 77 of file juce_Result.cpp.

◆ operator bool()

juce::Result::operator bool ( ) const
noexcept

Returns true if this result indicates a success.

This is equivalent to calling wasOk().

Definition at line 76 of file juce_Result.cpp.

◆ operator!()

bool juce::Result::operator! ( ) const
noexcept

Returns true if this result indicates a failure.

This is equivalent to calling failed().

Definition at line 78 of file juce_Result.cpp.

◆ getErrorMessage()

const String & juce::Result::getErrorMessage ( ) const
noexcept

Returns the error message that was set when this result was created.

For a successful result, this will be an empty string;

Definition at line 70 of file juce_Result.cpp.


The documentation for this class was generated from the following files: