Struct CanisterMetadataSection 

pub struct CanisterMetadataSection {
    pub name: String,
    pub visibility: MetadataVisibility,
    pub networks: Option<BTreeSet<String>>,
    pub path: Option<PathBuf>,
    pub content: Option<String>,
}

Canister Metadata Configuration

Configures a custom metadata section for the canister wasm. dfx uses the first definition of a given name matching the current network, ignoring any of the same name that follow.

Fields

name: String

Name

The name of the wasm section

visibility: MetadataVisibility

Visibility

networks: Option<BTreeSet<String>>

Networks

Networks this section applies to. If this field is absent, then it applies to all networks. An empty array means this element will not apply to any network.

path: Option<PathBuf>

Path

Path to file containing section contents. Conflicts with content. For sections with name=candid:service, this field is optional, and if not specified, dfx will use the canister’s candid definition. If specified for a Motoko canister, the service defined in the specified path must be a valid subtype of the canister’s actual candid service definition.

content: Option<String>

Content

Content of this metadata section. Conflicts with path.

Implementations

impl CanisterMetadataSection

pub fn applies_to_network(&self, network: &str) -> bool

Trait Implementations

impl Clone for CanisterMetadataSection

fn clone(&self) -> CanisterMetadataSection

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for CanisterMetadataSection

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

Formats the value using the given formatter.

impl Default for CanisterMetadataSection

fn default() -> CanisterMetadataSection

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for CanisterMetadataSection

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl JsonSchema for CanisterMetadataSection

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 CanisterMetadataSection

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

where __S: Serializer,

Serialize this value into the given Serde serializer.