RStudio Launcher Plugin SDK  1.1.3
A software development kit for creating plugins that work the the RStudio Launcher.
Public Member Functions | List of all members
rstudio::launcher_plugins::Success Class Reference

Class which represents a successful operation (i.e. no error). More...

#include <Error.hpp>

Inheritance diagram for rstudio::launcher_plugins::Success:
rstudio::launcher_plugins::Error rstudio::launcher_plugins::ErrorLock

Public Member Functions

 Success ()
 Constructor.
 
- Public Member Functions inherited from rstudio::launcher_plugins::Error
 Error ()
 Constructor.
 
 Error (const Error &in_other)
 Copy constructor. More...
 
 Error (std::string in_name, int in_code, const ErrorLocation &in_location)
 Constructor. More...
 
 Error (std::string in_name, int in_code, const Error &in_cause, const ErrorLocation &in_location)
 Constructor. More...
 
 Error (std::string in_name, int in_code, std::string in_message, const ErrorLocation &in_location)
 Constructor. More...
 
 Error (std::string in_name, int in_code, std::string in_message, const Error &in_cause, const ErrorLocation &in_location)
 Constructor. More...
 
 ~Error () override=default
 Non-virtual destructor because only Success inherits Error and it will keep Error lightweight.
 
 operator bool () const
 Overloaded operator bool to allow Errors to be treated as boolean values. More...
 
bool operator! () const
 Overloaded operator ! to allow Errors to be treated as boolean values. More...
 
bool operator== (const Error &in_other) const
 Equality operator. Two errors are equal if their codes and names are the same. More...
 
bool operator!= (const Error &in_other) const
 Inequality operator. Two errors are equal if their codes and names are the same. More...
 
void addOrUpdateProperty (const std::string &in_name, const std::string &in_value)
 Add or updates a property of this error. If any properties with the specified name exist, they will all be updated. More...
 
void addOrUpdateProperty (const std::string &in_name, const system::FilePath &in_value)
 Add or updates a property of this error. If any properties with the specified name exist, they will all be updated. More...
 
void addOrUpdateProperty (const std::string &in_name, int in_value)
 Add or updates a property of this error. If any properties with the specified name exist, they will all be updated. More...
 
void addProperty (const std::string &in_name, const std::string &in_value)
 Adds a property of this error. If a property with the same name already exists, a duplicate will be added. More...
 
void addProperty (const std::string &in_name, const system::FilePath &in_value)
 Adds a property of this error. If a property with the same name already exists, a duplicate will be added. More...
 
void addProperty (const std::string &in_name, int in_value)
 Adds a property of this error. If a property with the same name already exists, a duplicate will be added. More...
 
std::string asString () const
 Formats the error as a string. More...
 
bool hasCause () const
 Checks whether this error was caused by a separate error. More...
 
const Optional< Error > & getCause () const
 Gets the error which caused this error. More...
 
int getCode () const
 Gets the error code. More...
 
const ErrorLocationgetLocation () const
 Gets the location where the error occurred. More...
 
const std::string & getMessage () const
 Gets the error message. More...
 
const std::string & getName () const
 Gets the name of the error. More...
 
const ErrorProperties & getProperties () const
 Gets the custom properties of the error. More...
 
std::string getProperty (const std::string &name) const
 Gets a custom property of this error. More...
 
std::string getSummary () const
 Gets the cause of the error. More...
 
bool isExpected () const
 Gets whether this error was expected or not. More...
 
void setExpected ()
 Sets the property that indicates that this error was expected. Errors are unexpected by default; only unexpected errors will be logged. Expected errors can be marked as such to suppress logging of those errors.
 

Detailed Description

Class which represents a successful operation (i.e. no error).


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