isar library

Classes

Abi
An application binary interface (ABI).
AbiSpecificInteger
The supertype of all Abi-specific integer types.
AbiSpecificIntegerMapping
Mapping for a subtype of AbiSpecificInteger.
Allocator
Manages memory on the native heap.
Arena
An Allocator which frees all allocations at the same time.
Array<T extends NativeType>
A fixed-sized array of Ts.
BinaryReader
BinaryWriter
Bool
Represents a native bool in C.
ByteBuffer
A sequence of bytes underlying a typed data object.
ByteData
A fixed-length, random-access sequence of bytes that also provides random and unaligned access to the fixed-width integers and floating point numbers represented by those bytes.
BytesBuilder
Builds a list of bytes, allowing bytes and lists of bytes to be added at the end.
Char
The C char type.
Collection
CollectionSchema<OBJ>
CompositeIndex
Dart_CObject
Opaque, not exposing it's members.
DartRepresentationOf
DefaultAsset
Annotation specifying the default asset ID for the current library.
DistinctProperty
Double
Represents a native 64 bit double in C.
DynamicLibrary
A dynamically loaded native library.
Endian
Describes endianness to be used when accessing or updating a sequence of bytes.
FilterCondition<T>
FilterGroup
FilterNot
FilterOperation
Finalizable
Marker interface for objects which should not be finalized too soon.
Float
Represents a native 32 bit float in C.
Float32List
A fixed-length list of IEEE 754 single-precision binary floating-point numbers that is viewable as a TypedData.
Float32x4
Float32x4 immutable value type and operations.
Float32x4List
A fixed-length list of Float32x4 numbers that is viewable as a TypedData.
Float64List
A fixed-length list of IEEE 754 double-precision binary floating-point numbers that is viewable as a TypedData.
Float64x2
Float64x2 immutable value type and operations.
Float64x2List
A fixed-length list of Float64x2 numbers that is viewable as a TypedData.
Handle
Represents Dart_Handle from dart_api.h in C.
Id
Ignore
Index
Annotate properties to build an index for the annotated property.
Int
The C int type.
Int16
Represents a native signed 16 bit integer in C.
Int16List
A fixed-length list of 16-bit signed integers that is viewable as a TypedData.
Int32
Represents a native signed 32 bit integer in C.
Int32List
A fixed-length list of 32-bit signed integers that is viewable as a TypedData.
Int32x4
Int32x4 and operations.
Int32x4List
A fixed-length list of Int32x4 numbers that is viewable as a TypedData.
Int64
Represents a native signed 64 bit integer in C.
Int64List
A fixed-length list of 64-bit signed integers that is viewable as a TypedData.
Int8
Represents a native signed 8 bit integer in C.
Int8List
A fixed-length list of 8-bit signed integers.
IntPtr
The C intptr_t type.
Isar
An instance of the Isar Database.
IsarCollection<OBJ>
IsarTypeAdapter<T>
LinkFilter
Long
The C long int, aka. long, type.
LongLong
The C long long type.
Name
Native<T>
Annotation binding an external declaration to its native implementation.
NativeApi
Utilities for accessing the Dart VM API from Dart code or from C code via dart_api_dl.h.
NativeCallable<T extends Function>
A native callable which listens for calls to a native function.
NativeFinalizer
A native finalizer which can be attached to Dart objects.
NativeFunction<T extends Function>
Represents a function type in C.
NativeType
NativeType's subtypes represent a native type in C.
Opaque
Opaque's subtypes represent opaque types in C.
Packed
Annotation to specify on Struct subtypes to indicate that its members need to be packed.
Pointer<T extends NativeType>
Represents a pointer into the native C memory. Cannot be extended.
QAfterFilterCondition
QAfterFilterOperator
QAfterLimit
QAfterOffset
QAfterSortBy
QAfterWhere
QAfterWhereClause
QDistinct
QFilter
QFilterCondition
QFilterOperator
QLimit
QOffset
QQueryOperations
QQueryProperty
QSortBy
QSortThenBy
Query<T>
QueryBuilder<OBJ, R, S>
QWhere
QWhereClause
QWhereOr
RawObject
Short
The C short type.
SignedChar
The C signed char type.
Size
The C size_t type.
Size32
SortProperty
Struct
The supertype of all FFI struct types.
TypeConverter<T, I>
TypedData
A typed view of a sequence of bytes.
Uint16
Represents a native unsigned 16 bit integer in C.
Uint16List
A fixed-length list of 16-bit unsigned integers that is viewable as a TypedData.
Uint32
Represents a native unsigned 32 bit integer in C.
Uint32List
A fixed-length list of 32-bit unsigned integers that is viewable as a TypedData.
Uint64
Represents a native unsigned 64 bit integer in C.
Uint64List
A fixed-length list of 64-bit unsigned integers that is viewable as a TypedData.
Uint8
Represents a native unsigned 8 bit integer in C.
Uint8ClampedList
A fixed-length list of 8-bit unsigned integers.
Uint8List
A fixed-length list of 8-bit unsigned integers.
UintPtr
The C uintptr_t type.
Union
The supertype of all FFI union types.
UnmodifiableByteBufferView
A read-only view of a ByteBuffer.
UnmodifiableByteDataView
A read-only view of a ByteData.
UnmodifiableFloat32ListView
View of a Float32List that disallows modification.
UnmodifiableFloat32x4ListView
View of a Float32x4List that disallows modification.
UnmodifiableFloat64ListView
View of a Float64List that disallows modification.
UnmodifiableFloat64x2ListView
View of a Float64x2List that disallows modification.
UnmodifiableInt16ListView
View of a Int16List that disallows modification.
UnmodifiableInt32ListView
View of a Int32List that disallows modification.
UnmodifiableInt32x4ListView
View of a Int32x4List that disallows modification.
UnmodifiableInt64ListView
View of a Int64List that disallows modification.
UnmodifiableInt8ListView
View of a Int8List that disallows modification.
UnmodifiableUint16ListView
View of a Uint16List that disallows modification.
UnmodifiableUint32ListView
View of a Uint32List that disallows modification.
UnmodifiableUint64ListView
View of a Uint64List that disallows modification.
UnmodifiableUint8ClampedListView
View of a Uint8ClampedList that disallows modification.
UnmodifiableUint8ListView
View of a Uint8List that disallows modification.
UnsignedChar
The C unsigned char type.
UnsignedInt
The C unsigned int type.
UnsignedLong
The C unsigned long int, aka. unsigned long, type.
UnsignedLongLong
The C unsigned long long type.
UnsignedShort
The C unsigned short type.
Unsized
Utf16
The contents of a native zero-terminated array of UTF-16 code units.
Utf8
The contents of a native zero-terminated array of UTF-8 code units.
VarArgs<T extends Record>
The types of variadic arguments passed in C.
Void
Represents a void type in C.
WChar
The C wchar_t type.
WhereClause

