Enum PinMode 

pub enum PinMode {
    Always,
    Retrieved,
}

Whether a Fact is always injected or only surfaced when a query retrieves it — the one bit that splits the always-on tier from the retrieval-gated tier.

The core does not inject anything itself; pin is metadata the higher layers (the SDK grounding path) act on. crate::FactRegistry::pinned filters the corpus by it, and both variants are ranked by crate::FactRegistry::search all the same, so a pinned fact is still discoverable by a query.

Variants

Always

Always injected into the context, no ranking — the barbershop’s address, hours, brand voice. Kept tiny; it is paid for on every injection.

Retrieved

Injected only when a query ranks it in — pricing tables, per-service policies. The default: a new fact is retrieval-gated until promoted.

Implementations

impl PinMode

pub fn as_str(&self) -> &'static str

The wire/as_str identifier used across the SDKs: "always" or "retrieved".

Trait Implementations

impl Clone for PinMode

fn clone(&self) -> PinMode

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for PinMode

impl Debug for PinMode

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

Formats the value using the given formatter.

impl Default for PinMode

fn default() -> PinMode

Returns the “default value” for a type.

impl Display for PinMode

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

Formats the value using the given formatter.

impl Eq for PinMode

impl FromStr for PinMode

fn from_str(s: &str) -> Result<Self, Self::Err>

Parse the SDK identifier: "always" or "retrieved".

Errors

Any other string is a ParsePinModeError naming the rejected input.

Examples

use ratel_ai_core::PinMode;

assert_eq!("always".parse::<PinMode>(), Ok(PinMode::Always));
assert_eq!("retrieved".parse::<PinMode>(), Ok(PinMode::Retrieved));
assert!("pinned".parse::<PinMode>().is_err());

type Err = ParsePinModeError

The associated error which can be returned from parsing.

impl PartialEq for PinMode

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for PinMode