Struct ApkBuilder 

pub struct ApkBuilder { /* private fields */ }

An APK under construction.

Settings apply to one Manifest document, which is checked and then compiled exactly as it stands when the APK is written.

use apk::build::ApkBuilder;
use apk::res::Density;
use apk::sign::{Signer, SigningIdentity};
use apk::{Abi, ApiLevel, LibraryName, PackageName};

let mut app = ApkBuilder::native_activity(PackageName::try_new("org.example.game")?, LibraryName::try_new("game")?);
app.label("Game")
    .version(3.try_into()?, "1.2.0")
    .min_sdk(ApiLevel::LOLLIPOP)
    .permission("android.permission.INTERNET".parse()?)
    .localized_string("app_name", "fr".parse()?, "Jeu")?
    .icon(Density::XHDPI, std::fs::read("icon.png")?)?
    .asset("levels/1.json", std::fs::read("levels/1.json")?)?
    .native_library(Abi::Arm64V8a, "target/aarch64-linux-android/release/libgame.so")?
    .sign_with(Signer::new(SigningIdentity::from_pem_file("release.pem")?));
app.write("game.apk")?;

Implementations

impl ApkBuilder

pub fn new(manifest: Manifest) -> Self

Starts an APK from a complete manifest.

pub fn native_activity(package: PackageName, library: LibraryName) -> Self

Starts a launchable app whose android.app.NativeActivity runs lib<library>.so. The app has no Java code.

pub fn manifest(&self) -> &Manifest

pub fn manifest_mut(&mut self) -> &mut Manifest

The manifest, for settings without a builder method.

pub fn resources(&self) -> &Resources

pub fn resources_mut(&mut self) -> &mut Resources

The resources, for values and files without a builder method.

pub fn label(&mut self, label: impl Into<String>) -> &mut Self

Sets the app name shown by the launcher (string resource app_name, which can be translated with localized_string).

pub fn version(&mut self, code: VersionCode, name: &str) -> &mut Self

pub fn min_sdk(&mut self, level: ApiLevel) -> &mut Self

pub fn target_sdk(&mut self, level: ApiLevel) -> &mut Self

pub fn permission(&mut self, name: PermissionName) -> &mut Self

pub fn debuggable(&mut self, debuggable: bool) -> &mut Self

pub fn string( &mut self, name: &str, value: impl Into<String>, ) -> Result<&mut Self>

Adds the default value of string resource name.

pub fn localized_string( &mut self, name: &str, locale: Locale, value: impl Into<String>, ) -> Result<&mut Self>

Adds a translation of string resource name.

pub fn icon( &mut self, density: Density, png: impl Into<Content>, ) -> Result<&mut Self>

Adds a PNG launcher icon (@mipmap/ic_launcher) for one density.

pub fn asset( &mut self, path: &str, content: impl Into<Content>, ) -> Result<&mut Self>

Adds a file under assets/, read by apps through AAssetManager.

pub fn file( &mut self, path: ArchivePath, content: impl Into<Content>, options: Option<EntryOptions>, ) -> Result<&mut Self>

Adds any file at an exact archive path, stored with options (or the default for its extension).

pub fn dex(&mut self, content: impl Into<Content>) -> &mut Self

Adds a DEX file (classes.dex, then classes2.dex, …).

pub fn native_library( &mut self, abi: Abi, path: impl AsRef<Path>, ) -> Result<&mut Self>

Adds a native library from a file named lib<name>.so.

pub fn native_library_bytes( &mut self, abi: Abi, name: LibraryName, bytes: impl Into<Content>, ) -> Result<&mut Self>

Adds a native library from memory as lib<name>.so.

pub fn native_policy(&mut self, policy: NativePolicy) -> &mut Self

How native libraries are stored and checked.

pub fn sign_with(&mut self, signer: Signer) -> &mut Self

Signs the APK when it is written, for the manifest’s SDK range.

pub fn write(self, output: impl AsRef<Path>) -> Result<(), Error>

Completes the manifest, checks the whole configuration, and writes the APK to output atomically. The target is replaced only after validation and writing succeed.

Trait Implementations

impl Clone for ApkBuilder

fn clone(&self) -> Self

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for ApkBuilder

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.