Struct ConfigInterface 

pub struct ConfigInterface {
    pub profile: Option<Profile>,
    pub version: Option<u32>,
    pub dfx: Option<String>,
    pub canisters: Option<BTreeMap<String, ConfigCanistersCanister>>,
    pub defaults: Option<ConfigDefaults>,
    pub networks: Option<BTreeMap<String, ConfigNetwork>>,
    pub output_env_file: Option<PathBuf>,
}

dfx.json

Fields

profile: Option<Profile>

version: Option<u32>

Used to keep track of dfx.json versions.

dfx: Option<String>

dfx version

Pins the dfx version for this project.

canisters: Option<BTreeMap<String, ConfigCanistersCanister>>

Mapping between canisters and their settings.

defaults: Option<ConfigDefaults>

Defaults for dfx start.

networks: Option<BTreeMap<String, ConfigNetwork>>

Mapping between network names and their configurations. Networks ‘ic’ and ‘local’ are implicitly defined.

output_env_file: Option<PathBuf>

If set, environment variables will be output to this file (without overwriting any user-defined variables, if the file already exists).

Implementations

impl ConfigInterface

pub fn get_defaults(&self) -> &ConfigDefaults

pub fn get_network(&self, name: &str) -> Option<&ConfigNetwork>

pub fn get_version(&self) -> u32

pub fn get_dfx(&self) -> Option<String>

pub fn get_canister_names_with_dependencies( &self, some_canister: Option<&str>, ) -> Result<Vec<String>, GetCanisterNamesWithDependenciesError>

Return the names of the specified canister and all of its dependencies. If none specified, return the names of all canisters.

pub fn get_remote_canister_id( &self, canister: &str, network: &str, ) -> Result<Option<Principal>, GetRemoteCanisterIdError>

pub fn is_remote_canister( &self, canister: &str, network: &str, ) -> Result<bool, GetRemoteCanisterIdError>

pub fn get_compute_allocation( &self, canister_name: &str, ) -> Result<Option<u64>, GetComputeAllocationError>

pub fn get_memory_allocation( &self, canister_name: &str, ) -> Result<Option<Byte>, GetMemoryAllocationError>

pub fn get_freezing_threshold( &self, canister_name: &str, ) -> Result<Option<Duration>, GetFreezingThresholdError>

pub fn get_reserved_cycles_limit( &self, canister_name: &str, ) -> Result<Option<u128>, GetReservedCyclesLimitError>

pub fn get_wasm_memory_limit( &self, canister_name: &str, ) -> Result<Option<Byte>, GetWasmMemoryLimitError>

pub fn get_wasm_memory_threshold( &self, canister_name: &str, ) -> Result<Option<Byte>, GetWasmMemoryThresholdError>

pub fn get_log_visibility( &self, canister_name: &str, ) -> Result<Option<LogVisibility>, GetLogVisibilityError>

pub fn get_pull_canisters( &self, ) -> Result<BTreeMap<String, Principal>, GetPullCanistersError>

pub fn get_specified_id( &self, canister_name: &str, ) -> Result<Option<Principal>, GetSpecifiedIdError>

Trait Implementations

impl Clone for ConfigInterface

fn clone(&self) -> ConfigInterface

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ConfigInterface

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for ConfigInterface

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl JsonSchema for ConfigInterface

fn schema_name() -> String

The name of the generated JSON Schema.

fn schema_id() -> Cow<'static, str>

Returns a string that uniquely identifies the schema produced by this type.

fn json_schema(generator: &mut SchemaGenerator) -> Schema

Generates a JSON Schema for this type.

fn is_referenceable() -> bool

Whether JSON Schemas generated for this type should be re-used where possible using the $ref keyword.

impl Serialize for ConfigInterface

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

where __S: Serializer,

Serialize this value into the given Serde serializer.