Skip to main content

StreamAnnotation

Enum StreamAnnotation 

Source
pub enum StreamAnnotation {
    Normal,
    NotNull,
    Done,
}
Expand description

Streaming annotation for field-level emission control.

Controls when a field value should be emitted during streaming parsing.

§Examples

use simple_agents_healing::schema::{StreamAnnotation, Field, Schema};

// Emit as soon as available (default)
let normal_field = Field {
    name: "name".to_string(),
    schema: Schema::String,
    required: true,
    aliases: vec![],
    default: None,
    description: None,
    stream_annotation: StreamAnnotation::Normal,
};

// Don't emit until non-null
let id_field = Field {
    name: "id".to_string(),
    schema: Schema::Int,
    required: true,
    aliases: vec![],
    default: None,
    description: None,
    stream_annotation: StreamAnnotation::NotNull,
};

// Only emit when complete
let status_field = Field {
    name: "status".to_string(),
    schema: Schema::String,
    required: true,
    aliases: vec![],
    default: None,
    description: None,
    stream_annotation: StreamAnnotation::Done,
};

Variants§

§

Normal

Emit field as soon as it’s available (default)

§

NotNull

Don’t emit until value is non-null (@@stream.not_null)

§

Done

Only emit when the entire structure is complete (@@stream.done)

Trait Implementations§

Source§

impl Clone for StreamAnnotation

Source§

fn clone(&self) -> StreamAnnotation

Returns a duplicate of the value. Read more
1.0.0 · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for StreamAnnotation

Source§

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

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

impl Default for StreamAnnotation

Source§

fn default() -> StreamAnnotation

Returns the “default value” for a type. Read more
Source§

impl<'de> Deserialize<'de> for StreamAnnotation

Source§

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>
where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer. Read more
Source§

impl PartialEq for StreamAnnotation

Source§

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

Tests for self and other values to be equal, and is used by ==.
1.0.0 · Source§

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.
Source§

impl Serialize for StreamAnnotation

Source§

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

Serialize this value into the given Serde serializer. Read more
Source§

impl Copy for StreamAnnotation

Source§

impl Eq for StreamAnnotation

Source§

impl StructuralPartialEq for StreamAnnotation

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

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

Source§

fn vzip(self) -> V

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

impl<T> DeserializeOwned for T
where T: for<'de> Deserialize<'de>,