Struct CanisterDeclarationsConfig

pub struct CanisterDeclarationsConfig {
    pub output: Option<PathBuf>,
    pub bindings: Option<Vec<String>>,
    pub env_override: Option<String>,
    pub node_compatibility: bool,
}

Declarations Configuration

Configurations about which canister interface declarations to generate, and where to generate them.

Fields

output: Option<PathBuf>

Declaration Output Directory

Directory to place declarations for that canister. Default is ‘src/declarations/<canister_name>’.

bindings: Option<Vec<String>>

Languages to generate

A list of languages to generate type declarations. Supported options are ‘js’, ‘ts’, ‘did’, ‘mo’. Default is [‘js’, ‘ts’, ‘did’].

env_override: Option<String>

Canister ID ENV Override

A string that will replace process.env.CANISTER_ID_{canister_name_uppercase} in the ‘src/dfx/assets/language_bindings/canister.js’ template.

node_compatibility: bool

Node compatibility flag

Flag to pre-populate generated declarations with better defaults for various types of projects Default is false

Trait Implementations

impl Clone for CanisterDeclarationsConfig

fn clone(&self) -> CanisterDeclarationsConfig

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for CanisterDeclarationsConfig

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

Formats the value using the given formatter.

impl Default for CanisterDeclarationsConfig

fn default() -> CanisterDeclarationsConfig

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for CanisterDeclarationsConfig

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl JsonSchema for CanisterDeclarationsConfig

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(gen: &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 CanisterDeclarationsConfig

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

where __S: Serializer,

Serialize this value into the given Serde serializer.