Struct ApplicationConfiguration 

pub struct ApplicationConfiguration {
    pub cst: Option<CstRootNode>,
    pub buckets: Option<Vec<Bucket>>,
    pub config: Option<Config>,
    pub endpoints: Option<Vec<Endpoint>>,
    pub models: Option<Vec<ModelEntry>>,
    pub runners: Option<Vec<RunnerDetails>>,
    pub whitelist: Option<WhitelistLookup>,
}

Struct for application configuration

Example .acorn configuration file

{
    "buckets": [
        {
            "name": "big-science",
            "repository": {
                "provider": "github",
                "uri": "https://github.com/username/example"
            }
        },
        {
            "name": "does-it-scale",
            "repository": {
                "provider": "gitlab",
                "id": 12345,
                "uri": "https://gitlab.com/username/example"
            }
        }
    ],
    "models": [
        "meta-llama/Llama-2-7b-hf",
        "microsoft/phi-2"
    ],
    "runners": [
        {
            "name": "ACORN Runner B",
            "repository": {
                "provider": "gitlab",
                "id": 24758,
                "uri": "https://code.ornl.gov/research-enablement"
            },
            "type": "group",
            "runUntagged": true
        }
    ]
}

Fields

cst: Option<CstRootNode>

CST root for JSONC comment-preserving round-trips

buckets: Option<Vec<Bucket>>

List of buckets

config: Option<Config>

Synchronization targets for llama-swap, OpenCode, VS Code, and Goose

endpoints: Option<Vec<Endpoint>>

List of endpoints

models: Option<Vec<ModelEntry>>

List of models to download — bare IDs/paths or detailed download entries

runners: Option<Vec<RunnerDetails>>

List of runners

whitelist: Option<WhitelistLookup>

Lookup object for whitelisted downloadable items

Implementations

impl ApplicationConfiguration

pub fn load(path: &Option<PathBuf>) -> ApiResult<Self>

Load explicit or discovered application configuration, rejecting a missing explicit path.

pub fn resolve_sync_config(&self, overrides: Config) -> Config

Merge configured synchronization settings with runtime overrides.

pub fn model_entries_and_whitelist( &self, ) -> (Vec<ModelEntry>, Option<OneOrMany<String>>)

Return configured model entries and their download whitelist.

pub fn sync(&self, options: Options<'_>) -> ApiResult<()>

Synchronize selected model entries with configured local inference targets.

pub fn sync_and_update( &self, path: &Option<PathBuf>, options: Options<'_>, ) -> ApiResult<()>

Synchronize selected models and add their unique identifiers to ACORN configuration.

pub fn resolve(path: &Option<PathBuf>) -> Option<PathBuf>

Resolve application configuration path

pub fn resolve_in(path: &Option<PathBuf>, directory: &Path) -> Option<PathBuf>

Resolve an application configuration path relative to an explicit directory.

pub fn parse(content: impl AsRef<str>) -> ApiResult<Self>

Parse ACORN configuration in JSON, JSONC, or YAML format

Note

If the content is valid JSON, it is parsed as JSON. If it is not valid JSON but starts with { or [, it is first attempted to be parsed as JSON, and if that fails, it is attempted to be parsed as YAML. If the content does not start with { or [, it is parsed as YAML.

Trait Implementations

impl Clone for ApplicationConfiguration

fn clone(&self) -> ApplicationConfiguration

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ApplicationConfiguration

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

Formats the value using the given formatter.

impl Default for ApplicationConfiguration

fn default() -> ApplicationConfiguration

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for ApplicationConfiguration

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl<'de> EDeserialize<'de> for ApplicationConfiguration

fn deserialize_for_errors<__D>(__deserializer: __D) -> Result<(), ()>

where __D: Deserializer<'de>,

Visit the input to accumulate as many deserialization errors as possible.

impl InputOutput for ApplicationConfiguration

fn read(path: impl Into<PathBuf>) -> ApiResult<Self>

Read and parse application configuration file (JSON, JSONC, or YAML)

fn read_json(path: PathBuf) -> ApiResult<Self>

Read configuration (e.g., .acorn.json) using Serde and ApplicationConfiguration struct

fn read_jsonc(path: PathBuf) -> ApiResult<Self>

Read configuration (e.g., .acorn.jsonc) using JSONC parser

Supports comments (// and /* */) and trailing commas.

fn read_yaml(path: PathBuf) -> ApiResult<Self>

Read configuration (e.g., .acorn.yml) using Serde and ApplicationConfiguration struct

fn write(&self, path: impl Into<PathBuf>) -> ApiResult<()>

Write configuration to specified path (detects JSON, JSONC, or YAML from extension)

JSONC files are written as strict JSON (no comments generated).

fn write_json(&self, path: impl Into<PathBuf>) -> ApiResult<()>

Write configuration as JSON to specified path

If the config was parsed from JSONC, preserves comments via CST.

fn write_yaml(&self, path: impl Into<PathBuf>) -> ApiResult<()>

Write configuration as YAML to specified path

fn read_cff(_path: impl Into<PathBuf>) -> ApiResult<Self>

Read data as CFF from specified path

fn read_markdown(_path: PathBuf) -> ApiResult<Self>

Read data as Markdown from specified path

fn write_cff(&self, _path: impl Into<PathBuf>) -> ApiResult<()>

Write data as CFF to specified path

fn write_markdown(&self, _path: impl Into<PathBuf>) -> ApiResult<()>

Write data as Markdown (MD) to specified path

impl Serialize for ApplicationConfiguration

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

where __S: Serializer,

Serialize this value into the given Serde serializer.