Skip to main content

OutputContract

Struct OutputContract 

Source
pub struct OutputContract {
    pub codec: Symbol,
    pub shape_expr: Expr,
    pub grammar: Option<String>,
    pub required: bool,
}
Expand description

Output obligations attached to a model request.

Fields§

§codec: Symbol

Codec the receiver must use for the return value.

§shape_expr: Expr

Normalized shape expression describing the return value.

§grammar: Option<String>

Optional constrained-generation grammar derived from the shape.

§required: bool

Whether a runner that accepts grammars must enforce the grammar.

Implementations§

Source§

impl OutputContract

Source

pub fn new( codec: Symbol, shape_expr: Expr, grammar: Option<String>, required: bool, ) -> Self

Builds an output contract with an explicit grammar.

Source

pub fn for_shape( codec: Symbol, shape_expr: Expr, shape: &dyn Shape, required: bool, ) -> Self

Builds an output contract, deriving a grammar when the shape supports it.

Source

pub fn into_extra_entries(self, extra: &mut Vec<(Expr, Expr)>)

Appends this contract to a ModelRequest extra map.

Trait Implementations§

Source§

impl Clone for OutputContract

Source§

fn clone(&self) -> OutputContract

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for OutputContract

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Eq for OutputContract

Source§

impl PartialEq for OutputContract

Source§

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

Equality operator ==. Read more
1.0.0 (const: unstable) · Source§

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

Inequality operator !=. Read more
Source§

impl StructuralPartialEq for OutputContract

Auto Trait Implementations§

Blanket Implementations§

Source§

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

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

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

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

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

Source§

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

Mutably borrows from an owned value. Read more
Source§

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

Source§

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
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

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

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

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

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

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

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

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

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

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

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

Performs the conversion.
Source§

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

Source§

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

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.