com.facebook.buck.features.rust

Enum CrateType

java.lang.Object

java.lang.Enum<CrateType>

com.facebook.buck.features.rust.CrateType

All Implemented Interfaces:

Serializable, Comparable<CrateType>

public enum CrateType
extends Enum<CrateType>

Describe the kinds of crates rustc can generate.

Enum Constant Summary

Enum Constants

Enum Constant and Description
BIN
CDYLIB
CHECK
CHECKBIN
DYLIB
LIB
PROC_MACRO
RLIB
RLIB_PIC
SAVEANALYSIS
SAVEANALYSISBIN
STATIC
STATIC_PIC

Method Summary

Modifier and Type	Method and Description
String	filenameFor(BuildTarget target, String name, CxxPlatform cxxPlatform) Return an appropriate filename for this crate, given its type and the platform.
Flavor	getFlavor()
boolean	isCheck() We're just checking the code, and generating metadata to allow dependents to check.
boolean	isDynamic() Crate dynamically links with its dependents.
boolean	isExecutable() Create generates an executable
boolean	isNative() Return true if this crate type is intended to be a native output (ie, not intended for further processing by the Rust toolchain).
boolean	isPic() Crate needs to be compiled with relocation-model=pic.
boolean	isProcMacro() Return true if this is generating a compiler plugin - ie, it should be linked with a different linker and linker flags.
boolean	isSaveAnalysis() Save-analysis is a more detailed version of check, which saves full type and other information in a json file for consumption by other tools (namely RLS).
boolean	needAllDeps() Linking this crate needs all the dependencies available.
String	toString()
static CrateType	valueOf(String name) Returns the enum constant of this type with the specified name.
static CrateType[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

BIN

public static final CrateType BIN

CHECK

public static final CrateType CHECK

CHECKBIN

public static final CrateType CHECKBIN

SAVEANALYSIS

public static final CrateType SAVEANALYSIS

SAVEANALYSISBIN

public static final CrateType SAVEANALYSISBIN

LIB

public static final CrateType LIB

RLIB

public static final CrateType RLIB

RLIB_PIC

public static final CrateType RLIB_PIC

DYLIB

public static final CrateType DYLIB

CDYLIB

public static final CrateType CDYLIB

STATIC

public static final CrateType STATIC

STATIC_PIC

public static final CrateType STATIC_PIC

PROC_MACRO

public static final CrateType PROC_MACRO

Method Detail

values

public static CrateType[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (CrateType c : CrateType.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static CrateType valueOf(String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum type has no constant with the specified name

NullPointerException - if the argument is null

toString

public String toString()

Overrides:

toString in class Enum<CrateType>

getFlavor

public Flavor getFlavor()

isNative

public boolean isNative()

Return true if this crate type is intended to be a native output (ie, not intended for further processing by the Rust toolchain). In other words, a binary, or a native-linkable shared or static object.

Returns:

Is natively usable.

needAllDeps

public boolean needAllDeps()

Linking this crate needs all the dependencies available.

Returns:

Need all deps.

isDynamic

public boolean isDynamic()

Crate dynamically links with its dependents.

Returns:

Is dynamic.

isPic

public boolean isPic()

Crate needs to be compiled with relocation-model=pic. Executables are currently always compiled with -pie, and so are also PIC.

Returns:

Needs PIC.

isExecutable

public boolean isExecutable()

Create generates an executable

isCheck

public boolean isCheck()

We're just checking the code, and generating metadata to allow dependents to check. For libraries this means we emit a metadata file, and binaries produce no output (they just consume library metadata). "save-analysis" also builds in check mode, but we're only concerned about the analysis output.

isSaveAnalysis

public boolean isSaveAnalysis()

Save-analysis is a more detailed version of check, which saves full type and other information in a json file for consumption by other tools (namely RLS).

isProcMacro

public boolean isProcMacro()

Return true if this is generating a compiler plugin - ie, it should be linked with a different linker and linker flags.

filenameFor

public String filenameFor(BuildTarget target,
                          String name,
                          CxxPlatform cxxPlatform)

Return an appropriate filename for this crate, given its type and the platform.

Parameters:

name - Base filename

cxxPlatform - Platform we're building for

Returns:

Path component