Struct LoadedPrompt 

pub struct LoadedPrompt { /* private fields */ }

A prompt, and the reference that names it.

The two fields are private and the only constructors compute or verify the hash, so a value of this type carries the PromptSource promise by construction: reference().hash is the digest of text().

Implementations

impl LoadedPrompt

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

Builds a prompt and derives its reference from the text.

This is the constructor a source should reach for: there is no way to get the hash wrong.

pub fn from_parts( reference: PromptRef, text: impl Into<String>, ) -> Result<Self, PromptError>

Builds a prompt from a reference somebody else produced, checking that the reference is telling the truth.

Errors

PromptError::InconsistentReference when reference.hash is not the digest of text.

pub fn text(&self) -> &str

The prompt text.

pub fn reference(&self) -> &PromptRef

The reference that names this text.

pub fn name(&self) -> &PromptName

The name it was loaded under.

pub fn version(&self) -> &PromptVersion

The version it came back at.

pub fn into_text(self) -> String

Consumes the value and returns the text alone.

pub fn into_parts(self) -> (PromptRef, String)

Consumes the value and returns both halves.

Trait Implementations

impl Clone for LoadedPrompt

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 LoadedPrompt

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

Formats the value using the given formatter.

impl Eq for LoadedPrompt

impl PartialEq for LoadedPrompt

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for LoadedPrompt