Skip to main content

OrcsConfig

Struct OrcsConfig 

Source
pub struct OrcsConfig {
    pub debug: bool,
    pub model: ModelConfig,
    pub hil: HilConfig,
    pub paths: PathsConfig,
    pub ui: UiConfig,
    pub scripts: ScriptsConfig,
    pub components: ComponentsConfig,
    pub hooks: HooksConfig,
    pub mcp: McpConfig,
    pub timeouts: TimeoutsConfig,
}
Expand description

Main configuration structure.

This is the unified configuration after merging all layers.

§Serialization

Serializes to TOML for file storage. Fields with #[serde(default)] are optional in the config file.

§Example

use orcs_runtime::config::OrcsConfig;

let config = OrcsConfig::default();
assert!(!config.debug);

Fields§

§debug: bool

Enable debug mode (verbose logging, diagnostics).

§model: ModelConfig

Model configuration.

§hil: HilConfig

Human-in-the-loop configuration.

§paths: PathsConfig

Path configuration.

§ui: UiConfig

UI configuration.

§scripts: ScriptsConfig

Script configuration.

§components: ComponentsConfig

Component loading configuration.

§hooks: HooksConfig

Hooks configuration.

§mcp: McpConfig

MCP (Model Context Protocol) server configuration.

§timeouts: TimeoutsConfig

Timeout configuration.

Implementations§

Source§

impl OrcsConfig

Source

pub fn new() -> Self

Creates a new config with default values.

Source

pub fn to_toml(&self) -> Result<String, Error>

Serializes to TOML string.

§Errors

Returns error if serialization fails.

Source

pub fn from_toml(toml_str: &str) -> Result<Self, Error>

Deserializes from TOML string.

§Errors

Returns error if deserialization fails.

Source

pub fn global_config_for_lua(&self) -> Value

Returns global config fields as a JSON value for Lua component injection.

This is injected into each component’s init(cfg) table under the _global key by OrcsAppBuilder::build(), so Lua components can access it as cfg._global.

§Included fields
KeyTypeDescription
debugboolDebug mode flag
model.defaultstringDefault model name
model.temperaturenumberDefault sampling temperature
model.max_tokensnumber|nullDefault max completion tokens
hil.auto_approveboolAuto-approve requests
hil.timeout_msnumberApproval timeout (ms)
ui.verboseboolVerbose output
ui.colorboolColor output
ui.emojiboolEmoji output
timeouts.delegate_msnumberDelegate task timeout (ms)
§Excluded fields

paths, scripts, components, hooks are excluded (internal/sensitive).

Source

pub fn merge(&mut self, other: &Self)

Merges another config into this one.

Values from other override values in self only if they differ from the default. This enables layered configuration.

Trait Implementations§

Source§

impl Clone for OrcsConfig

Source§

fn clone(&self) -> OrcsConfig

Returns a duplicate of the value. Read more
1.0.0 · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for OrcsConfig

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Default for OrcsConfig

Source§

fn default() -> OrcsConfig

Returns the “default value” for a type. Read more
Source§

impl<'de> Deserialize<'de> for OrcsConfig

Source§

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>
where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer. Read more
Source§

impl PartialEq for OrcsConfig

Source§

fn eq(&self, other: &OrcsConfig) -> bool

Tests for self and other values to be equal, and is used by ==.
1.0.0 · Source§

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.
Source§

impl Serialize for OrcsConfig

Source§

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

Serialize this value into the given Serde serializer. Read more
Source§

impl StructuralPartialEq for OrcsConfig

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> DynClone for T
where T: Clone,

Source§

fn __clone_box(&self, _: Private) -> *mut ()

Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

impl<T> DeserializeOwned for T
where T: for<'de> Deserialize<'de>,