com.facebook.buck.features.rust

Class RustCompileRule

java.lang.Object

com.facebook.buck.core.rules.impl.AbstractBuildRule

com.facebook.buck.rules.modern.ModernBuildRule<com.facebook.buck.features.rust.RustCompileRule.Impl>

com.facebook.buck.features.rust.RustCompileRule

All Implemented Interfaces:

BuildEngineAction, AllowsNonAnnotatedFields, SupportsInputBasedRuleKey, BuildRule, HasNameAndType, Comparable<BuildRule>

public class RustCompileRule
extends ModernBuildRule<com.facebook.buck.features.rust.RustCompileRule.Impl>

Generate a rustc command line with all appropriate dependencies in place.

Constructor Summary

Constructors

Modifier

Constructor and Description

protected

RustCompileRule(BuildTarget buildTarget, ProjectFilesystem projectFilesystem, SourcePathRuleFinder ruleFinder, String filename, Tool compiler, Linker linker, com.google.common.collect.ImmutableList<Arg> args, com.google.common.collect.ImmutableList<Arg> depArgs, com.google.common.collect.ImmutableList<Arg> linkerArgs, com.google.common.collect.ImmutableSortedMap<String,Arg> environment, com.google.common.collect.ImmutableSortedMap<SourcePath,Optional<String>> mappedSources, String rootModule, com.facebook.buck.features.rust.RustBuckConfig.RemapSrcPaths remapSrcPaths, Optional<String> xcrunSdkPath) Work out how to invoke the Rust compiler, rustc.

Method Summary

Modifier and Type	Method and Description
static RustCompileRule	from(SourcePathRuleFinder ruleFinder, BuildTarget buildTarget, ProjectFilesystem projectFilesystem, String filename, Tool compiler, Linker linker, com.google.common.collect.ImmutableList<Arg> args, com.google.common.collect.ImmutableList<Arg> depArgs, com.google.common.collect.ImmutableList<Arg> linkerArgs, com.google.common.collect.ImmutableSortedMap<String,Arg> environment, com.google.common.collect.ImmutableSortedMap<SourcePath,Optional<String>> mappedSources, String rootModule, com.facebook.buck.features.rust.RustBuckConfig.RemapSrcPaths remapSrcPaths, Optional<String> xcrunSdkPath)
protected static Path	getOutputDir(BuildTarget target, ProjectFilesystem filesystem)
SourcePath	getSourcePathToOutput()

Methods inherited from class com.facebook.buck.rules.modern.ModernBuildRule

compareTo, getBuildable, getBuildCellPathFactory, getBuildDeps, getBuildSteps, getOutputPathResolver, getSetupStepsForBuildable, getSourcePath, getSourcePaths, injectFieldsIfNecessary, inputBasedRuleKeyIsEnabled, recordOutputs, recordOutputs, recordOutputs, stepsForBuildable, stepsForBuildable, updateBuildRuleResolver

Methods inherited from class com.facebook.buck.core.rules.impl.AbstractBuildRule

equals, getBuildTarget, getDependencies, getProjectFilesystem, getSourcePathOutputs, getType, hasBuildSteps, hashCode, injectFields, isCacheable, toString

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.facebook.buck.core.rules.attr.SupportsInputBasedRuleKey

isSupported

Methods inherited from interface com.facebook.buck.core.rules.BuildRule

getBuildTarget, getFullyQualifiedName, getProjectFilesystem, hasBuildSteps, isCacheable, outputFileCanBeCopied, shouldRespectInputSizeLimitForRemoteExecution, toString

Methods inherited from interface com.facebook.buck.core.build.action.BuildEngineAction

getDependencies, getSourcePathOutputs

Methods inherited from interface com.facebook.buck.core.rules.HasNameAndType

getType

Constructor Detail

RustCompileRule

protected RustCompileRule(BuildTarget buildTarget,
                          ProjectFilesystem projectFilesystem,
                          SourcePathRuleFinder ruleFinder,
                          String filename,
                          Tool compiler,
                          Linker linker,
                          com.google.common.collect.ImmutableList<Arg> args,
                          com.google.common.collect.ImmutableList<Arg> depArgs,
                          com.google.common.collect.ImmutableList<Arg> linkerArgs,
                          com.google.common.collect.ImmutableSortedMap<String,Arg> environment,
                          com.google.common.collect.ImmutableSortedMap<SourcePath,Optional<String>> mappedSources,
                          String rootModule,
                          com.facebook.buck.features.rust.RustBuckConfig.RemapSrcPaths remapSrcPaths,
                          Optional<String> xcrunSdkPath)

Work out how to invoke the Rust compiler, rustc.

In Rust, a crate is the equivalent of a package in other languages. It's also the basic unit of compilation.

A crate can either be a "binary crate" - which generates an executable - or a "library crate", which makes an .rlib file. .rlib files contain both interface details (function signatures, inline functions, macros, etc) and compiled object code, and so are equivalent to both header files and library archives. There are also dynamic crates which compile to .so files.

All crates are compiled from at least one source file, which is its main (or top, or root) module. It may have references to other modules, which may be in other source files. Rustc only needs the main module filename and will find the rest of the source files from there (akin to #include in C/C++). If the crate also has dependencies on other crates, then those .rlib files must also be passed to rustc for the interface details, and to be linked if its a binary crate.

Method Detail

from

public static RustCompileRule from(SourcePathRuleFinder ruleFinder,
                                   BuildTarget buildTarget,
                                   ProjectFilesystem projectFilesystem,
                                   String filename,
                                   Tool compiler,
                                   Linker linker,
                                   com.google.common.collect.ImmutableList<Arg> args,
                                   com.google.common.collect.ImmutableList<Arg> depArgs,
                                   com.google.common.collect.ImmutableList<Arg> linkerArgs,
                                   com.google.common.collect.ImmutableSortedMap<String,Arg> environment,
                                   com.google.common.collect.ImmutableSortedMap<SourcePath,Optional<String>> mappedSources,
                                   String rootModule,
                                   com.facebook.buck.features.rust.RustBuckConfig.RemapSrcPaths remapSrcPaths,
                                   Optional<String> xcrunSdkPath)

getOutputDir

protected static Path getOutputDir(BuildTarget target,
                                   ProjectFilesystem filesystem)

getSourcePathToOutput

public SourcePath getSourcePathToOutput()

Specified by:

getSourcePathToOutput in interface BuildRule

Overrides:

getSourcePathToOutput in class ModernBuildRule<com.facebook.buck.features.rust.RustCompileRule.Impl>