Skip to main content

Playbook

Struct Playbook 

Source
pub struct Playbook {
    pub id: String,
    pub target_class: TargetClass,
    pub description: String,
    pub acquisition: AcquisitionDefaults,
    pub proxy_preference: ProxyPreference,
    pub pacing: PacingProfile,
    pub escalation: EscalationStrategy,
}
Expand description

A single codified playbook for one anti-bot tier.

§Example

use stygian_charon::playbooks::{
    AcquisitionDefaults, EscalationStrategy, PacingProfile, Playbook, ProxyPreference,
};
use stygian_charon::acquisition::AcquisitionModeHint;
use stygian_charon::types::TargetClass;

let pb = Playbook {
    id: "tier1-static".to_string(),
    target_class: TargetClass::ContentSite,
    description: "Static content sites".to_string(),
    acquisition: AcquisitionDefaults::default_for(TargetClass::ContentSite),
    proxy_preference: ProxyPreference::default(),
    pacing: PacingProfile::default(),
    escalation: EscalationStrategy::Capped { ceiling: AcquisitionModeHint::Resilient },
};
assert!(pb.validate().is_ok());

Fields§

§id: String

Stable identifier ("tier1-static", "tier1-js", "tier2-hostile", etc.). Required, non-empty, unique within a resolver bundle.

§target_class: TargetClass

Target class this playbook belongs to.

§description: String

Human-readable description for operator logs.

§acquisition: AcquisitionDefaults

Acquisition-mode defaults.

§proxy_preference: ProxyPreference

Proxy preference.

§pacing: PacingProfile

Pacing profile.

§escalation: EscalationStrategy

Escalation strategy.

Implementations§

Source§

impl Playbook

Source

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

Validate the playbook’s internal consistency. Reports the first failing field with a structured error that includes both the field path and the bad value.

§Errors

Returns ValidationError on the first inconsistency. The error embeds the field path and the bad value so operators can locate the offending TOML line without re-running the loader.

§Example
use stygian_charon::playbooks::{
    AcquisitionDefaults, EscalationStrategy, PacingProfile, Playbook, ProxyPreference,
};
use stygian_charon::acquisition::AcquisitionModeHint;
use stygian_charon::types::{ExecutionMode, SessionMode, TargetClass, TelemetryLevel};

let bad = Playbook {
    id: String::new(),
    target_class: TargetClass::ContentSite,
    description: String::new(),
    acquisition: AcquisitionDefaults {
        mode: AcquisitionModeHint::Fast,
        execution_mode: ExecutionMode::Http,
        session_mode: SessionMode::Stateless,
        telemetry_level: TelemetryLevel::Basic,
        sticky_session_ttl_secs: None,
        enable_warmup: false,
        retry_budget: 0,
        backoff_base_ms: 250,
    },
    proxy_preference: ProxyPreference::default(),
    pacing: PacingProfile::default(),
    escalation: EscalationStrategy::Capped { ceiling: AcquisitionModeHint::Fast },
};
let err = bad.validate().expect_err("id is empty");
assert!(err.to_string().contains("id"));
Source

pub const fn to_runtime_policy_hints(&self) -> RuntimePolicyHints

Convenience helper that converts the resolved playbook into a crate::acquisition::RuntimePolicyHints block ready to feed into crate::acquisition::map_policy_hints. The mapping is pure and deterministic.

§Example
use stygian_charon::playbooks::{Playbook, AcquisitionDefaults};
use stygian_charon::types::TargetClass;

let pb = Playbook {
    id: "tier1-static".to_string(),
    target_class: TargetClass::ContentSite,
    description: String::new(),
    acquisition: AcquisitionDefaults::default_for(TargetClass::ContentSite),
    proxy_preference: Default::default(),
    pacing: Default::default(),
    escalation: Default::default(),
};
let _hints = pb.to_runtime_policy_hints();

Trait Implementations§

Source§

impl Clone for Playbook

Source§

fn clone(&self) -> Playbook

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 Playbook

Source§

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

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

impl<'de> Deserialize<'de> for Playbook

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 Playbook

Source§

fn eq(&self, other: &Playbook) -> 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 Playbook

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 Playbook

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
Source§

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