Bundlex (Bundlex v1.5.5)

View Source

Some common utility functions.

Summary

Types

platform_t()
target()

A map containing four fields that describe the target platform.

Functions

build_path(application \\ MixHelper.get_app!(), native, native_interface)

Returns path where compiled native is stored.

family()

Returns family of the platform obtained with platform/0.

get_target()

A function returning information about the target platform. In case of cross-compilation the information can be provided by setting appropriate environment variables.

platform() deprecated

Returns current platform name.

Types

platform_t()

@type platform_t() :: :linux | :macosx | :windows32 | :windows64 | :nerves | :custom

target()

@type target() :: %{
  architecture: String.t(),
  vendor: String.t(),
  os: String.t(),
  abi: String.t()
}

A map containing four fields that describe the target platform.

It consists of:

  • architecture - e.g. x86_64 or arm64
  • vendor - e.g. pc
  • os - operating system, e.g. linux or darwin20.6.0
  • abi - application binary interface, e.g. musl or gnu

Functions

build_path(application \\ MixHelper.get_app!(), native, native_interface)

@spec build_path(application :: atom(), native :: atom(), native_interface :: atom()) ::
  String.t()

Returns path where compiled native is stored.

family()

@spec family() :: :unix | :windows | :custom

Returns family of the platform obtained with platform/0.

get_target()

@spec get_target() :: target()

A function returning information about the target platform. In case of cross-compilation the information can be provided by setting appropriate environment variables.

platform()

This function is deprecated. Use Bundlex.get_target/0 instead. 
@spec platform() :: platform_t()

Returns current platform name.