Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Add some more options to RustBuilder #21

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Add some more options to RustBuilder #21

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
93 changes: 70 additions & 23 deletions native_toolchain_rust/lib/src/builder.dart
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -104,9 +104,12 @@ class RustToolchain {
class RustBuilder {
RustBuilder({
required this.package,
this.toolchain,
required this.cratePath,
required this.buildConfig,
this.buildMode = CargoBuildMode.build,
this.toolchain,
this.cratePath,
this.crateType,
this.crateName,
this.extraCargoArgs = const [],
this.release = true,
this.assetName,
Expand All @@ -118,6 +121,8 @@ class RustBuilder {
/// Custom Rust toolchain to use (optional).
final RustToolchain? toolchain;

final CargoBuildMode buildMode;

/// Package name. This will be part of asset Id.
/// For example package `my_package` with crate name `my_crate` will have
/// asset id `package:my_package/my_crate`:
Expand All @@ -132,7 +137,12 @@ class RustBuilder {
final String? assetName;

/// Path to the Rust crate directory relative to the package root.
final String cratePath;
final String? cratePath;

/// Name of the crate to be built.
final String? crateName;

final CrateType? crateType;
Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

These need some docs - just wanted to check if I am on the right path first, if yes I will go through this and clean it up.


/// Build config provided to the build callback from `native_assets_cli`.
final BuildConfig buildConfig;
Expand All @@ -158,24 +168,37 @@ class RustBuilder {
/// Optional logger for verbose output.
final Logger? logger;

Future<void> run({required BuildOutput output}) async {
Future<void> run({required BuildOutput output, String? linkInPackage}) async {
assert(
buildConfig.linkingEnabled || linkInPackage == null,
'linkInPackage can only be provided if config.linkingEnabled is true.',
);

final toolchain = this.toolchain ?? await RustToolchain.withName('stable');

final manifestPath = buildConfig.packageRoot
.resolve(cratePath)
.makeDirectory()
.resolve('Cargo.toml');
final manifestInfo = CrateManifestInfo.load(manifestPath);
final manifestPath = cratePath != null
? buildConfig.packageRoot
.resolve(cratePath!)
.makeDirectory()
.resolve('Cargo.toml')
: null;
final manifestInfo =
manifestPath != null ? CrateManifestInfo.load(manifestPath) : null;
final packageName = crateName ?? manifestInfo?.packageName;

if (packageName == null) {
throw ArgumentError('Either `crateName` or `cratePath` must be set.');
}

final outDir =
buildConfig.outputDirectory.resolve('native_toolchain_rust/');

final dylibName =
buildConfig.targetOS.dylibFileName(manifestInfo.packageName);
final dylibName = buildConfig.targetOS.dylibFileName(packageName);

if (buildConfig.dryRun) {
output.addAsset(NativeCodeAsset(
package: package,
name: assetName ?? manifestInfo.packageName,
name: assetName ?? packageName,
linkMode: DynamicLoadingBundled(),
os: buildConfig.targetOS,
file: Uri.file(dylibName),
Expand All @@ -202,17 +225,17 @@ class RustBuilder {
'run',
toolchain.name,
'cargo',
'build',
'--manifest-path',
manifestPath.toFilePath(),
'-p',
manifestInfo.packageName,
buildMode.name,
if (manifestPath != null) ...[
'--manifest-path',
manifestPath.toFilePath(),
],
...['-p', packageName],
if (effectiveBuildMode == BuildMode.release) '--release',
'--verbose',
'--target',
target.triple,
'--target-dir',
outDir.toFilePath(),
...['--target', target.triple],
...['--target-dir', outDir.toFilePath()],
if (crateType != null) ...['--crate-type', crateType!.rustName],
...extraCargoArgs,
],
environment: await _buildEnvironment(
Expand All @@ -230,13 +253,16 @@ class RustBuilder {

final asset = NativeCodeAsset(
package: package,
name: assetName ?? manifestInfo.packageName,
name: assetName ?? packageName,
os: buildConfig.targetOS,
architecture: buildConfig.targetArchitecture,
linkMode: DynamicLoadingBundled(),
file: effectiveOutDir.resolve(dylibName),
);
output.addAsset(asset);
output.addAsset(
asset,
linkInPackage: linkInPackage,
);
if (!buildConfig.dryRun) {
_addDependencies(
output: output,
Expand Down Expand Up @@ -313,3 +339,24 @@ extension on Uri {
}
}
}

enum CargoBuildMode {
build,
rustc;
}

enum CrateType {
bin,
lib,
rlib,
dylib,
cdylib,
staticlib,
procMacro('proc-macro');

String get rustName => _rustName ?? name;

final String? _rustName;

const CrateType([this._rustName]);
}