Struct PromptRef 

pub struct PromptRef {
    pub name: PromptName,
    pub version: PromptVersion,
    pub hash: Digest,
}

Which prompt text produced a turn.

Small and cheap to clone: three owned strings, no borrowed lifetimes and no content. It is safe to log and to store, because a name, a version and a digest are identifiers and never the prompt body.

The obligation

A reference is only worth what its hash is worth. Whatever produces one owes the reader this: hash is the digest of the text that was actually used, computed with Digest::of_bytes over the UTF-8 bytes. Build one with PromptRef::of_text and the obligation is met by construction; build one field by field and PromptRef::matches is how a test proves it.

Fields

name: PromptName

The name the application asked for.

version: PromptVersion

The version its source returned.

hash: Digest

BLAKE3 digest of the UTF-8 bytes of the prompt text.

Implementations

impl PromptRef

pub fn of_text( name: impl Into<PromptName>, version: impl Into<PromptVersion>, text: &str, ) -> Self

A reference to text, with its hash computed here so it cannot be wrong.

pub fn new( name: impl Into<PromptName>, version: impl Into<PromptVersion>, hash: Digest, ) -> Self

A reference assembled from parts, for a source that already holds a digest it trusts.

Prefer PromptRef::of_text; this constructor exists for the deserialization-shaped cases, and it is the caller who then owes the obligation described on the type.

pub fn matches(&self, text: &str) -> bool

Returns true when text is the text this reference stands for.

pub fn label(&self) -> String

A short, stable label for a metric or a span attribute: name@version.

Without the digest, which is 64 characters and belongs in the record rather than in a dashboard legend.

Trait Implementations

impl Clone for PromptRef

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for PromptRef

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for PromptRef

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for PromptRef

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

name@version#12345678 — the label plus the first eight hex characters of the digest, which is enough to tell two texts apart in a log line.

impl Eq for PromptRef

impl Hash for PromptRef

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl JsonSchema for PromptRef

fn schema_name() -> Cow<'static, str>

The name of the generated JSON Schema.

fn schema_id() -> Cow<'static, str>

Returns a string that uniquely identifies the schema produced by this type.

fn json_schema(generator: &mut SchemaGenerator) -> Schema

Generates a JSON Schema for this type.

fn inline_schema() -> bool

Whether JSON Schemas generated for this type should be included directly in parent schemas, rather than being re-used where possible using the $ref keyword.

impl Ord for PromptRef

fn cmp(&self, other: &Self) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized,

Restrict a value to a certain interval.

fn clamp_to<R>(self, range: R) -> Self

where Self: Sized, R: ClampBounds<Self>,

🔬This is a nightly-only experimental API. (clamp_to)

Restrict a value to a certain range.

impl PartialEq for PromptRef

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

Equality operator ==.

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

Inequality operator !=.

impl PartialOrd for PromptRef

fn partial_cmp(&self, other: &Self) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

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

Tests less than (for self and other) and is used by the < operator.

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

Tests less than or equal to (for self and other) and is used by the <= operator.

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

Tests greater than (for self and other) and is used by the > operator.

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

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl Serialize for PromptRef

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for PromptRef