Tagged union holding either a T or a Error. More...
#include "llvm/Support/CachePruning.h"
Public Types | |
| using | storage_type = typename std::conditional< isRef, wrap, T >::type |
| using | value_type = T |
Public Member Functions | |
| Expected (Error Err) | |
| Create an Expected<T> error value from the given Error. More... | |
| Expected (ErrorSuccess)=delete | |
| Forbid to convert from Error::success() implicitly, this avoids having Expected<T> foo() { return Error::success(); } which compiles otherwise but triggers the assertion above. More... | |
| template<typename OtherT > | |
| Expected (OtherT &&Val, typename std::enable_if< std::is_convertible< OtherT, T >::value >::type *=nullptr) | |
| Create an Expected<T> success value from the given OtherT value, which must be convertible to T. More... | |
| Expected (Expected &&Other) | |
| Move construct an Expected<T> value. More... | |
| template<class OtherT > | |
| Expected (Expected< OtherT > &&Other, typename std::enable_if< std::is_convertible< OtherT, T >::value >::type *=nullptr) | |
| Move construct an Expected<T> value from an Expected<OtherT>, where OtherT must be convertible to T. More... | |
| template<class OtherT > | |
| Expected (Expected< OtherT > &&Other, typename std::enable_if<!std::is_convertible< OtherT, T >::value >::type *=nullptr) | |
| Move construct an Expected<T> value from an Expected<OtherT>, where OtherT isn't convertible to T. More... | |
| Expected & | operator= (Expected &&Other) |
| Move-assign from another Expected<T>. More... | |
| ~Expected () | |
| Destroy an Expected<T>. More... | |
| operator bool () | |
| Return false if there is an error. More... | |
| reference | get () |
| Returns a reference to the stored T value. More... | |
| const_reference | get () const |
| Returns a const reference to the stored T value. More... | |
| template<typename ErrT > | |
| bool | errorIsA () const |
| Check that this Expected<T> is an error of type ErrT. More... | |
| Error | takeError () |
| Take ownership of the stored error. More... | |
| pointer | operator-> () |
| Returns a pointer to the stored T value. More... | |
| const_pointer | operator-> () const |
| Returns a const pointer to the stored T value. More... | |
| reference | operator* () |
| Returns a reference to the stored T value. More... | |
| const_reference | operator* () const |
| Returns a const reference to the stored T value. More... | |
Friends | |
| template<class T1 > | |
| class | ExpectedAsOutParameter |
| template<class OtherT > | |
| class | Expected |
Detailed Description
template<class T>
class llvm::Expected< T >
Tagged union holding either a T or a Error.
This class parallels ErrorOr, but replaces error_code with Error. Since Error cannot be copied, this class replaces getError() with takeError(). It also adds an bool errorIsA<ErrT>() method for testing the error class type.
Definition at line 22 of file CachePruning.h.
Member Typedef Documentation
◆ storage_type
| using llvm::Expected< T >::storage_type = typename std::conditional<isRef, wrap, T>::type |
◆ value_type
| using llvm::Expected< T >::value_type = T |
Constructor & Destructor Documentation
◆ Expected() [1/6]
|
inline |
◆ Expected() [2/6]
|
delete |
Forbid to convert from Error::success() implicitly, this avoids having Expected<T> foo() { return Error::success(); } which compiles otherwise but triggers the assertion above.
◆ Expected() [3/6]
|
inline |
◆ Expected() [4/6]
|
inline |
◆ Expected() [5/6]
◆ Expected() [6/6]
◆ ~Expected()
|
inline |
Member Function Documentation
◆ errorIsA()
◆ get() [1/2]
|
inline |
Returns a reference to the stored T value.
Definition at line 532 of file Error.h.
Referenced by copyAttributeNamespace(), llvm::object::createBinary(), llvm::object::IRObjectFile::findBitcodeInMemBuffer(), llvm::MCJIT::findSymbol(), llvm::symbolize::LLVMSymbolizer::flush(), llvm::MCJIT::generateCodeForModule(), llvm::object::Archive::Child::getAsBinary(), llvm::object::Archive::Child::getBuffer(), getDbiStreamPtr(), llvm::object::Archive::Child::getFullName(), llvm::IndexedInstrProfReader::getFunctionCounts(), llvm::object::Archive::Child::getMemoryBufferRef(), llvm::object::ArchiveMemberHeader::getName(), llvm::object::Archive::Child::getName(), llvm::object::Archive::Child::getNext(), llvm::NewArchiveMember::getOldMember(), llvm::object::Archive::Child::getRawSize(), llvm::object::Archive::Child::getSize(), LLVMCreateBinary(), LLVMCreateObjectFile(), mergeAttributes(), mergeNamespaces(), parseHexOcta(), printDwarfFileDirective(), llvm::orc::OrcMCJITReplacement::setProcessAllSections(), llvm::splitCodeGen(), llvm::object::SymbolicFile::SymbolicFile(), and upgrade().
◆ get() [2/2]
|
inline |
◆ operator bool()
|
inlineexplicit |
◆ operator*() [1/2]
|
inline |
◆ operator*() [2/2]
|
inline |
Returns a const reference to the stored T value.
Definition at line 578 of file Error.h.
References assert(), llvm::dbgs(), LLVM_ATTRIBUTE_NOINLINE, LLVM_ATTRIBUTE_NORETURN, LLVM_UNLIKELY, llvm::ErrorInfoBase::log(), Other, and T1.
◆ operator->() [1/2]
|
inline |
◆ operator->() [2/2]
|
inline |
◆ operator=()
|
inline |
Move-assign from another Expected<T>.
Definition at line 509 of file Error.h.
References Other.
Referenced by llvm::MSVCPExpected< T >::operator=().
◆ takeError()
|
inline |
Take ownership of the stored error.
After calling this the Expected<T> is in an indeterminate state that can only be safely destructed. No further calls (beside the destructor) should be made on the Expected<T> vaule.
Definition at line 552 of file Error.h.
References llvm::Error, and llvm::Error::success().
Referenced by llvm::pdb::PDBFileBuilder::addInjectedSource(), llvm::pdb::PDBFileBuilder::addNamedStream(), llvm::object::ELFFile< ELFT >::android_relas(), llvm::jitlink::MachOAtomGraphBuilder::areLayoutLocked(), llvm::lto::backend(), llvm::FileCheckString::Check(), llvm::FileCheckString::CheckNot(), llvm::pdb::PDBFileBuilder::commit(), llvm::msf::MSFBuilder::commit(), computeMemberData(), llvm::orc::rpc::detail::ResultTraits< RetT >::consumeAbandoned(), llvm::object::SectionRef::containsSymbol(), copyAttributeNamespace(), llvm::GlobPattern::create(), llvm::symbolize::SymbolizableObjectFile::create(), llvm::object::IRObjectFile::create(), llvm::lto::InputFile::create(), llvm::object::createBinary(), llvm::LTOModule::createInputFile(), llvm::mca::InstrBuilder::createInstruction(), createOnDiskBuffer(), llvm::DWARFContext::defaultErrorHandler(), llvm::FileCheckPatternContext::defineCmdlineVariables(), llvm::dlltoolDriverMain(), doImportingForModule(), llvm::coverage::CounterMappingContext::dump(), llvm::object::ELFFile< ELFT >::dynamicEntries(), llvm::coverage::CounterMappingContext::evaluate(), llvm::expectedToErrorOrAndEmitErrors(), llvm::pdb::GSIStreamBuilder::finalizeMsfLayout(), llvm::RuntimeDyldMachOX86_64::finalizeSection(), llvm::RuntimeDyldMachOI386::finalizeSection(), llvm::RuntimeDyldMachOAArch64::finalizeSection(), llvm::object::IRObjectFile::findBitcodeInMemBuffer(), llvm::object::IRObjectFile::findBitcodeInObject(), llvm::pdb::TpiStream::findFullDeclForForwardRef(), llvm::MCJIT::findSymbol(), llvm::pdb::SymbolCache::findSymbolByTypeIndex(), llvm::symbolize::LLVMSymbolizer::flush(), forceRenaming(), llvm::DWARFDebugAranges::generate(), llvm::MCJIT::generateCodeForModule(), llvm::object::Archive::Child::getAsBinary(), llvm::object::COFFObjectFile::getAuxSymbol(), llvm::getBitcodeFileContents(), llvm::getBitcodeLTOInfo(), llvm::getBitcodeProducerString(), llvm::getBitcodeTargetTriple(), llvm::object::Archive::Child::getBuffer(), llvm::object::SectionRef::getContents(), getDbiStreamPtr(), llvm::pdb::DbiStream::getECName(), llvm::object::getELFAddend(), llvm::object::Archive::Child::getFullName(), llvm::IndexedInstrProfReader::getFunctionCounts(), llvm::getLazyBitcodeModule(), llvm::DWARFContext::getLineTableForUnit(), llvm::BitcodeModule::getLTOInfo(), llvm::object::Archive::Child::getMemoryBufferRef(), llvm::getModuleSummaryIndex(), llvm::object::ArchiveMemberHeader::getName(), llvm::object::SectionRef::getName(), llvm::object::Archive::Child::getName(), llvm::object::Archive::Child::getNext(), llvm::getOffset(), llvm::NewArchiveMember::getOldMember(), llvm::LTOModule::getProducerString(), llvm::object::Archive::Child::getRawSize(), llvm::FileCheckStringSubstitution::getResult(), llvm::FileCheckNumericSubstitution::getResult(), getSingleModule(), llvm::object::Archive::Child::getSize(), llvm::pdb::PDBFile::getStringTable(), getSymbolInfo(), llvm::object::MachOObjectFile::getSymbolType(), handleNonPrevailingComdat(), llvm::pdb::PDBFile::hasPDBStringTable(), llvm::isBitcodeContainingObjCCategory(), llvm::LTOModule::isBitcodeFile(), llvm::LTOModule::isBitcodeForTarget(), llvm::LTOModule::isThinLTO(), llvm::isThumbFunc(), llvm::jitlink::JITLinkerBase::linkPhase2(), LLVMCreateBinary(), LLVMCreateObjectFile(), LLVMGetSymbolAddress(), LLVMGetSymbolName(), LLVMMoveToContainingSection(), LLVMRemarkParserGetNext(), llvm::lto::localCache(), llvm::FileCheckPattern::match(), mergeAttributes(), mergeNamespaces(), llvm::parseBitcodeFile(), parseBitcodeFileImpl(), parseHexOcta(), llvm::FileCheckPattern::parseNumericVariableDefinition(), printDwarfFileDirective(), llvm::FileCheckPattern::printSubstitutions(), llvm::object::ObjectFile::printSymbolName(), llvm::RuntimeDyldCOFFI386::processRelocationRef(), llvm::RuntimeDyldCOFFThumb::processRelocationRef(), llvm::RuntimeDyldELF::processRelocationRef(), llvm::RuntimeDyldCOFFX86_64::processRelocationRef(), llvm::object::readIRSymtab(), llvm::readModuleSummaryIndex(), llvm::orc::RemoteObjectLayer< RPCEndpoint >::remoteToJITSymbol(), llvm::orc::rpc::detail::RespondHelper< true >::sendResult(), llvm::orc::OrcMCJITReplacement::setProcessAllSections(), sub(), sumEdgeCount(), llvm::object::SymbolicFile::SymbolicFile(), llvm::detail::TakeExpected(), llvm::lto::thinBackend(), upgrade(), and llvm::writeArchive().
Friends And Related Function Documentation
◆ Expected
◆ ExpectedAsOutParameter
Member Data Documentation
◆ ErrorStorage
| AlignedCharArrayUnion<error_type> llvm::Expected< T >::ErrorStorage |
◆ TStorage
| AlignedCharArrayUnion<storage_type> llvm::Expected< T >::TStorage |
The documentation for this class was generated from the following files:
- include/llvm/Support/CachePruning.h
- include/llvm/Support/Error.h
