com.facebook.buck.core.description

Interface RuleDescription<T extends BuildRuleArg>

Type Parameters:

T - the type of args that the rule implementation uses

All Superinterfaces:

BaseDescription<T>, Description<T>

All Known Subinterfaces:

RuleDescriptionWithInstanceName<T>

All Known Implementing Classes:

LegacyToolchainRuleDescription, PrebuiltDotnetLibraryRuleDescription, SkylarkDescription

public interface RuleDescription<T extends BuildRuleArg>
extends Description<T>

The new modern Description that we will use during the analysis of a rule.

The RuleDescription will offer ruleImpl(RuleAnalysisContext, BuildTarget, BuildRuleArg) method, which provides a set of restricted information via the RuleAnalysisContext to run the rule implementation.

Method Summary

Modifier and Type	Method and Description
default boolean	producesCacheableSubgraph() Whether or not the build rule subgraph produced by this Description is safe to cache in IncrementalActionGraphGenerator for incremental action graph generation.
ProviderInfoCollection	ruleImpl(RuleAnalysisContext context, BuildTarget target, T args) Runs the rule implementation during the analysis phase.

Methods inherited from interface com.facebook.buck.core.description.BaseDescription

getConfigurationDeps, getConstructorArgType

Method Detail

producesCacheableSubgraph

default boolean producesCacheableSubgraph()

Description copied from interface: Description

Whether or not the build rule subgraph produced by this Description is safe to cache in IncrementalActionGraphGenerator for incremental action graph generation.

Specified by:

producesCacheableSubgraph in interface Description<T extends BuildRuleArg>

ruleImpl

ProviderInfoCollection ruleImpl(RuleAnalysisContext context,
                                BuildTarget target,
                                T args)
                         throws ActionCreationException,
                                RuleAnalysisException

Runs the rule implementation during the analysis phase. The rule implementation should create the propagated Providers and corresponding InfoInterfaces, and register its corresponding actions.

Parameters:

context - a RuleAnalysisContext containing all the information usable by this rule for it's analysis and constructive of its corresponding Provider and BuildRule graph.

target - the BuildTarget of this rule

args - The args of type T that this rule uses to rule its analysis

Returns:

a ProviderInfoCollection that contains all the Provider and the corresponding InfoInterface to be propagated by this rule.

Throws:

ActionCreationException - If an action cannot be created correctly

RuleAnalysisException - If the rule implementation could not run as expected. e.g. if the implementation method of a User Defined Rule fails to eval