Settings

User-provided settings (configuration)

All fields in this struct should be optional. Fields that are *not* optional should be mandatory from the POV of the application, not the POV of file parsing. For example, git's core.author and core.email are required to commit, but the error happens on the commit, not when the gitconfig is parsed.

We have multiple configuration locations, and two kinds of fields: additive and non-additive. Additive fields are fields which are the union of all configuration files (e.g. registryURLs). Non-additive fields will ignore values set in lower priorities configuration, although parsing must still succeed. Additive fields are marked as @Optional, non-additive are marked as SetInfo.

package package(dub)

struct Settings {

@Optional

string[] registryUrls;

@Optional

NativePath[] customCachePaths;

SetInfo!(SkipPackageSuppliers) skipRegistry;

SetInfo!(string) defaultCompiler;

SetInfo!(string) defaultArchitecture;

SetInfo!(bool) defaultLowMemory;

SetInfo!(string[string]) defaultEnvironments;

SetInfo!(string[string]) defaultBuildEnvironments;

SetInfo!(string[string]) defaultRunEnvironments;

SetInfo!(string[string]) defaultPreGenerateEnvironments;

SetInfo!(string[string]) defaultPostGenerateEnvironments;

SetInfo!(string[string]) defaultPreBuildEnvironments;

SetInfo!(string[string]) defaultPostBuildEnvironments;

SetInfo!(string[string]) defaultPreRunEnvironments;

SetInfo!(string[string]) defaultPostRunEnvironments;

SetInfo!(string) dubHome;

Settings merge(Settings higher);

}

Members

Functions

merge Settings merge(Settings higher): Merge a lower priority config (this) with a higher priority config

Variables

customCachePaths NativePath[] customCachePaths;: Undocumented in source.
defaultArchitecture SetInfo!(string) defaultArchitecture;: Undocumented in source.
defaultBuildEnvironments SetInfo!(string[string]) defaultBuildEnvironments;: Undocumented in source.
defaultCompiler SetInfo!(string) defaultCompiler;: Undocumented in source.
defaultEnvironments SetInfo!(string[string]) defaultEnvironments;: Undocumented in source.
defaultLowMemory SetInfo!(bool) defaultLowMemory;: Undocumented in source.
defaultPostBuildEnvironments SetInfo!(string[string]) defaultPostBuildEnvironments;: Undocumented in source.
defaultPostGenerateEnvironments SetInfo!(string[string]) defaultPostGenerateEnvironments;: Undocumented in source.
defaultPostRunEnvironments SetInfo!(string[string]) defaultPostRunEnvironments;: Undocumented in source.
defaultPreBuildEnvironments SetInfo!(string[string]) defaultPreBuildEnvironments;: Undocumented in source.
defaultPreGenerateEnvironments SetInfo!(string[string]) defaultPreGenerateEnvironments;: Undocumented in source.
defaultPreRunEnvironments SetInfo!(string[string]) defaultPreRunEnvironments;: Undocumented in source.
defaultRunEnvironments SetInfo!(string[string]) defaultRunEnvironments;: Undocumented in source.
dubHome SetInfo!(string) dubHome;: Undocumented in source.
registryUrls string[] registryUrls;: Undocumented in source.
skipRegistry SetInfo!(SkipPackageSuppliers) skipRegistry;: Undocumented in source.

Settings

Members

Functions

Variables

Meta

Source