Package

Represents a package, including its sub packages

Documentation of the dub.json can be found at http://registry.vibed.org/package-format

Constructors

this
this(Path root, Package parent)
Undocumented in source.
this
this(Json packageInfo, Path root, Package parent)
Undocumented in source.

Members

Functions

addBuildTypeSettings
void addBuildTypeSettings(BuildSettings settings, BuildPlatform platform, string build_type)
Undocumented in source. Be warned that the author may not have intended to support it.
describe
void describe(Json dst, BuildPlatform platform, string config)
Undocumented in source. Be warned that the author may not have intended to support it.
generateInfoString
string generateInfoString()

Human readable information of this package and its dependencies.

getBuildSettings
BuildSettings getBuildSettings(BuildPlatform platform, string config)

Returns all BuildSettings for the given platform and config.

getDefaultConfiguration
string getDefaultConfiguration(BuildPlatform platform, bool allow_non_library)

Returns the default configuration to build for the given platform

getPlatformConfigurations
string[] getPlatformConfigurations(BuildPlatform platform, bool is_main_package)

Returns a list of configurations suitable for the given platform

getSubConfiguration
string getSubConfiguration(string config, Package dependency, BuildPlatform platform)
Undocumented in source. Be warned that the author may not have intended to support it.
getSubPackage
inout(Package) getSubPackage(string name)
Undocumented in source. Be warned that the author may not have intended to support it.
hasDependency
bool hasDependency(string depname, string config)
Undocumented in source. Be warned that the author may not have intended to support it.
storeInfo
void storeInfo()

Overwrites the packge description file using the default filename with the current information.

warnOnSpecialCompilerFlags
void warnOnSpecialCompilerFlags()
Undocumented in source. Be warned that the author may not have intended to support it.

Properties

basePackage
inout(Package) basePackage [@property getter]
Undocumented in source. Be warned that the author may not have intended to support it.
configurations
string[] configurations [@property getter]
Undocumented in source. Be warned that the author may not have intended to support it.
dependencies
const(Dependency[string]) dependencies [@property getter]
Undocumented in source. Be warned that the author may not have intended to support it.
exportedPackages
inout(Path[]) exportedPackages [@property getter]
Undocumented in source. Be warned that the author may not have intended to support it.
info
inout(PackageInfo) info [@property getter]
Undocumented in source. Be warned that the author may not have intended to support it.
name
string name [@property getter]
Undocumented in source. Be warned that the author may not have intended to support it.
packageInfoFile
Path packageInfoFile [@property getter]
Undocumented in source. Be warned that the author may not have intended to support it.
parentPackage
inout(Package) parentPackage [@property getter]
Undocumented in source. Be warned that the author may not have intended to support it.
path
Path path [@property getter]
Undocumented in source. Be warned that the author may not have intended to support it.
subPackages
inout(Package)[] subPackages [@property getter]
Undocumented in source. Be warned that the author may not have intended to support it.
ver
Version ver [@property getter]
Undocumented in source. Be warned that the author may not have intended to support it.
ver
Version ver [@property setter]
Undocumented in source. Be warned that the author may not have intended to support it.
vers
string vers [@property getter]
Undocumented in source. Be warned that the author may not have intended to support it.

Static functions

isPackageAt
bool isPackageAt(Path path)
Undocumented in source. Be warned that the author may not have intended to support it.

Structs

LocalPackageDef
struct LocalPackageDef
Undocumented in source.

Meta