ZigBindingsOptions class final

Configuration for generating Dart FFI bindings from a Zig package.

Paths are resolved relative to packageRoot. Generation requires zig on PATH; the generated asset ID must match the native build hook's asset.

Constructors

ZigBindingsOptions({required String packageRoot, required String output, String? zigDirectory, String? rootSourceFile, String? assetId, String? target, String? sysroot, bool? linkLibc, bool watch = false})

Creates a bindings generation request.

const

Properties

assetId → String?

Optional override for the generated @DefaultAsset(...) import ID.

final

hashCode → int

The hash code for this object.

no setter, inherited

linkLibc → bool?

Whether C translation should enable libc headers.

final

output → String

Output Dart file path, absolute or relative to packageRoot.

final

packageRoot → String

Package root used for path resolution and asset ID inference.

final

rootSourceFile → String?

Optional Zig root source file, absolute or relative to zigDirectory.

final

runtimeType → Type

A representation of the runtime type of the object.

no setter, inherited

sysroot → String?

Optional target C system root used when translating imported C headers.

final

target → String?

Optional Zig target triple used when translating imported C declarations.

final

watch → bool

Whether the CLI should watch the Zig directory for changes.

final

zigDirectory → String?

Optional Zig project directory, absolute or relative to packageRoot.

final

Methods

noSuchMethod(Invocation invocation) → dynamic

Invoked when a nonexistent method or property is accessed.

inherited

toString() → String

A string representation of this object.

inherited

Operators

operator ==(Object other) → bool

The equality operator.

inherited