xronos-sdk 0.14.0
Xronos C++ SDK
Loading...
Searching...
No Matches
xronos::sdk::DefaultRuntimeProvider Struct Referencefinal

A runtime provider that provides the default runtime. More...

#include <xronos/sdk/runtime_provider.hh>

Inheritance diagram for xronos::sdk::DefaultRuntimeProvider:
[legend]

Public Member Functions

auto get_runtime () const noexcept -> std::unique_ptr< runtime::Runtime > final
 Get a runtime instance.
auto version () const noexcept -> std::string_view final
 Get the version of the runtime provided by this provider.

Detailed Description

A runtime provider that provides the default runtime.

Passing this to the Environment::execute() overload is equivalent to calling the parameterless execute(), which uses the default runtime of the linked backend.

Member Function Documentation

◆ version()

auto xronos::sdk::DefaultRuntimeProvider::version ( ) const -> std::string_view
nodiscardfinalvirtualnoexcept

Get the version of the runtime provided by this provider.

The returned version is baked into the library that defines the provider. Environment::execute() compares it against the SDK's own version to detect a mismatched SDK/runtime pair (which can occur because the runtime is linked separately from the SDK).

Implements xronos::sdk::RuntimeProvider.


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