Pigeon class

Tool for generating code to facilitate platform channels usage.

Constructors

Pigeon()

Properties

hashCode → int

The hash code for this object.

no setter, inherited

runtimeType → Type

A representation of the runtime type of the object.

no setter, inherited

Methods

noSuchMethod(Invocation invocation) → dynamic

Invoked when a nonexistent method or property is accessed.

inherited

parseFile(String inputPath, {String? sdkPath}) → ParseResults

Reads the file located at path and generates ParseResults by parsing it. types optionally filters out what datatypes are actually parsed. sdkPath for specifying the Dart SDK path for AnalysisContextCollection.

toString() → String

A string representation of this object.

inherited

Operators

operator ==(Object other) → bool

The equality operator.

inherited

Static Properties

usage → String

String that describes how the tool is used.

no setter

Static Methods

parseArgs(List<String> args) → PigeonOptions

Convert command-line arguments to PigeonOptions.

printErrors(List<Error> errors) → void

Print a list of errors to stderr.

run(List<String> args, {List<GeneratorAdapter>? adapters, String? sdkPath}) → Future<int>

The 'main' entrypoint used by the command-line tool. args are the command-line arguments. The optional parameter adapters allows you to customize the generators that pigeon will use. The optional parameter sdkPath allows you to specify the Dart SDK path.

runWithOptions(PigeonOptions options, {List<GeneratorAdapter>? adapters, String? sdkPath, bool injectOverflowTypes = false}) → Future<int>

The 'main' entrypoint used by external packages. options is used when running the code generator. The optional parameter adapters allows you to customize the generators that pigeon will use. The optional parameter sdkPath allows you to specify the Dart SDK path.

setup() → Pigeon

Create and setup a Pigeon instance.