Struct ModuleAnnotations 

pub struct ModuleAnnotations {

    pub readonly: bool,
    pub destructive: bool,
    pub idempotent: bool,
    pub requires_approval: bool,
    pub open_world: bool,
    pub streaming: bool,
    pub cacheable: bool,
    pub cache_ttl: u64,
    pub cache_key_fields: Option<Vec<String>>,
    pub paginated: bool,
    pub pagination_style: String,
    pub discoverable: bool,
    pub extra: HashMap<String, Value>,
}

Metadata annotations attached to a module. Describes behavioral characteristics of the module.

Wire format (PROTOCOL_SPEC §4.4.1): the extra field is serialized as a nested JSON object under the key "extra". Extension keys MUST NOT be flattened to the annotations root. The custom Deserialize impl below accepts both the canonical nested form and the legacy flattened form (apcore-rust ≤ 0.17.1) for one MINOR backward-compat cycle.

Fields

readonly: bool

destructive: bool

idempotent: bool

requires_approval: bool

open_world: bool

streaming: bool

cacheable: bool

cache_ttl: u64

cache_key_fields: Option<Vec<String>>

paginated: bool

pagination_style: String

discoverable: bool

Whether this module is enumerated by Registry::list() / Registry::iter() / Registry::module_ids() by default.

Per the apcore RFC docs/spec/rfc-ephemeral-modules.md (Accepted, target v0.21.0): defaults to true. Setting discoverable: false hides the module from default enumeration without unregistering it; callers that legitimately need to see every module ID can pass include_hidden=true to the relevant Registry method.

Cross-language alignment: matches ModuleAnnotations.discoverable in apcore-python and apcore-typescript.

extra: HashMap<String, Value>

Extension map for ecosystem package metadata. Serialized as a nested "extra" object per spec §4.4.1.

Trait Implementations

impl Clone for ModuleAnnotations

fn clone(&self) -> ModuleAnnotations

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ModuleAnnotations

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

Formats the value using the given formatter.

impl Default for ModuleAnnotations

fn default() -> Self

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for ModuleAnnotations

fn deserialize<D>(deserializer: D) -> Result<Self, D::Error>

where D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Serialize for ModuleAnnotations

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

where __S: Serializer,

Serialize this value into the given Serde serializer.