CauldronGPU.Setup.Platform behaviour (CauldronGPU v0.3.3)

Copy Markdown View Source

What a platform module of CauldronGPU.Setup provides.

  • probe/0: each thing the build needs, found or not, looked for in the platform's usual places
  • install/1: installs one item: :ok when done, {:wait, text} when a person must finish it (an installer the platform opened), {:error, text} otherwise
  • config/1: the configuration (CauldronGPU.Setup) for the items found

Summary

Callbacks

config(list)
install(item)
probe()

Callbacks

config(list)

@callback config([CauldronGPU.Setup.item()]) :: map()

install(item)

@callback install(CauldronGPU.Setup.item()) ::
  :ok | {:wait, String.t()} | {:error, String.t()}

probe()

@callback probe() :: [CauldronGPU.Setup.item()]