Skip to main content

Output

Struct Output 

Source
pub struct Output<T> { /* private fields */ }
Expand description

A structured output specification producing values of type T.

Implementations§

Source§

impl<T> Output<T>

Source

pub fn custom(handler: impl OutputHandler<T>) -> Self

Wraps a custom strategy.

Source

pub fn handler(&self) -> Arc<dyn OutputHandler<T>>

The underlying handler.

Source§

impl Output<String>

Source

pub fn text() -> Self

Plain text (the default when no output is configured).

Source

pub fn choice(options: impl IntoIterator<Item = impl Into<String>>) -> Self

One of options, enforced through a JSON schema enum.

Source§

impl<T: DeserializeOwned + JsonSchema + Send + Sync + 'static> Output<T>

Source

pub fn object() -> Self

A JSON object described by T’s derived schema.

Source§

impl<T: DeserializeOwned + Send + Sync + 'static> Output<T>

Source

pub fn object_with(schema: Schema<T>) -> Self

A JSON object validated by schema.

Source§

impl<T: DeserializeOwned + JsonSchema + Send + Sync + 'static> Output<Vec<T>>

Source

pub fn array() -> Self

An array of elements described by T’s derived schema.

Source§

impl<T: DeserializeOwned + Send + Sync + 'static> Output<Vec<T>>

Source

pub fn array_with(element: Schema<T>) -> Self

An array of elements validated by element.

Source§

impl Output<JsonValue>

Source

pub fn json() -> Self

Unconstrained JSON.

Source

pub fn json_with_schema(schema: JsonValue) -> Self

JSON validated by a raw JSON schema.

Trait Implementations§

Source§

impl<T> Clone for Output<T>

Source§

fn clone(&self) -> Self

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<T> Debug for Output<T>

Source§

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

Formats the value using the given formatter. Read more

Auto Trait Implementations§

§

impl<T> !RefUnwindSafe for Output<T>

§

impl<T> !UnwindSafe for Output<T>

§

impl<T> Freeze for Output<T>
where Arc<dyn OutputHandler<T>>: Freeze,

§

impl<T> Send for Output<T>
where Arc<dyn OutputHandler<T>>: Send,

§

impl<T> Sync for Output<T>
where Arc<dyn OutputHandler<T>>: Sync,

§

impl<T> Unpin for Output<T>
where Arc<dyn OutputHandler<T>>: Unpin,

§

impl<T> UnsafeUnpin for Output<T>
where Arc<dyn OutputHandler<T>>: UnsafeUnpin,

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<ST, DT> CastableFrom<ST, Initialized, Initialized> for DT
where ST: ?Sized, DT: ?Sized,

Source§

impl<ST, DT> CastableFrom<ST, Uninit, Uninit> for DT
where ST: ?Sized, DT: ?Sized,

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> DynClone for T
where T: Clone,

Source§

fn __clone_box(&self, _: Private) -> *mut ()

Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
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> PolicyExt for T
where T: ?Sized,

Source§

fn and<P, B, E>(self, other: P) -> And<T, P>
where T: Sized + Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow only if self and other return Action::Follow. Read more
Source§

fn or<P, B, E>(self, other: P) -> Or<T, P>
where T: Sized + Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow if either self or other returns Action::Follow. Read more
Source§

impl<T> Read<Exclusive, BecauseExclusive> for T
where T: ?Sized,

Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
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 = !

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

fn try_from(value: U) -> Result<T, !>

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

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more