Skip to main content

UiStreamPart

arcan_core::aisdk

Enum UiStreamPart

pub enum UiStreamPart {
Show 18 variants    Start {
        message_id: String,
    },
    Finish {},
    StartStep {},
    FinishStep {},
    Abort {
        reason: String,
    },
    TextStart {
        id: String,
    },
    TextDelta {
        id: String,
        delta: String,
    },
    TextEnd {
        id: String,
    },
    ReasoningStart {
        id: String,
    },
    ReasoningDelta {
        id: String,
        delta: String,
    },
    ReasoningEnd {
        id: String,
    },
    ToolInputStart {
        tool_call_id: String,
        tool_name: String,
    },
    ToolInputDelta {
        tool_call_id: String,
        input_text_delta: String,
    },
    ToolInputAvailable {
        tool_call_id: String,
        tool_name: String,
        input: Value,
    },
    ToolOutputAvailable {
        tool_call_id: String,
        output: Value,
    },
    Error {
        error_text: String,
    },
    DataStatePatch {
        data: Value,
    },
    DataApprovalRequest {
        data: Value,
    },
}

Expand description

Vercel AI SDK v6 “UI Message Stream Protocol” part.

Each variant maps to a v6 stream part type. Custom Arcan extensions use the data-* namespace per spec.

Variants§

Start

Fields

§message_id: String

Finish

StartStep

FinishStep

Abort

Fields

§reason: String

TextStart

Fields

§id: String

TextDelta

Fields

§id: String

§delta: String

TextEnd

Fields

§id: String

ReasoningStart

Fields

§id: String

ReasoningDelta

Fields

§id: String

§delta: String

ReasoningEnd

Fields

§id: String

ToolInputStart

Fields

§tool_call_id: String

§tool_name: String

ToolInputDelta

Fields

§tool_call_id: String

§input_text_delta: String

ToolInputAvailable

Fields

§tool_call_id: String

§tool_name: String

§input: Value

ToolOutputAvailable

Fields

§tool_call_id: String

§output: Value

Error

Fields

§error_text: String

DataStatePatch

Fields

§data: Value

DataApprovalRequest

Fields

§data: Value

Trait Implementations§

impl Clone for UiStreamPart

fn clone(&self) -> UiStreamPart

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

impl Debug for UiStreamPart

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

Formats the value using the given formatter. Read more

impl<'de> Deserialize<'de> for UiStreamPart

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

Deserialize this value from the given Serde deserializer. Read more

impl PartialEq for UiStreamPart

fn eq(&self, other: &UiStreamPart) -> 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.

impl Serialize for UiStreamPart

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

Serialize this value into the given Serde serializer. Read more

impl StructuralPartialEq for UiStreamPart

Auto Trait Implementations§

impl Freeze for UiStreamPart

impl RefUnwindSafe for UiStreamPart

impl Send for UiStreamPart

impl Sync for UiStreamPart

impl Unpin for UiStreamPart

impl UnsafeUnpin for UiStreamPart

impl UnwindSafe for UiStreamPart

Blanket Implementations§

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

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more

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

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

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

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

Mutably borrows from an owned value. Read more

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

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

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

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

impl<T> From<T> for T

fn from(t: T) -> T

Returns the argument unchanged.

impl<T> Instrument for T

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

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

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more

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

fn into(self) -> U

Calls U::from(self).

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

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

type Owned = T

The resulting type after obtaining ownership.

fn to_owned(&self) -> T

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

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

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

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

type Error = Infallible

The type returned in the event of a conversion error.

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

Performs the conversion.

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

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

The type returned in the event of a conversion error.

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

Performs the conversion.

impl<T> WithSubscriber for T

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

fn with_current_subscriber(self) -> WithDispatch<Self>

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

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