Skip to main content

Engine

Struct Engine 

Source
pub struct Engine {
    pub rules: Vec<CompiledRule>,
    pub policy: Policy,
}

Fields§

§rules: Vec<CompiledRule>§policy: Policy

Implementations§

Source§

impl Engine

Source

pub fn from_yaml(raw: &str) -> Result<Self>

Load a Shield ruleset from a YAML string. Returns an error on malformed YAML or regex compilation failure.

Source

pub fn extend_from_yaml(&mut self, raw: &str) -> Result<()>

Merge an additional rule pack (e.g. the optional ATR community pack) into an already-loaded engine. The pack’s policy: block, if any, is IGNORED – policy always comes from the primary shieldset. Duplicate rule ids across packs are an error: silent shadowing would make composite scoring double-count.

Source

pub fn builtin_default() -> Self

Bundled defaults – the same YAML used by the enterprise build, embedded at compile time so the binary always has some ruleset.

Source

pub fn evaluate( &self, tool: &str, params: &Value, adj: Adjustments, ) -> Evaluation

Evaluate a tool call. Returns the full evaluation (which rules fired, points, raw vs composite vs final severity). The caller turns this into a Decision via decide_tool_call.

Source

pub fn evaluate_text(&self, text: &str, adj: Adjustments) -> Evaluation

Evaluate an LLM response body.

Source

pub fn evaluate_scoped_text( &self, scope: Scope, tool: Option<&str>, text: &str, adj: Adjustments, ) -> Evaluation

Evaluate free text against the rules of one scope. tool is the tool the text belongs to (the described tool for Scope::ToolDescription, the called tool for Scope::ToolResult); rules with a tool: whitelist only fire when it matches.

Trait Implementations§

Source§

impl Debug for Engine

Source§

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

Formats the value using the given formatter. 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> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<A, B, T> HttpServerConnExec<A, B> for T
where B: Body,

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> PolicyExt for T
where T: ?Sized,

Source§

fn and<P, B, E>(self, other: P) -> And<T, P>
where T: Sized + 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
Source§

fn or<P, B, E>(self, other: P) -> Or<T, P>
where T: Sized + 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> Same for T

Source§

type Output = T

Should always be Self
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<V, T> VZip<V> for T
where V: MultiLane<T>,

Source§

fn vzip(self) -> V

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