hilti::rt::Library Class Reference

#include <library.h>

Public Member Functions
	Library (const hilti::rt::filesystem::path &path)
	Library (const Library &)=delete
Library &	operator= (const Library &)=delete
	Library (Library &&)=default
Library &	operator= (Library &&)=default
hilti::rt::Result< hilti::rt::library::Version >	open () const
hilti::rt::Result< Nothing >	save (const hilti::rt::filesystem::path &path) const
hilti::rt::Result< void * >	symbol (const char *name) const
hilti::rt::Result< Nothing >	remove () const

Static Public Member Functions
static void	setScope (uint64_t *scope)

Detailed Description

Container for storing code compiled into a native shared library.

This class loads the underlying library it wraps into its internal store on construction and subsequently does not depend on it anymore.

Constructor & Destructor Documentation

Library()

hilti::rt::Library::Library

(

const hilti::rt::filesystem::path &

path

)

Makes a library available for opening.

Parameters

path	full path to the library file

Exceptions

<em>std::runtime_error</em>

if library does not exist, or any other I/O operation failed

Member Function Documentation

open()

hilti::rt::Result< hilti::rt::library::Version > hilti::rt::Library::open

(

)

const

Load the library into the current process

Returns

version information extracted from loaded library

save()

hilti::rt::Result< hilti::rt::Nothing > hilti::rt::Library::save

(

const hilti::rt::filesystem::path &

path

)

const

Save this library under a different path.

Parameters

path	the path where this library should be stored

Returns

nothing or an error

setScope()

void hilti::rt::Library::setScope ( uint64_t *  scope )

static

Sets the passed linker scope.

If a library is currently being loaded through open(), the scope is (stable) hash of that library's absolute path. If we're outside of library loading, this returns a scope that's guaranteed to be unique across all calls to this method.

This method is meant to be called only from the generated linker code to set a module's global scope variable. Its semantics are tailored to that use case.

Parameters

a	non-null pointer to the scope to update.

---

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

• /home/docs/checkouts/readthedocs.org/user_builds/spicy-docs/checkouts/v1.14.0/hilti/runtime/include/library.h
• /home/docs/checkouts/readthedocs.org/user_builds/spicy-docs/checkouts/v1.14.0/hilti/runtime/src/library.cc