Struct DeclareConfig 

pub struct DeclareConfig {
    pub version: String,
    pub tags: FxHashMap<String, DeclareTag>,
    pub audiences: FxHashMap<String, String>,
    pub visibilities: FxHashMap<String, String>,
    pub extractors: Vec<DeclareExtractor>,
}

User-facing config for declare(). All fields have sensible defaults.

This is the programmatic equivalent of .config/aql.schema:

declare({
  version: "1.0",
  tags: {
    route: {
      description: "HTTP route handler",
      attrs: {
        method: { type: "enum", values: ["GET", "POST"], required: true },
        path:   { type: "string", required: true },
      },
    },
  },
  extractors: [
    { name: "express", globs: ["src/**/*.ts"] },
  ],
})

Fields

version: String

Schema version. Defaults to "1.0".

tags: FxHashMap<String, DeclareTag>

Tag definitions keyed by tag name.

audiences: FxHashMap<String, String>

Audience labels (e.g. { "product": "Product engineers" }).

visibilities: FxHashMap<String, String>

Visibility labels (e.g. { "public": "Stable API" }).

extractors: Vec<DeclareExtractor>

Extractors to enable.

Trait Implementations

impl Clone for DeclareConfig

fn clone(&self) -> DeclareConfig

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for DeclareConfig

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for DeclareConfig

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Serialize for DeclareConfig

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

where __S: Serializer,

Serialize this value into the given Serde serializer.