code_assets library

This package provides the API for code assets to be used with package:hooks.

A CodeAsset is an asset containing executable code which respects the native application binary interface (ABI). These assets are bundled with a Dart or Flutter application. They can be produced by compiling C, C++, Objective-C, Rust, or Go code for example.

This package is used in a build hook (hook/build.dart) to inform the Dart and Flutter SDKs about the code assets that need to be bundled with an application.

A CodeAsset can be added to the BuildOutputBuilder in a build hook as follows:

import 'package:code_assets/code_assets.dart';
import 'package:hooks/hooks.dart';

void main(List<String> args) async {
  await build(args, (input, output) async {
    if (input.config.buildCodeAssets) {
      final packageName = input.packageName;
      final assetPathInPackage = input.packageRoot.resolve('...');
      final assetPathDownload = input.outputDirectoryShared.resolve('...');

      output.assets.code.add(
        CodeAsset(
          package: packageName,
          name: '...',
          linkMode: DynamicLoadingBundled(),
          file: assetPathInPackage,
        ),
      );
    }
  });
}

The CodeConfig nested in the HookInput gives access to configuration specifically for compiling code assets. For example CodeConfig.targetOS and CodeConfig.targetArchitecture give access to the target OS and architecture that the code assets are compiled for:

import 'package:code_assets/code_assets.dart';
import 'package:hooks/hooks.dart';

void main(List<String> args) async {
  await build(args, (input, output) async {
    if (input.config.buildCodeAssets) {
      final codeConfig = input.config.code;
      final targetOS = codeConfig.targetOS;
      final targetArchitecture = codeConfig.targetArchitecture;

      // Add some code assets.
    }
  });
}

For more information about build hooks see dart.dev/tools/hooks.