rules/odin/odinfmt/toolchain.js

Developer reference: this page includes exported implementation details. BUILD authors should prefer the User API reference.

ODINFMT_TOOL

const ODINFMT_TOOL

Undocumented.

olsTriple()

olsTriple(plat)

Return the OLS release triple for a platform.

Parameter	Type	Description
plat	{ os: string, arch: string }

Returns: string

odinfmtArtifactName()

odinfmtArtifactName(version, plat)

Return the OLS release artifact filename bundling odinfmt for a version and platform.

Parameter	Type	Description
version	string
plat	{ os: string, arch: string }

Returns: string

odinfmtDownloadUrl()

odinfmtDownloadUrl(version, plat)

Return the OLS release download URL bundling odinfmt for a version and platform.

Parameter	Type	Description
version	string
plat	{ os: string, arch: string }

Returns: string

acquireOdinfmt

const acquireOdinfmt

Acquire (download, verify, and extract) odinfmt for a version and return its cache path.

Parameter	Type	Description
version	string

Returns: Promise<string>

OdinfmtToolchain (implementation class)

class OdinfmtToolchain

Implementation class. BUILD files should use odinfmtToolchain().

Undocumented.

odinfmtToolchain()

odinfmtToolchain(version, opts = {})

Declare an odinfmt toolchain, pinned to an Odin toolchain version. Omit version to track the workspace's default Odin toolchain version. matching lockfile entry (warns instead of failing).

Parameter	Type	Description
[version]	string
[opts]	object
[opts.default=false]	boolean	Set as the default odinfmt target.
[opts.unverified=false]	boolean	Allow downloading without a

Returns: object Target handle for this odinfmt toolchain.

defaultOdinfmtToolchain()

defaultOdinfmtToolchain()

Return the currently configured default odinfmt toolchain target handle.

Returns: object|null