Struct samply_api::Api

pub struct Api<'a, 'h: 'a, H: FileAndPathHelper<'h>> { /* private fields */ }

Implementations

impl<'a, 'h: 'a, H: FileAndPathHelper<'h>> Api<'a, 'h, H>

pub fn new(symbol_manager: &'a SymbolManager<'h, H>) -> Self

Create a Api instance which uses the provided SymbolManager.

pub async fn query_api(self, request_url: &str, request_json_data: &str) -> String

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).
• /source/v1: Experimental API. Symbolicates an address and lets you read one of the files in the symbol information for that address.
• /asm/v1: Experimental API. Symbolicates an address and lets you read one of the files in the symbol information for that address.

Trait Implementations

impl<'a, 'h: 'a, H: Clone + FileAndPathHelper<'h>> Clone for Api<'a, 'h, H>

fn clone(&self) -> Api<'a, 'h, H>

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl<'a, 'h: 'a, H: Copy + FileAndPathHelper<'h>> Copy for Api<'a, 'h, H>