Result.h

Go to the documentation of this file.

/*
  ==============================================================================
 
   This file is part of the Water library.
   Copyright (c) 2016 ROLI Ltd.
   Copyright (C) 2017-2022 Filipe Coelho <falktx@falktx.com>
 
   Permission is granted to use this software under the terms of the ISC license
   http://www.isc.org/downloads/software-support-policy/isc-license/
 
   Permission to use, copy, modify, and/or distribute this software for any
   purpose with or without fee is hereby granted, provided that the above
   copyright notice and this permission notice appear in all copies.
 
   THE SOFTWARE IS PROVIDED "AS IS" AND ISC DISCLAIMS ALL WARRANTIES WITH REGARD
   TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND
   FITNESS. IN NO EVENT SHALL ISC BE LIABLE FOR ANY SPECIAL, DIRECT, INDIRECT,
   OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF
   USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER
   TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE
   OF THIS SOFTWARE.
 
  ==============================================================================
*/
 
#ifndef WATER_RESULT_H_INCLUDED
#define WATER_RESULT_H_INCLUDED
 
#include "../water.h"
 
#include <string>
 
namespace water {
 
//==============================================================================
class Result
{
public:
    //==============================================================================
    static Result ok() noexcept                         { return Result(); }

    static Result fail (const std::string& errorMessage) noexcept;
 
    //==============================================================================
    bool wasOk() const noexcept;

    bool failed() const noexcept;

    operator bool() const noexcept;

    bool operator!() const noexcept;

    const std::string& getErrorMessage() const noexcept;
 
    //==============================================================================
    Result (const Result&);
    Result& operator= (const Result&);
 
    bool operator== (const Result& other) const noexcept;
    bool operator!= (const Result& other) const noexcept;
 
private:
    std::string errorMessage;
 
    // The default constructor is not for public use!
    // Instead, use Result::ok() or Result::fail()
    Result() noexcept;
    explicit Result (const std::string&) noexcept;
 
    // These casts are private to prevent people trying to use the Result object in numeric contexts
    operator int() const;
    operator void*() const;
};
 
}
 
#endif // WATER_RESULT_H_INCLUDED