com.facebook.buck.core.rules.providers.lib

Class RunInfo

java.lang.Object

com.facebook.buck.core.starlark.compatible.BuckStarlarkStructObject

com.facebook.buck.core.rules.providers.impl.BuiltInProviderInfo<RunInfo>

com.facebook.buck.core.rules.providers.lib.RunInfo

All Implemented Interfaces:

AddsToRuleKey, CommandLineArgs, CommandLineArgsApi, ProviderInfo<RunInfo>, SkylarkProviderInfo, com.google.devtools.build.lib.skylarkinterface.SkylarkPrintable, com.google.devtools.build.lib.skylarkinterface.SkylarkValue, com.google.devtools.build.lib.syntax.ClassObject

Direct Known Subclasses:

ImmutableRunInfo

public abstract class RunInfo
extends BuiltInProviderInfo<RunInfo>
implements CommandLineArgs

The standard Provider that describes how to run a given build rule's outputs.

Nested Class Summary

Nested classes/interfaces inherited from interface com.facebook.buck.core.rules.actions.lib.args.CommandLineArgs

CommandLineArgs.ArgAndFormatString

Field Summary

Fields

Modifier and Type	Field and Description
static BuiltInProvider<RunInfo>	PROVIDER

Fields inherited from interface com.facebook.buck.core.rules.actions.lib.args.CommandLineArgs

DEFAULT_FORMAT_STRING

Constructor Summary

Constructors

Constructor and Description
RunInfo()

Method Summary

Modifier and Type	Method and Description
abstract CommandLineArgs	args()
abstract com.google.common.collect.ImmutableMap<String,String>	env()
java.util.stream.Stream<CommandLineArgs.ArgAndFormatString>	getArgsAndFormatStrings()
com.google.common.collect.ImmutableSortedMap<String,String>	getEnvironmentVariables()
int	getEstimatedArgsCount() Get the approximate number of arguments that will be returned for CommandLineArgs.getArgsAndFormatStrings()
static RunInfo	instantiateFromSkylark(com.google.devtools.build.lib.syntax.SkylarkDict<String,String> env, Object args) Create an instance of RunInfo from skylark arguments.
void	visitInputsAndOutputs(java.util.function.Consumer<Artifact> inputs, java.util.function.Consumer<OutputArtifact> outputs) Add any artifacts from CommandLineArgs.getArgsAndFormatStrings() to inputs and outputs, inferring based on type

Methods inherited from class com.facebook.buck.core.rules.providers.impl.BuiltInProviderInfo

getDeclaredClass, getProvider, getProviderInfo, isImmutable

Methods inherited from class com.facebook.buck.core.starlark.compatible.BuckStarlarkStructObject

getErrorMessageForUnknownField, getFieldNames, getMethods, getValue, repr

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface com.facebook.buck.core.rules.actions.lib.args.CommandLineArgsApi

isImmutable, repr

Methods inherited from interface com.google.devtools.build.lib.skylarkinterface.SkylarkValue

isHashable

Methods inherited from interface com.google.devtools.build.lib.skylarkinterface.SkylarkPrintable

debugPrint, str

Field Detail

PROVIDER

public static final BuiltInProvider<RunInfo> PROVIDER

Constructor Detail

RunInfo

public RunInfo()

Method Detail

env

public abstract com.google.common.collect.ImmutableMap<String,String> env()

Returns:

any additional environment variables that should be used when executing

args

public abstract CommandLineArgs args()

Returns:

the command line arguments to use when executing

instantiateFromSkylark

public static RunInfo instantiateFromSkylark(com.google.devtools.build.lib.syntax.SkylarkDict<String,String> env,
                                             Object args)
                                      throws com.google.devtools.build.lib.syntax.EvalException

Create an instance of RunInfo from skylark arguments.

Parameters:

env - environment variables to use when executing

args - arguments used to execute this program. Must be one of CommandLineArgsBuilder, CommandLineArgs or SkylarkList.

Returns:

An instance of RunInfo with immutable env() and args()

Throws:

com.google.devtools.build.lib.syntax.EvalException - the type passed in was incorrect

getEnvironmentVariables

public com.google.common.collect.ImmutableSortedMap<String,String> getEnvironmentVariables()

Specified by:

getEnvironmentVariables in interface CommandLineArgs

Returns:

Get a map of all environment variables that need to be added to execute this program.

getArgsAndFormatStrings

public java.util.stream.Stream<CommandLineArgs.ArgAndFormatString> getArgsAndFormatStrings()

Specified by:

getArgsAndFormatStrings in interface CommandLineArgs

Returns:

Get a stream of all raw argument objects that can be stringified with something like CommandLineArgStringifier.asString(ArtifactFilesystem, boolean, Object)

getEstimatedArgsCount

public int getEstimatedArgsCount()

Description copied from interface: CommandLineArgs

Get the approximate number of arguments that will be returned for CommandLineArgs.getArgsAndFormatStrings()

This can be handy to pre-size destination collections

Specified by:

getEstimatedArgsCount in interface CommandLineArgs

Returns:

the approximate number of arguments. If retrieving the accurate count is efficient, a correct number is preferred. However if getting a correct number is impossible or expensive, an approximation is acceptable.

visitInputsAndOutputs

public void visitInputsAndOutputs(java.util.function.Consumer<Artifact> inputs,
                                  java.util.function.Consumer<OutputArtifact> outputs)

Description copied from interface: CommandLineArgs

Add any artifacts from CommandLineArgs.getArgsAndFormatStrings() to inputs and outputs, inferring based on type

Specified by:

visitInputsAndOutputs in interface CommandLineArgs