Expand description
Stable low-level C ABI shared by the RadixDB plugin host and trusted native plugins.
This crate deliberately has no dependency on an engine crate and exports no
Rust-owned allocation across the boundary. The safe authoring API lives in
radixdb-plugin; this crate is the generated bridge and C-oracle surface.
Structs§
- Radix
AbiBatch View V1 - Radix
AbiBinding Entry V1 - Radix
AbiCall Context V1 - Radix
AbiColumn View V1 - Radix
AbiDiagnostic Sink V1 - Radix
AbiDiagnostic V1 - Radix
AbiExternal Type Descriptor V1 - Radix
AbiHash Sink V1 - Radix
AbiHeader V1 - Radix
AbiOperator Class Descriptor V1 - Radix
AbiOperator Descriptor V1 - Radix
AbiPlanner Support Descriptor V1 - Radix
AbiResult Builder V1 - Radix
AbiScalar Function Descriptor V1 - Radix
AbiSlice V1 - Radix
AbiType RefV1 - Radix
AbiU32 Slice V1 - Radix
AbiValue V1 - Borrowed scalar view. Fixed built-ins use
inline_bytes; variable built-ins and external values useborrowed_bytes. A null value zeros both regions. - Radix
Host ApiV1 - Radix
Plugin Descriptor V1
Enums§
Constants§
- ENTRYPOINT_
SYMBOL_ V1 - Exact entrypoint symbol required from every ABI-major-1 shared library.
- NATIVE_
ELF_ MACHINE - ELF machine identity for native extensions on this target.
- RADIX_
ABI_ MAJOR - RADIX_
ABI_ MINOR - RADIX_
ACCESS_ METHOD_ BITMAP - RADIX_
ACCESS_ METHOD_ BTREE - RADIX_
ACCESS_ METHOD_ HASH - RADIX_
ACCESS_ METHOD_ HNSW - RADIX_
BUILTIN_ BOOLEAN - RADIX_
BUILTIN_ BYTES - RADIX_
BUILTIN_ DATE - RADIX_
BUILTIN_ DECIMAL - RADIX_
BUILTIN_ FLOAT - RADIX_
BUILTIN_ INTEGER - RADIX_
BUILTIN_ JSON - RADIX_
BUILTIN_ TEXT - RADIX_
BUILTIN_ TIMESTAMP - RADIX_
BUILTIN_ TYPE_ MAX - RADIX_
BUILTIN_ TYPE_ MIN - Built-in tags admitted by ABI 1.0. Zero is
Nulland is not a stored type. - RADIX_
BUILTIN_ UUID - RADIX_
BUILTIN_ VECTOR - RADIX_
CANCELLATION_ BOUNDED - RADIX_
COLUMN_ LAYOUT_ FIXED - RADIX_
COLUMN_ LAYOUT_ VARIABLE - RADIX_
DESCRIPTOR_ EXTERNAL_ TYPE - RADIX_
DESCRIPTOR_ OPERATOR - RADIX_
DESCRIPTOR_ OPERATOR_ CLASS - RADIX_
DESCRIPTOR_ PLANNER_ SUPPORT - RADIX_
DESCRIPTOR_ SCALAR_ FUNCTION - RADIX_
DIAGNOSTIC_ ABI_ CONTRACT - RADIX_
DIAGNOSTIC_ CANCELLED - RADIX_
DIAGNOSTIC_ DEPENDENCY - RADIX_
DIAGNOSTIC_ DOMAIN - RADIX_
DIAGNOSTIC_ INTERNAL - RADIX_
DIAGNOSTIC_ INVALID_ INPUT - RADIX_
DIAGNOSTIC_ LIMIT - RADIX_
DIAGNOSTIC_ PLUGIN_ PANIC - RADIX_
EXTERNAL_ STORAGE_ FIXED - RADIX_
EXTERNAL_ STORAGE_ VARIABLE - RADIX_
HASH_ COMPONENT_ BYTES - RADIX_
HASH_ COMPONENT_ EXTERNAL - RADIX_
HASH_ COMPONENT_ F64_ BITS - RADIX_
HASH_ COMPONENT_ I64 - RADIX_
HASH_ COMPONENT_ U64 - RADIX_
LOG_ DEBUG - RADIX_
LOG_ ERROR - RADIX_
LOG_ INFO - RADIX_
LOG_ WARN - RADIX_
MAX_ DESCRIPTOR_ ENTRIES - RADIX_
MAX_ DIAGNOSTIC_ BYTES - RADIX_
MAX_ EXTERNAL_ VALUE_ BYTES - RADIX_
MAX_ FUNCTION_ ARGUMENTS - RADIX_
MAX_ HASH_ BYTES - RADIX_
MAX_ HASH_ COMPONENTS - RADIX_
MAX_ LOCAL_ ID_ BYTES - RADIX_
MAX_ PLANNER_ SPANS - RADIX_
PACKAGE_ CAP_ ALL - RADIX_
PACKAGE_ CAP_ BATCH_ FUNCTIONS - RADIX_
PACKAGE_ CAP_ EXTERNAL_ TYPES - RADIX_
PACKAGE_ CAP_ OPERATORS - RADIX_
PACKAGE_ CAP_ OPERATOR_ CLASSES - RADIX_
PACKAGE_ CAP_ PLANNER_ SUPPORT - RADIX_
PACKAGE_ CAP_ SCALAR_ FUNCTIONS - RADIX_
RECHECK_ ALWAYS - RADIX_
RECHECK_ EXACT - RADIX_
RESULT_ ITEM_ FLAG_ ALL - RADIX_
RESULT_ ITEM_ FLAG_ NULL - RADIX_
STATUS_ CANCELLED - RADIX_
STATUS_ CONTRACT_ VIOLATION - RADIX_
STATUS_ DEPENDENCY_ MISSING - RADIX_
STATUS_ DOMAIN_ ERROR - RADIX_
STATUS_ INTERNAL_ ERROR - RADIX_
STATUS_ INVALID_ ARGUMENT - RADIX_
STATUS_ LIMIT_ EXCEEDED - RADIX_
STATUS_ OK - RADIX_
STATUS_ PANIC - RADIX_
STATUS_ UNSUPPORTED_ ABI - RADIX_
TYPE_ CAP_ ALL - RADIX_
TYPE_ CAP_ BINARY_ INPUT - RADIX_
TYPE_ CAP_ BINARY_ OUTPUT - RADIX_
TYPE_ CAP_ EQUALITY - RADIX_
TYPE_ CAP_ HASH - RADIX_
TYPE_ CAP_ ORDERING - RADIX_
TYPE_ CAP_ TEXT_ INPUT - RADIX_
TYPE_ CAP_ TEXT_ OUTPUT - RADIX_
TYPE_ REF_ BUILTIN - RADIX_
TYPE_ REF_ EXTERNAL - RADIX_
VALUE_ FLAG_ ALL - RADIX_
VALUE_ FLAG_ NULL - RADIX_
VOLATILITY_ IMMUTABLE - RADIX_
VOLATILITY_ STABLE - RADIX_
VOLATILITY_ VOLATILE
Functions§
- negotiate_
minor - validate_
batch_ ⚠columns - Validate every column after the host has established that the descriptor table and all borrowed column buffers are readable for this call.
- validate_
batch_ view - validate_
call_ context - validate_
column_ ⚠offsets - Validate offset contents after the host has established that the borrowed
u32range is readable for the duration of this call. - validate_
column_ view - validate_
diagnostic - validate_
diagnostic_ sink - validate_
external_ type_ descriptor - validate_
hash_ component - validate_
hash_ sink - validate_
header - validate_
host_ api - validate_
log_ record - validate_
operator_ class_ descriptor - validate_
operator_ descriptor - validate_
optional_ type_ ref - validate_
package_ descriptor_ shallow - validate_
planner_ support_ descriptor - validate_
result_ builder - validate_
result_ item - validate_
scalar_ function_ descriptor - validate_
slice - validate_
type_ ref - validate_
u32_ slice - validate_
value - validate_
value_ ⚠contents - Validate the contents of a structurally valid borrowed scalar payload.
Type Aliases§
- Radix
AbiBatch FnV1 - Radix
AbiBuilder Finish FnV1 - Radix
AbiBuilder Write FnV1 - Radix
AbiCharge Work FnV1 - Radix
AbiCheck Cancelled FnV1 - Radix
AbiCodec FnV1 - Radix
AbiCompare FnV1 - Radix
AbiDiagnostic Write FnV1 - Radix
AbiEqual FnV1 - Radix
AbiHash Append FnV1 - Radix
AbiHash FnV1 - Radix
AbiHost LogFn V1 - Radix
AbiKey Encode FnV1 - Radix
AbiParse FnV1 - Radix
AbiPlanner Support FnV1 - Radix
AbiScalar FnV1 - Radix
AbiStatus V1 - Radix
AbiString V1 - Radix
AbiValidation Result - Radix
Plugin Entrypoint V1 - Function type of the only exported plugin symbol.