Expand description
Backend generators for target languages
Structs§
- Abstract
Iterator - Arg
- Asynchronous
Interface - Declares that the contained interface is asynchronous
- Back
Traced Binding Error - BadName
- Binding
Error - Callback
Function Builder - Class
- Object-oriented class definition
- Class
Builder - Class
Constructor - Class
Constructor Builder - Class
Declaration - C-style structure forward declaration
- Class
Destructor - Class
Method Builder - Class
Settings - Settings that affect class method naming
- Collection
- Collection
Settings - Settings that affect collection function naming
- Constant
Set - Set of constants
- Constant
SetBuilder - Developer
Info - Doc
- DocString
- Enum
- Enum
Builder - Enum
Value - An enum handle and a default validated variant
- Error
Type - A type that wraps an inner enum and provides information on how it maps to exceptions in languages that support them
- Error
Type Builder - Function
- C function
- Function
Builder - Future
Interface - Future
Method - represents a method that initiates an asynchronous operation an eventually completes an abstract future
- Future
Method Builder - Future
Settings - Settings that affect how things are named in future-style callback interfaces
- Handle
- Initializer
- An initializer defines how to construct a struct
- Interface
- Interface
Builder - Interface
Settings - Settings that affect C interface member naming
- Iterator
Settings - Settings that affect iterator function naming
- Library
- Library
Builder - Library
Info - metadata related to the library
- Library
Settings - Settings that affect the names of things
- Method
- Represents an instance method on a class
- Name
- Names in oo_bindgen are subset of allowed C-style identifiers. They are enforce that names are a limited snake case.
- Primitive
Ref - Used for iterator “next” functions to get an optional primitive
- Return
Type - Static
Class - Static class definition
- Static
Class Builder - Static
Method - represents a static method associated with a class
- String
Type - Marker class used to denote the String type with conversions to more specialized types
- Struct
- C-style structure definition
- Struct
Declaration - C-style structure forward declaration
- Struct
Field - Struct
Field Builder - Struct
Initializer Builder - Struct
Method Builder - Synchronous
Interface - Declares that the contained interface is synchronous only
- Typed
Struct Declaration - Typed wrapper around an untyped struct declaration
- Version
- SemVer version as defined by https://semver.org.
- Zero
Parameter Struct Initializer - Struct handle combined with the validated name of one of it’s initializers. The initializer may not take parameters
Enums§
- Basic
Type - Basic types are trivially copyable. They can be used in almost any context within the API model
- Basic
Value - Like a BasicType but with values
- Callback
ArgStruct Field - Types that can be used as a callback argument struct
- Callback
Argument - Types allowed in callback function arguments
- Callback
Return Value - types that can be returned from callback functions
- Constant
Value - Types of constants available
- Default
Callback Return Value - Like CallbackReturnValue, but with a value
- Duration
Type - Durations may be represented in multiple ways in the underlying C API
- Duration
Value - Same as DurationType but with an associated value
- Exception
Type - Type of exception to generate (only used in Java atm)
- Function
ArgStruct Field - Types that can be used in a function struct, some of which might have a default value
- Function
Argument - Types that can be used as native function arguments
- Function
Return Struct Field - Types that can be used in a function return value
- Function
Return Value - types that can be returns from native functions
- Functional
Transform - A flag to the backend that tells it whether or not to optimize callbacks into Functors in the public API This flag is only inspected for functional interfaces
- Initializer
Default - Default value for a field in struct initializer
- Initializer
Type - Iterator
Item Type - Number
Value - A numeric value
- Primitive
- primitive types in most languages
- Primitive
Value - same as primitive, but with a value
- Representation
- How to render a numeric constant
- Struct
Type - Universal
Declaration Or - Structs refs can always be the Universal struct type, but may also be a more specific type depending on context
- Universal
Or - Structs can always be the Universal struct type, but may also be a more specific type depending on context
- Universal
Struct Field - Types that can be used in a universal struct, some of which might have a default value
- Unvalidated
- Validated
- Validated doc reference
- Validated
Default Value
Traits§
Functions§
Type Aliases§
- Abstract
Iterator Handle - Back
Traced - Bind
Result - Callback
ArgStruct Builder - Callback
ArgStruct Declaration - Callback
ArgStruct Handle - Callback
Return Type - Class
Declaration Handle - Class
Handle - Collection
Handle - Constant
SetHandle - Enum
Handle - Error
Type Handle - Function
ArgStruct Builder - Function
ArgStruct Declaration - Function
ArgStruct Handle - Function
Handle - Function
Return Struct Builder - Function
Return Struct Declaration - Function
Return Struct Handle - Function
Return Type - Future
Interface Handle - Future
Method Handle - Interface
Handle - Method
Handle - Static
Class Handle - Struct
Declaration Handle - Universal
Struct Builder - Universal
Struct Declaration - Universal
Struct Handle