Function profiler_get_symbols::query_api

source · [−]

pub async fn query_api<'h>(
    request_url: &str,
    request_json_data: &str,
    helper: &'h impl FileAndPathHelper<'h>
) -> String

Expand description

This is the main API of this crate. It implements the “Tecken” JSON API, which is also used by the Mozilla symbol server. It’s intended to be used as a drop-in “local symbol server” which gathers its data directly from file artifacts produced during compilation (rather than consulting e.g. a database). The caller needs to implement the FileAndPathHelper trait to provide file system access. The return value is a JSON string.

The following “URLs” are supported:

/symbolicate/v5: This API is documented at https://tecken.readthedocs.io/en/latest/symbolication.html. The returned data has two extra fields: inlines (per address) and module_errors (per job).
/symbolicate/v5-legacy: Like v5, but lacking any data that comes from debug information, i.e. files, lines and inlines. This is faster.
/source/v1: Experimental API. Symbolicates an address and lets you read one of the files in the symbol information for that address.