Skip to main content

PlaybookResolver

Struct PlaybookResolver 

Source
pub struct PlaybookResolver { /* private fields */ }
Expand description

Playbook registry + precedence resolver.

§Example

use stygian_charon::playbooks::{PlaybookOverrides, PlaybookResolver};
use stygian_charon::types::TargetClass;

let resolver = PlaybookResolver::with_builtin_defaults();
let resolved = resolver
    .resolve(
        TargetClass::ContentSite,
        "tier1-js",
        &PlaybookOverrides::default(),
    )
    .expect("resolve");
assert_eq!(resolved.target_class, TargetClass::ContentSite);

Implementations§

Source§

impl PlaybookResolver

Source

pub fn with_builtin_defaults() -> Self

Create a resolver seeded with the documented baseline playbooks (tier1-static, tier1-js, tier2-hostile, plus an unknown fallback).

The resolver will fail-fast on startup if any embedded playbook is invalid; this guarantees the loader’s validate()-first contract.

§Panics

Panics if any embedded baseline TOML fails to parse or validate. This is a compile-time failure guarded by the compile_check_builtin_playbooks test in crate::playbooks::builtin; the panic in production surfaces a regression in the embedded data as a hard startup error.

§Example
use stygian_charon::playbooks::PlaybookResolver;

let resolver = PlaybookResolver::with_builtin_defaults();
assert!(resolver.contains("tier1-static"));
assert!(resolver.contains("tier1-js"));
assert!(resolver.contains("tier2-hostile"));
Source

pub fn from_playbooks<I>(playbooks: I) -> Result<Self, ValidationError>
where I: IntoIterator<Item = Playbook>,

Build a resolver from a list of pre-validated playbooks. The first playbook encountered per target class becomes the default for that class; subsequent matches for the same class override the lookup (last-write-wins).

§Errors

Returns ValidationError::DuplicateId when two playbooks share the same id, or ValidationError from each playbook’s validate().

Source

pub fn contains(&self, id: &str) -> bool

true when the resolver has a playbook with the given id.

Source

pub fn playbook_ids(&self) -> Vec<String>

Ids of all registered playbooks, in sorted order.

Source

pub fn resolve( &self, target_class: TargetClass, playbook_id: &str, overrides: &PlaybookOverrides, ) -> Result<ResolvedPlaybook, ValidationError>

Resolve a playbook for a (target_class, playbook_id) pair with per-request overrides. Precedence: request override > playbook default > global default.

When playbook_id is Some and registered, the playbook is used directly. When playbook_id is None, the resolver looks up the target-class default. When neither resolves, the resolver falls through to the global default.

§Errors

Returns ValidationError::UnknownPlaybook when an explicit playbook_id is supplied and is not registered.

§Example
use stygian_charon::playbooks::{PlaybookOverrides, PlaybookResolver};
use stygian_charon::types::TargetClass;

let resolver = PlaybookResolver::with_builtin_defaults();
let resolved = resolver
    .resolve(
        TargetClass::ContentSite,
        "tier1-js",
        &PlaybookOverrides::default(),
    )
    .expect("resolve");
assert_eq!(resolved.playbook_id, "tier1-js");
Source

pub fn resolve_optional( &self, target_class: TargetClass, playbook_id: Option<&str>, overrides: &PlaybookOverrides, ) -> Result<ResolvedPlaybook, ValidationError>

Like resolve but takes an optional playbook_id and falls through to the target-class default (or the global default) when None.

§Errors

Returns ValidationError::UnknownPlaybook when an explicit playbook_id is supplied and is not registered.

§Example
use stygian_charon::playbooks::{PlaybookOverrides, PlaybookResolver};
use stygian_charon::types::TargetClass;

let resolver = PlaybookResolver::with_builtin_defaults();
let resolved = resolver
    .resolve_optional(
        TargetClass::ContentSite,
        None,
        &PlaybookOverrides::default(),
    )
    .expect("resolve");
assert!(resolver.contains(&resolved.playbook_id));

Trait Implementations§

Source§

impl Clone for PlaybookResolver

Source§

fn clone(&self) -> PlaybookResolver

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 PlaybookResolver

Source§

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

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

impl PlaybookResolverExt for PlaybookResolver

Source§

fn resolve_unsafe_playbook(&self, id: &str) -> Result<Playbook, ValidationError>

Resolve a single playbook by id, returning the underlying Playbook without applying any precedence / override merge. 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> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

§

impl<T> Instrument for T

§

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

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

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.

§

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

§

fn and<P, B, E>(self, other: P) -> And<T, P>
where T: Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns [Action::Follow] only if self and other return Action::Follow. Read more
§

fn or<P, B, E>(self, other: P) -> Or<T, P>
where T: Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns [Action::Follow] if either self or other returns Action::Follow. Read more
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.
§

impl<T> WithSubscriber for T

§

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
§

fn with_current_subscriber(self) -> WithDispatch<Self>

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