Struct PromptCacheRequest 

pub struct PromptCacheRequest {
    pub mode: PromptCacheMode,
    pub strategy: PromptCacheStrategy,
    pub retention: Option<PromptCacheRetention>,
    pub key: Option<String>,
}

Prompt caching request sent alongside a turn.

Fields

mode: PromptCacheMode

Strength of the caching request.

strategy: PromptCacheStrategy

Automatic or explicit caching strategy.

retention: Option<PromptCacheRetention>

Optional provider-neutral retention hint.

key: Option<String>

Optional provider cache key or routing key.

Implementations

impl PromptCacheRequest

pub fn automatic() -> Self

Builds a best-effort automatic cache request.

pub fn automatic_required() -> Self

Builds a required automatic cache request.

pub fn explicit( breakpoints: impl IntoIterator<Item = PromptCacheBreakpoint>, ) -> Self

Builds a best-effort explicit cache request.

pub fn explicit_required( breakpoints: impl IntoIterator<Item = PromptCacheBreakpoint>, ) -> Self

Builds a required explicit cache request.

pub fn disabled() -> Self

Builds a disabled cache request.

pub fn best_effort(strategy: PromptCacheStrategy) -> Self

Builds a best-effort cache request with the given strategy.

pub fn required(strategy: PromptCacheStrategy) -> Self

Builds a required cache request with the given strategy.

pub fn with_mode(self, mode: PromptCacheMode) -> Self

Overrides the request mode.

pub fn with_strategy(self, strategy: PromptCacheStrategy) -> Self

Overrides the request strategy.

pub fn with_retention(self, retention: PromptCacheRetention) -> Self

Applies a provider-neutral retention hint.

pub fn with_key(self, key: impl Into<String>) -> Self

Applies a provider cache key or routing key.

pub fn without_retention(self) -> Self

Clears any provider-neutral retention hint.

pub fn without_key(self) -> Self

Clears any provider cache key or routing key.

pub fn is_enabled(&self) -> bool

Returns true when caching should be active for this request.

Trait Implementations

impl Clone for PromptCacheRequest

fn clone(&self) -> PromptCacheRequest

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for PromptCacheRequest

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

Formats the value using the given formatter.

impl Default for PromptCacheRequest

fn default() -> PromptCacheRequest

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for PromptCacheRequest

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for PromptCacheRequest

fn eq(&self, other: &PromptCacheRequest) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Serialize for PromptCacheRequest

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl Eq for PromptCacheRequest

impl StructuralPartialEq for PromptCacheRequest