Skip to main content

Module install

Module install 

Source
Expand description

Installation: turning a plugin crate on crates.io into a loadable cdylib plus its manifest on disk.

Two routes, chosen by crate::CratePluginKit::install based on crate::KitConfig::prefer_prebuilt:

prefer_prebuilt = true
  └─ prebuilt::try_install ──(no prebuilt published / cannot download)──> build_host::install
prefer_prebuilt = false
  └─ build_host::install

build-host is the default and the fallback: it goes through cargo build and therefore uses whatever registry or mirror the user has configured. prebuilt downloads from GitHub bypass those settings, so it is only an accelerator.

Modules§

build_host
build-host: generates a wrapper project, cargo builds a cdylib out of it, and copies that into the install dir.
prebuilt
prebuilt: downloads a cdylib plus manifest straight from GitHub Releases.

Structs§

Installed
The artifact of one successful install.