Extensions

AbiSpecificIntegerArray on Array<AbiSpecificInteger>
Bounds checking indexing methods on Arrays of AbiSpecificInteger.
AbiSpecificIntegerPointer on Pointer<T>
Extension on Pointer specialized for the type argument AbiSpecificInteger.
AllocatorAlloc on Allocator
Extension on Allocator to provide allocation with NativeType.
ArrayArray on Array<Array<T>>
Bounds checking indexing methods on Arrays of Array.
BoolArray on Array<Bool>
Bounds checking indexing methods on Arrays of Bool.
BoolPointer on Pointer<Bool>
Extension on Pointer specialized for the type argument Bool.
DoubleArray on Array<Double>
Bounds checking indexing methods on Arrays of Double.
DoublePointer on Pointer<Double>
Extension on Pointer specialized for the type argument Double.
DynamicLibraryExtension on DynamicLibrary
Method which must not be invoked dynamically.
FloatArray on Array<Float>
Bounds checking indexing methods on Arrays of Float.
FloatPointer on Pointer<Float>
Extension on Pointer specialized for the type argument Float.
Int16Array on Array<Int16>
Bounds checking indexing methods on Arrays of Int16.
Int16Pointer on Pointer<Int16>
Extension on Pointer specialized for the type argument Int16.
Int32Array on Array<Int32>
Bounds checking indexing methods on Arrays of Int32.
Int32Pointer on Pointer<Int32>
Extension on Pointer specialized for the type argument Int32.
Int64Array on Array<Int64>
Bounds checking indexing methods on Arrays of Int64.
Int64Pointer on Pointer<Int64>
Extension on Pointer specialized for the type argument Int64.
Int8Array on Array<Int8>
Bounds checking indexing methods on Arrays of Int8.
Int8Pointer on Pointer<Int8>
Extension on Pointer specialized for the type argument Int8.
NativeFunctionPointer on Pointer<NativeFunction<NF>>
Extension on Pointer specialized for the type argument NativeFunction.
NativePort on SendPort
Extension to retrieve the native Dart_Port from a SendPort.
PointerArray on Array<Pointer<T>>
Bounds checking indexing methods on Arrays of Pointer.
PointerPointer on Pointer<Pointer<T>>
Extension on Pointer specialized for the type argument Pointer.
QueryAggregation on Query<T?>
QueryDateAggregation on Query<T>
QueryExecute on QueryBuilder<OBJ, R, QQueryOperations>
QueryExecuteAggregation on QueryBuilder<OBJ, T?, QQueryOperations>
QueryExecuteDateAggregation on QueryBuilder<OBJ, DateTime?, QQueryOperations>
QueryFilter on QueryBuilder<OBJ, R, QFilter>
QueryFilterAndOr on QueryBuilder<OBJ, R, QFilterOperator>
QueryFilterNoGroups on QueryBuilder<OBJ, R, QFilterCondition>
QueryFilterNot on QueryBuilder<OBJ, R, QFilterCondition>
QueryLimit on QueryBuilder<OBJ, R, QLimit>
QueryOffset on QueryBuilder<OBJ, R, QOffset>
QueryOptional on QueryBuilder<OBJ, OBJ, S>
QueryRepeat on QueryBuilder<OBJ, OBJ, S>
QueryWhereOr on QueryBuilder<OBJ, R, QWhereOr>
StringUtf16Pointer on String
Extension method for converting a String to a Pointer<Utf16>.
StringUtf8Pointer on String
Extension method for converting a String to a Pointer<Utf8>.
StructArray on Array<T>
Bounds checking indexing methods on Arrays of Struct.
StructPointer on Pointer<T>
Extension on Pointer specialized for the type argument Struct.
Uint16Array on Array<Uint16>
Bounds checking indexing methods on Arrays of Uint16.
Uint16Pointer on Pointer<Uint16>
Extension on Pointer specialized for the type argument Uint16.
Uint32Array on Array<Uint32>
Bounds checking indexing methods on Arrays of Uint32.
Uint32Pointer on Pointer<Uint32>
Extension on Pointer specialized for the type argument Uint32.
Uint64Array on Array<Uint64>
Bounds checking indexing methods on Arrays of Uint64.
Uint64Pointer on Pointer<Uint64>
Extension on Pointer specialized for the type argument Uint64.
Uint8Array on Array<Uint8>
Bounds checking indexing methods on Arrays of Uint8.
Uint8Pointer on Pointer<Uint8>
Extension on Pointer specialized for the type argument Uint8.
UnionArray on Array<T>
Bounds checking indexing methods on Arrays of Union.
UnionPointer on Pointer<T>
Extension on Pointer specialized for the type argument Union.
Utf16Pointer on Pointer<Utf16>
Extension method for converting aPointer<Utf16> to a String.
Utf8Pointer on Pointer<Utf8>
Extension method for converting aPointer<Utf8> to a String.

