Struct symbolic_symcache::SymCacheWriter

pub struct SymCacheWriter<W> { /* fields omitted */ }

A high level writer that can construct SymCaches.

When using this writer directly, make sure to call finish at the end, so that all segments are written to the underlying writer and the header is fixed up with the references. Since segments are consecutive chunks of memory, this can only be done once at the end of the writing process.

Implementations

impl<W> SymCacheWriter<W> where
    W: Write + Seek, 

pub fn write_object<'d, 'o, O>(
    object: &'o O,
    target: W
) -> Result<W, SymCacheError> where
    O: ObjectLike<'d, 'o>,
    O::Error: Error + Send + Sync + 'static, 

Converts an entire object into a SymCache.

Any object which implements ObjectLike can be written into a SymCache by this function. This already implicictly calls SymCacheWriter::finish, thus consuming the writer.

pub fn new(writer: W) -> Result<Self, SymCacheError>

Constructs a new SymCacheWriter and writes the preamble.

pub fn set_arch(&mut self, arch: Arch)

Sets the CPU architecture of this SymCache.

pub fn set_debug_id(&mut self, debug_id: DebugId)

Sets the debug identifier of this SymCache.

pub fn add_symbol(&mut self, symbol: Symbol<'_>) -> Result<(), SymCacheError>

Adds a new symbol to this SymCache.

Symbols must be added in ascending order using this method. This will emit a function record internally.

pub fn add_function(
    &mut self,
    function: Function<'_>
) -> Result<(), SymCacheError>

Cleans up a function by recursively removing all empty inlinees, then inserts it into the writer.

Does nothing if the function is empty itself. Functions must be added in ascending order using this method. This emits a function record for this function and for each inlinee recursively.

pub fn finish(self) -> Result<W, SymCacheError>

Persists all open segments to the writer and fixes up the header.