class WrapperFunctionResult

Declaration

class WrapperFunctionResult { /* full declaration omitted */ };

Description

C++ wrapper function result: Same as CWrapperFunctionResult but auto-releases memory.

Declared at: llvm/include/llvm/ExecutionEngine/Orc/Shared/WrapperFunctionUtils.h:40

Member Variables

private llvm::orc::shared::CWrapperFunctionResult R

Method Overview

• public WrapperFunctionResult(llvm::orc::shared::CWrapperFunctionResult R)
• public WrapperFunctionResult(const llvm::orc::shared::WrapperFunctionResult &)
• public WrapperFunctionResult(llvm::orc::shared::WrapperFunctionResult && Other)
• public WrapperFunctionResult()
• public static llvm::orc::shared::WrapperFunctionResult allocate(size_t Size)
• public static llvm::orc::shared::WrapperFunctionResult copyFrom(const std::string & Source)
• public static llvm::orc::shared::WrapperFunctionResult copyFrom(const char * Source, size_t Size)
• public static llvm::orc::shared::WrapperFunctionResult copyFrom(const char * Source)
• public static llvm::orc::shared::WrapperFunctionResult createOutOfBandError(const std::string & Msg)
• public static llvm::orc::shared::WrapperFunctionResult createOutOfBandError(const char * Msg)
• public char * data()
• public const char * data() const
• public bool empty() const
• public const char * getOutOfBandError() const
• private static void init(llvm::orc::shared::CWrapperFunctionResult & R)
• public llvm::orc::shared::CWrapperFunctionResult release()
• public size_t size() const
• public ~WrapperFunctionResult()

Methods

¶WrapperFunctionResult(
    llvm::orc::shared::CWrapperFunctionResult R)

Description

Create a WrapperFunctionResult by taking ownership of a CWrapperFunctionResult. Warning: This should only be used by clients writing wrapper-function caller utilities (like TargetProcessControl).

Declared at: llvm/include/llvm/ExecutionEngine/Orc/Shared/WrapperFunctionUtils.h:50

Parameters

llvm::orc::shared::CWrapperFunctionResult R

¶WrapperFunctionResult(const llvm::orc::shared::
                          WrapperFunctionResult&)

Declared at: llvm/include/llvm/ExecutionEngine/Orc/Shared/WrapperFunctionUtils.h:55

Parameters

const llvm::orc::shared::WrapperFunctionResult&

¶WrapperFunctionResult(
    llvm::orc::shared::WrapperFunctionResult&&
        Other)

Declared at: llvm/include/llvm/ExecutionEngine/Orc/Shared/WrapperFunctionUtils.h:58

Parameters

llvm::orc::shared::WrapperFunctionResult&& Other

¶WrapperFunctionResult()

Description

Create a default WrapperFunctionResult.

Declared at: llvm/include/llvm/ExecutionEngine/Orc/Shared/WrapperFunctionUtils.h:43

¶static llvm::orc::shared::WrapperFunctionResult
allocate(size_t Size)

Description

Create a WrapperFunctionResult with the given size and return a pointer to the underlying memory.

Declared at: llvm/include/llvm/ExecutionEngine/Orc/Shared/WrapperFunctionUtils.h:113

Parameters

size_t Size

¶static llvm::orc::shared::WrapperFunctionResult
copyFrom(const std::string& Source)

Description

Copy from the given std::string (includes the null terminator).

Declared at: llvm/include/llvm/ExecutionEngine/Orc/Shared/WrapperFunctionUtils.h:135

Parameters

const std::string& Source

¶static llvm::orc::shared::WrapperFunctionResult
copyFrom(const char* Source, size_t Size)

Description

Copy from the given char range.

Declared at: llvm/include/llvm/ExecutionEngine/Orc/Shared/WrapperFunctionUtils.h:123

Parameters

const char* Source

size_t Size

¶static llvm::orc::shared::WrapperFunctionResult
copyFrom(const char* Source)

Description

Copy from the given null-terminated string (includes the null-terminator).

Declared at: llvm/include/llvm/ExecutionEngine/Orc/Shared/WrapperFunctionUtils.h:130

Parameters

const char* Source

¶static llvm::orc::shared::WrapperFunctionResult
createOutOfBandError(const std::string& Msg)

Description

Create an out-of-band error by copying the given string.

Declared at: llvm/include/llvm/ExecutionEngine/Orc/Shared/WrapperFunctionUtils.h:150

Parameters

const std::string& Msg

¶static llvm::orc::shared::WrapperFunctionResult
createOutOfBandError(const char* Msg)

Description

Create an out-of-band error by copying the given string.

Declared at: llvm/include/llvm/ExecutionEngine/Orc/Shared/WrapperFunctionUtils.h:140

Parameters

const char* Msg

¶char* data()

Description

Get a pointer to the data contained in this instance.

Declared at: llvm/include/llvm/ExecutionEngine/Orc/Shared/WrapperFunctionUtils.h:87

¶const char* data() const

Description

Get a const pointer to the data contained in this instance.

Declared at: llvm/include/llvm/ExecutionEngine/Orc/Shared/WrapperFunctionUtils.h:94

¶bool empty() const

Description

Returns true if this value is equivalent to a default-constructed WrapperFunctionResult.

Declared at: llvm/include/llvm/ExecutionEngine/Orc/Shared/WrapperFunctionUtils.h:109

¶const char* getOutOfBandError() const

Description

If this value is an out-of-band error then this returns the error message, otherwise returns nullptr.

Declared at: llvm/include/llvm/ExecutionEngine/Orc/Shared/WrapperFunctionUtils.h:156

¶static void init(
    llvm::orc::shared::CWrapperFunctionResult& R)

Declared at: llvm/include/llvm/ExecutionEngine/Orc/Shared/WrapperFunctionUtils.h:161

Parameters

llvm::orc::shared::CWrapperFunctionResult& R

¶llvm::orc::shared::CWrapperFunctionResult
release()

Description

Release ownership of the contained CWrapperFunctionResult. Warning: Do not use -- this method will be removed in the future. It only exists to temporarily support some code that will eventually be moved to the ORC runtime.

Declared at: llvm/include/llvm/ExecutionEngine/Orc/Shared/WrapperFunctionUtils.h:79

¶size_t size() const

Description

Returns the size of the data contained in this instance.

Declared at: llvm/include/llvm/ExecutionEngine/Orc/Shared/WrapperFunctionUtils.h:101

¶~WrapperFunctionResult()

Declared at: llvm/include/llvm/ExecutionEngine/Orc/Shared/WrapperFunctionUtils.h:69