Available on crate feature
igvm-c only.Expand description
Provides an alternative interface for using the IGVM crate that is suitable for calling from C.
Structs§
- Igvm
Header Section - Igvm
Result - An enumeration of the possible results that can be returned from C API functions. Some of the extern “C” functions return a positive value representing a handle or a count on success, or an IgvmResult value on error. Therefore all error values must be negative.
Functions§
- igvm_
free - Free a handle that was created with a prevoius call to
igvm_new_from_binary(). - igvm_
free_ buffer - Frees a buffer.
- igvm_
get_ ⚠buffer - Returns a pointer to the array of bytes in a buffer.
- igvm_
get_ buffer_ size - Returns the size of a buffer.
- igvm_
get_ header - Prepare a buffer containing the header data in binary form for the entry with the given index for a particular section in a previously parsed IGVM file.
- igvm_
get_ header_ data - Prepare a buffer containing the associated file data in binary form for the entry with the given index for a particular section in a previously parsed IGVM file.
- igvm_
get_ header_ type - Get the header type for the entry with the given index for a particular section in a previously parsed IGVM file.
- igvm_
header_ count - Get the count of headers for a particular section in a previously parsed IGVM file.
- igvm_
new_ ⚠from_ binary - Parse a binary array containing an IGVM file. The contents of the file are validated and, if valid, a handle is returned to represent the file. This handle must be freed with a call to igvm_free().