Constants

calloc → const Allocator
Manages memory on the native heap.
kIsWeb → const bool
malloc → const Allocator
Manages memory on the native heap.
unsized → const Unsized
This NativeType does not have predefined size.

Properties

nullptr → Pointer<Never>
Represents a pointer into the native C memory corresponding to 'NULL', e.g. a pointer with address 0.
final
zoneArena → Arena
A zone-specific Arena.
no setter

Functions

sizeOf<T extends NativeType>() → int
Number of bytes used by native type T.
using<R>(R computation(Arena), [Allocator wrappedAllocator = calloc]) → R
Runs computation with a new Arena, and releases all allocations at the end.
withZoneArena<R>(R computation(), [Allocator wrappedAllocator = calloc]) → R
Creates a zoned Arena to manage native resources.

Typedefs

Dart_NativeMessageHandler = Void Function(Int64, Pointer<Dart_CObject>)
FilterQuery<OBJ> = QueryBuilder<OBJ, OBJ, QAfterFilterCondition> Function(QueryBuilder<OBJ, OBJ, QFilterCondition> q)
IsarCloseCallback = void Function(String)
Callback for a release Isar instance.
IsarOpenCallback = void Function(Isar)
Callback for a newly opened Isar instance.
NativeFinalizerFunction = NativeFunction<Void Function(Pointer<Void> token)>
The native function type for NativeFinalizers.
QueryOption<OBJ, S, RS> = QueryBuilder<OBJ, OBJ, RS> Function(QueryBuilder<OBJ, OBJ, S> q)
QueryRepeatModifier<OBJ, S, RS, E> = QueryBuilder<OBJ, OBJ, RS> Function(QueryBuilder<OBJ, OBJ, S> q, E element)

Exceptions / Errors

IsarError