OpenAssetIO
An abstract API for generalising interactions between a host application and an asset management system
Manager::BatchElementErrorPolicyTag Struct Reference

Tag dispatching structure intended for use selecting appropriate overloads for various error-handling modes. More...

#include <Manager.hpp>

Classes

struct  Exception
 Exception policy overloads, when used in a batch context, will emit an exception at the first encountered errors::BatchElementError provided by the ManagerInterface. More...
 
struct  Variant
 Variant policy overloads, when used in a batch context, will be exhaustive for all elements in the batch, a variant result containing either a trait::TraitsData or errors::BatchElementError will be provided for each EntityReference provided as an argument to the operation. More...
 

Static Public Attributes

static constexpr Variant kVariant {}
 Static instantiation of the Variant dispatch tag, to avoid the need to construct a new object to resolve dispatch methods. More...
 
static constexpr Exception kException {}
 Static instantiation of the Exception dispatch tag, to avoid the need to construct a new object to resolve dispatch methods. More...
 

Detailed Description

Tag dispatching structure intended for use selecting appropriate overloads for various error-handling modes.

Many OpenAssetIO functions provide options as to whether errors are handled via throwing exceptions, or by returning a variant based result object.

Member Data Documentation

constexpr Exception kException {}
static

Static instantiation of the Exception dispatch tag, to avoid the need to construct a new object to resolve dispatch methods.

constexpr Variant kVariant {}
static

Static instantiation of the Variant dispatch tag, to avoid the need to construct a new object to resolve dispatch methods.


The documentation for this struct was generated from the following file:
  • /src/src/openassetio-core/include/openassetio/hostApi/Manager.hpp