Enum fam::Manifest

pub enum Manifest {
    Json(Value),
    Struct {

        name: Option<String>,
        appid: String,
        apptype: String,
        stack_size: Option<usize>,
        icon: Option<String>,
        entry_point: Option<String>,
        flags: Vec<String>,
        cdefines: Vec<String>,
        requires: Vec<String>,
        conflicts: Vec<String>,
        provides: Vec<String>,
        order: Option<isize>,
        sdk_headers: Vec<String>,
        sources: Vec<String>,
        fap_version: Option<(String, String)>,
        fap_icon: Option<String>,
        fap_libs: Vec<String>,
        fap_category: Option<String>,
        fap_description: Option<String>,
        fap_author: Option<String>,
        fap_weburl: Option<String>,
    
},
}

Variants

Json(Value)

For custom fields.

Struct

Fields

name: Option<String>

Name that is displayed in menus

appid: String

String, application id within the build system. Used for specifying which applications to include in build configuration and to resolve dependencies and conflicts.

apptype: String

Member of FlipperAppType.* enumeration. Valid values are:

• SERVICE: System service, created at early startup
• SYSTEM: Application not being shown in any menus. Can be started by other apps or from CLI
• APP: Regular application for main menu
• PLUGIN: Application to be built as a part of firmware an to be placed in Plugins menu
• DEBUG: Application only visible in Debug menu with debug mode enabled
• ARCHIVE: One and only Archive app
• SETTINGS: Application to be placed in System settings menu
• STARTUP: Callback function to run at system startup. Does not define a separate app
• EXTERNAL: Application to be built as .fap plugin
• METAPACKAGE: Does not define any code to be run, used for declaring dependencies and application bundles

stack_size: Option<usize>

Stack size, in bytes, to allocate for application on its startup. Note that allocating a stack that is too small for an app to run will cause system crash due to stack overflow, and allocating too much stack space will reduce usable heap memory size for apps to process data. Note: you can use ps and free CLI commands to profile your app’s memory usage.

icon: Option<String>

Animated icon name from built-in assets to be used when building app as a part of firmware.

entry_point: Option<String>

C function to be used as application’s entry point

flags: Vec<String>

Internal flags for system apps. Do not use.

cdefines: Vec<String>

C preprocessor definitions to declare globally for other apps when current application is included in active build configuration.

requires: Vec<String>

List of application IDs to also include in build configuration, when current application is referenced in list of applications to build.

conflicts: Vec<String>

List of application IDs that current application conflicts with. If any of them is found in constructed application list, fbt will abort firmware build process.

provides: Vec<String>

Functionally identical to requires field.

order: Option<isize>

Order of an application within its group when sorting entries in it. The lower the order is, the closer to the start of the list the item is placed. Used for ordering startup hooks and menu entries.

sdk_headers: Vec<String>

List of C header files from this app’s code to include in API definitions for external applications.

sources: Vec<String>

list of strings, file name masks, used for gathering sources within app folder. Default value of [“.c”] includes C and CPP source files.

fap_version: Option<(String, String)>

Tuple, 2 numbers in form of (x,y): application version to be embedded within .fap file. Default value is (0,1), meaning version “0.1”.

fap_icon: Option<String>

Name of a .png file, 1-bit color depth, 10x10px, to be embedded within .fap file.

fap_libs: Vec<String>

List of extra libraries to link application against. Provides access to extra functions that are not exported as a part of main firmware at expense of increased .fap file size and RAM consumption.

fap_category: Option<String>

String, may be empty. App subcategory, also works as path of FAP within apps folder in the file system.

fap_description: Option<String>

String, may be empty. Short application description.

fap_author: Option<String>

String, may be empty. Application’s author.

fap_weburl: Option<String>

String, may be empty. Application’s homepage.

Implementations

impl Manifest

pub fn try_to_string(&self) -> Result<String, RenderError>

impl Manifest

pub fn appid(&self) -> Option<&str>

pub fn apptype(&self) -> Option<&str>

pub fn name(&self) -> Option<&str>

pub fn icon(&self) -> Option<&str>

pub fn entry_point(&self) -> Option<&str>

pub fn fap_icon(&self) -> Option<&str>

pub fn fap_category(&self) -> Option<&str>

pub fn fap_description(&self) -> Option<&str>

pub fn fap_author(&self) -> Option<&str>

pub fn fap_weburl(&self) -> Option<&str>

pub fn flags(&self) -> Box<dyn Iterator<Item = String> + '_>

pub fn cdefines(&self) -> Box<dyn Iterator<Item = String> + '_>

pub fn requires(&self) -> Box<dyn Iterator<Item = String> + '_>

pub fn conflicts(&self) -> Box<dyn Iterator<Item = String> + '_>

pub fn provides(&self) -> Box<dyn Iterator<Item = String> + '_>

pub fn sdk_headers(&self) -> Box<dyn Iterator<Item = String> + '_>

pub fn sources(&self) -> Box<dyn Iterator<Item = String> + '_>

pub fn fap_libs(&self) -> Box<dyn Iterator<Item = String> + '_>

pub fn fap_version(&self) -> Option<(String, String)>

Trait Implementations

impl Clone for Manifest

fn clone(&self) -> Manifest

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<'de> Deserialize<'de> for Manifest

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>where
    __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl From<Value> for Manifest

fn from(metadata: Value) -> Self

Converts to this type from the input type.

impl Serialize for Manifest

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>where
    __S: Serializer,

Serialize this value into the given Serde serializer.