MLIR  16.0.0git
Public Member Functions | List of all members
mlir::ParseResult Class Reference

This class represents success/failure for parsing-like operations that find it important to chain together failable operations with ||. More...

#include "mlir/Support/LogicalResult.h"

+ Inheritance diagram for mlir::ParseResult:
+ Collaboration diagram for mlir::ParseResult:

Public Member Functions

 ParseResult (LogicalResult result=success())
 
 operator bool () const
 Failure is true in a boolean context. More...
 
- Public Member Functions inherited from mlir::LogicalResult
bool succeeded () const
 Returns true if the provided LogicalResult corresponds to a success value. More...
 
bool failed () const
 Returns true if the provided LogicalResult corresponds to a failure value. More...
 

Additional Inherited Members

- Static Public Member Functions inherited from mlir::LogicalResult
static LogicalResult success (bool isSuccess=true)
 If isSuccess is true a success result is generated, otherwise a 'failure' result is generated. More...
 
static LogicalResult failure (bool isFailure=true)
 If isFailure is true a failure result is generated, otherwise a 'success' result is generated. More...
 

Detailed Description

This class represents success/failure for parsing-like operations that find it important to chain together failable operations with ||.

This is an extended version of LogicalResult that allows for explicit conversion to bool.

This class should not be used for general error handling cases - we prefer to keep the logic explicit with the succeeded/failed predicates. However, traditional monadic-style parsing logic can sometimes get swallowed up in boilerplate without this, so we provide this for narrow cases where it is important.

Definition at line 113 of file LogicalResult.h.

Constructor & Destructor Documentation

◆ ParseResult()

mlir::ParseResult::ParseResult ( LogicalResult  result = success())
inline

Definition at line 115 of file LogicalResult.h.

Member Function Documentation

◆ operator bool()

mlir::ParseResult::operator bool ( ) const
inlineexplicit

Failure is true in a boolean context.

Definition at line 118 of file LogicalResult.h.

References mlir::failed().


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