Skip to main content

ShieldRequest

highflame_shield::types

Struct ShieldRequest

pub struct ShieldRequest {Show 15 fields
    pub content: String,
    pub content_type: String,
    pub action: String,
    pub tool: Option<ToolContext>,
    pub model: Option<ModelContext>,
    pub file: Option<FileContext>,
    pub mcp: Option<McpContext>,
    pub session_id: Option<String>,
    pub mode: Option<String>,
    pub detectors: Option<Vec<String>>,
    pub metadata: Option<HashMap<String, Value>>,
    pub contexts: Option<Vec<String>>,
    pub early_exit: Option<bool>,
    pub explain: Option<bool>,
    pub product: Option<String>,
}

Expand description

Request body for POST /v1/guard.

Fields§

§content: String

Content to evaluate (prompt text, tool arguments, file content, …).

§content_type: String

Content type: "prompt", "response", "tool_call", "file".

§action: String

Action being performed: "process_prompt", "call_tool", "read_file", "write_file", "connect_server".

§tool: Option<ToolContext>§model: Option<ModelContext>§file: Option<FileContext>§mcp: Option<McpContext>§session_id: Option<String>§mode: Option<String>

Execution mode: "enforce", "monitor", "alert".

§detectors: Option<Vec<String>>

Specific detectors to run. None runs all enabled detectors.

§metadata: Option<HashMap<String, Value>>

Arbitrary key-value metadata forwarded to Cedar policies.

§contexts: Option<Vec<String>>

Additional text chunks for RAG context injection.

§early_exit: Option<bool>

Skip remaining tiers as soon as a deny is reached.

§explain: Option<bool>

Include explanation data in the response.

§product: Option<String>

Product namespace: "guardrails" (default) or "overwatch".

Trait Implementations§

impl Clone for ShieldRequest

fn clone(&self) -> ShieldRequest

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

impl Debug for ShieldRequest

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

Formats the value using the given formatter. Read more

impl Default for ShieldRequest

fn default() -> ShieldRequest

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

impl Serialize for ShieldRequest

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

Serialize this value into the given Serde serializer. Read more

Auto Trait Implementations§

impl Freeze for ShieldRequest

impl RefUnwindSafe for ShieldRequest

impl Send for ShieldRequest

impl Sync for ShieldRequest

impl Unpin for ShieldRequest

impl UnsafeUnpin for ShieldRequest

impl UnwindSafe for ShieldRequest

Blanket Implementations§

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

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more

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

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

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

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

Mutably borrows from an owned value. Read more

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

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

impl<T> From<T> for T

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

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

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

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

type Owned = T

The resulting type after obtaining ownership.

fn to_owned(&self) -> T

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

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

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

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

type Error = Infallible

The type returned in the event of a conversion error.

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

Performs the conversion.

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

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

The type returned in the event of a conversion error.

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