Skip to main content

Config

Struct Config 

Source
pub struct Config {
    pub rig: RigConfig,
    pub checks: BTreeMap<String, CheckSettings>,
    pub runtime_nodes: RuntimeNodesConfig,
    pub clips: BTreeMap<String, ClipExpectations>,
    pub gait_groups: BTreeMap<String, GaitGroup>,
    pub sync_groups: BTreeMap<String, SyncGroup>,
}
Expand description

The whole configuration. Field names match the animsmith.toml sections.

Self::runtime_nodes is an intentional pre-1.0 additive public field. Embedders that construct this struct with a literal must add runtime_nodes: RuntimeNodesConfig::default() or use ..Config::default().

Fields§

§rig: RigConfig

Declarative rig profile and inline role bindings. Frontends resolve these into crate::ResolvedRoles before creating a check context; the core runner does not apply them automatically.

§checks: BTreeMap<String, CheckSettings>

Per-check settings keyed by stable check id.

§runtime_nodes: RuntimeNodesConfig

Shared engine-neutral policy for source nodes addressed by the runtime.

§clips: BTreeMap<String, ClipExpectations>

Keyed by clip name or glob (* wildcards). An exact-name entry overrides glob entries; among globs, later (lexicographically greater) keys win on conflict.

§gait_groups: BTreeMap<String, GaitGroup>

Named gait groups consumed by the gait-group check.

§sync_groups: BTreeMap<String, SyncGroup>

Named same-time / absolute-sync groups consumed by sync-group.

Implementations§

Source§

impl Config

Source

pub fn validate(&self) -> Result<(), ConfigValidationError>

Validate values that can also be supplied through the public Rust configuration structs.

Deserialization rejects the same invalid values at the file/config boundary. Embedded callers that construct Config directly must call this method before passing it to measurement-only APIs; crate::evaluate_checks always calls it before inspecting or executing the supplied check catalog.

§Errors

Returns ConfigValidationError::InvalidCheckSetting when a direct per-check numeric policy is outside its documented finite domain, ConfigValidationError::InvalidClipLoopCap when a clip selector contains a negative or non-finite per-clip loop cap, ConfigValidationError::ConflictingClipMovementOwner when one clip selector declares both movement_owner_xz and its in_place alias, ConfigValidationError::ConflictingRuntimeNodeSelectors when shared runtime-node selectors and the rest-world-scale compatibility alias are both declared, ConfigValidationError::InvalidSyncGroupTolerance when a same-time group has an invalid timing tolerance, or ConfigValidationError::InvalidTimeComplementSetting when an enabled time-complement policy has an invalid threshold.

Source

pub fn expectations_for(&self, clip: &str) -> ClipExpectations

Effective expectations for a clip: glob matches (in key order) overlaid, exact match last.

Each selector entry’s legacy in_place input is normalized into ClipExpectations::movement_owner_xz before the field overlay. The returned value therefore always has ClipExpectations::in_place set to None. Call Config::validate before this method so same-entry alias conflicts are rejected rather than resolved by precedence.

Source

pub fn check_settings(&self, id: &str) -> CheckSettings

Settings for a check id, or defaults when the id is not present.

Source

pub fn runtime_node_selectors(&self) -> Option<RuntimeNodeSelectors>

The normalized runtime-node authority, if one is declared.

The shared RuntimeNodesConfig::selectors field is used when it is present. Callers must first call Self::validate: simultaneous use of the legacy checks.rest-world-scale.node_selectors alias is rejected and has no precedence rule. An absent field or explicit empty list returns None and declares no policy.

Source

pub fn loop_seam_min_stride_step_m(&self) -> f64

Effective stride floor for loop-seam metrics, in metres.

Trait Implementations§

Source§

impl Clone for Config

Source§

fn clone(&self) -> Config

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for Config

Source§

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

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

impl Default for Config

Source§

fn default() -> Config

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

impl<'de> Deserialize<'de> for Config

Source§

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

Deserialize this value from the given Serde deserializer. Read more

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> DeserializeOwned for T
where T: for<'de> Deserialize<'de>,

Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

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> Same for T

Source§

type Output = T

Should always be Self
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.