Struct Chat

pub struct Chat {
    pub stream: bool,
    /* private fields */
}

A batteries-included chat to to implement chatbots.

Fields

stream: bool

Toggles response streaming on or off. Default is on.

Implementations

impl Chat

pub fn prompt_input_ref(&self) -> PromptInputRef

Getter to the underlying PromptInputRef independent of its id.

pub fn messages_ref(&self) -> MessagesRef

Getter to the underlying MessagesRef independent of its id.

pub fn dispatch(&mut self, cx: &mut Cx, tasks: &mut Vec<ChatTask>)

Dispatch a set of tasks to be executed by the Chat widget as a single hookable unit of work.

You can still hook into these tasks before they are executed if you set a hook with Chat::set_hook_before.

Warning: Like other operation over makepad’s [WidgetRef], this function may panic if you hold borrows to widgets inside Chat, for example Messages or PromptInput. Be aware when using read_with and write_with methods.

pub fn perform(&mut self, cx: &mut Cx, tasks: &[ChatTask])

Performs a set of tasks in the Chat widget immediately.

This is not hookable.

pub fn set_hook_before( &mut self, hook: impl FnMut(&mut Vec<ChatTask>, &mut Chat, &mut Cx) + 'static, )

Sets a hook to be executed before a group of tasks is executed.

You get mutable access to the group of tasks, so you can modify what is about to happen. See ChatTask for more details about this.

If you just want to get notified when something already happened, see Chat::set_hook_after.

pub fn set_hook_after( &mut self, hook: impl FnMut(&[ChatTask], &mut Chat, &mut Cx) + 'static, )

Sets a hook to be executed after a group of tasks is executed.

You get immutable access to the group of tasks, so you can inspect what happened.

pub fn is_streaming(&self) -> bool

Returns true if the chat is currently streaming.

pub fn set_bot_id(&mut self, cx: &mut Cx, bot_id: Option<BotId>)

pub fn bot_id(&self) -> Option<&BotId>

pub fn set_bot_context(&mut self, cx: &mut Cx, bot_context: Option<BotContext>)

pub fn bot_context(&self) -> Option<&BotContext>

Methods from Deref<Target = View>

pub fn swap_child(&mut self, pos_a: usize, pos_b: usize)

pub fn child_index(&mut self, comp: &WidgetRef) -> Option<usize>

pub fn child_at_index(&mut self, index: usize) -> Option<&WidgetRef>

pub fn set_scroll_pos(&mut self, cx: &mut Cx, v: DVec2)

pub fn area(&self) -> Area

pub fn walk_from_previous_size(&self, walk: Walk) -> Walk

pub fn child_count(&self) -> usize

pub fn debug_print_children(&self)

pub fn set_key_focus(&self, cx: &mut Cx)

Trait Implementations

impl Deref for Chat

type Target = View

The resulting type after dereferencing.

fn deref(&self) -> &Self::Target

Dereferences the value.

impl DerefMut for Chat

fn deref_mut(&mut self) -> &mut Self::Target

Mutably dereferences the value.

impl LiveApply for Chat

fn apply( &mut self, cx: &mut Cx, apply: &mut Apply<'_, '_, '_>, start_index: usize, nodes: &[LiveNode], ) -> usize

fn apply_over(&mut self, cx: &mut Cx, nodes: &[LiveNode])

impl LiveApplyReset for Chat

fn apply_reset( &mut self, cx: &mut Cx, apply: &mut Apply<'_, '_, '_>, start_index: usize, nodes: &[LiveNode], )

impl LiveApplyValue for Chat

fn apply_value( &mut self, cx: &mut Cx, apply: &mut Apply<'_, '_, '_>, index: usize, nodes: &[LiveNode], ) -> usize

impl LiveHook for Chat

fn apply_value_unknown( &mut self, cx: &mut Cx, _apply: &mut Apply<'_, '_, '_>, index: usize, nodes: &[LiveNode], ) -> usize

fn skip_apply_animator( &mut self, _cx: &mut Cx, _apply: &mut Apply<'_, '_, '_>, _index: usize, _nodes: &[LiveNode], ) -> bool

fn apply_value_instance( &mut self, _cx: &mut Cx, _apply: &mut Apply<'_, '_, '_>, index: usize, nodes: &[LiveNode], ) -> usize

fn skip_apply( &mut self, _cx: &mut Cx, _apply: &mut Apply<'_, '_, '_>, _index: usize, _nodes: &[LiveNode], ) -> Option<usize>

fn before_apply( &mut self, _cx: &mut Cx, _apply: &mut Apply<'_, '_, '_>, _index: usize, _nodes: &[LiveNode], )

fn after_apply( &mut self, _cx: &mut Cx, _apply: &mut Apply<'_, '_, '_>, _index: usize, _nodes: &[LiveNode], )

fn after_apply_from(&mut self, cx: &mut Cx, apply: &mut Apply<'_, '_, '_>)

fn after_new_from_doc(&mut self, _cx: &mut Cx)

fn after_update_from_doc(&mut self, _cx: &mut Cx)

fn after_apply_from_doc(&mut self, _cx: &mut Cx)

fn after_new_before_apply(&mut self, _cx: &mut Cx)

impl LiveHookDeref for Chat

fn deref_before_apply( &mut self, cx: &mut Cx, apply: &mut Apply<'_, '_, '_>, index: usize, nodes: &[LiveNode], )

fn deref_after_apply( &mut self, cx: &mut Cx, apply: &mut Apply<'_, '_, '_>, index: usize, nodes: &[LiveNode], )

impl LiveNew for Chat

fn live_type_info(cx: &mut Cx) -> LiveTypeInfo

fn live_design_with(cx: &mut Cx)

fn new(cx: &mut Cx) -> Self

fn new_apply( cx: &mut Cx, apply: &mut Apply<'_, '_, '_>, index: usize, nodes: &[LiveNode], ) -> Self

where Self: Sized,

fn new_apply_over(cx: &mut Cx, nodes: &[LiveNode]) -> Self

where Self: Sized,

fn new_apply_mut_index( cx: &mut Cx, apply: &mut Apply<'_, '_, '_>, index: &mut usize, nodes: &[LiveNode], ) -> Self

where Self: Sized,

fn new_from_ptr(cx: &mut Cx, live_ptr: Option<LivePtr>) -> Self

where Self: Sized,

fn update_from_ptr(&mut self, cx: &mut Cx, live_ptr: Option<LivePtr>)

fn update_from_ptr_with_scope( &mut self, cx: &mut Cx, live_ptr: Option<LivePtr>, scope: &mut Scope<'_, '_>, )

fn new_from_ptr_with_scope( cx: &mut Cx, live_ptr: Option<LivePtr>, scope: &mut Scope<'_, '_>, ) -> Self

where Self: Sized,

fn new_main(cx: &mut Cx) -> Option<Self>

where Self: Sized,

fn register_main_module(cx: &mut Cx)

fn update_main(&mut self, cx: &mut Cx)

fn new_local(cx: &mut Cx) -> Self

where Self: Sized,

fn new_from_module( cx: &mut Cx, module_id: LiveModuleId, id: LiveId, ) -> Option<Self>

where Self: Sized,

fn update_from_module( &mut self, cx: &mut Cx, module_id: LiveModuleId, id: LiveId, )

impl LiveRegister for Chat

fn live_register(cx: &mut Cx)

impl Widget for Chat

fn handle_event( &mut self, cx: &mut Cx, event: &Event, scope: &mut Scope<'_, '_>, )

fn draw_walk( &mut self, cx: &mut Cx2d<'_, '_>, scope: &mut Scope<'_, '_>, walk: Walk, ) -> DrawStep

fn handle_event_with( &mut self, cx: &mut Cx, event: &Event, scope: &mut Scope<'_, '_>, _sweep_area: Area, )

fn widget(&self, path: &[LiveId]) -> WidgetRef

fn widgets(&self, paths: &[&[LiveId]]) -> WidgetSet

fn widget_uid(&self) -> WidgetUid

fn widget_to_data( &self, _cx: &mut Cx, _actions: &[Box<dyn ActionTrait>], _nodes: &mut Vec<LiveNode>, _path: &[LiveId], ) -> bool

fn data_to_widget( &mut self, _cx: &mut Cx, _nodes: &[LiveNode], _path: &[LiveId], )

fn draw_3d( &mut self, _cx: &mut Cx3d<'_, '_>, _scope: &mut Scope<'_, '_>, ) -> Result<(), WidgetRef>

fn draw_3d_all(&mut self, cx: &mut Cx3d<'_, '_>, scope: &mut Scope<'_, '_>)

fn draw( &mut self, cx: &mut Cx2d<'_, '_>, scope: &mut Scope<'_, '_>, ) -> Result<(), WidgetRef>

fn draw_walk_all( &mut self, cx: &mut Cx2d<'_, '_>, scope: &mut Scope<'_, '_>, walk: Walk, )

fn draw_all(&mut self, cx: &mut Cx2d<'_, '_>, scope: &mut Scope<'_, '_>)

fn draw_unscoped(&mut self, cx: &mut Cx2d<'_, '_>) -> Result<(), WidgetRef>

fn draw_all_unscoped(&mut self, cx: &mut Cx2d<'_, '_>)

fn text(&self) -> String

fn set_text(&mut self, _cx: &mut Cx, _v: &str)

fn set_key_focus(&self, cx: &mut Cx)

fn key_focus(&self, cx: &Cx) -> bool

fn set_disabled(&mut self, _cx: &mut Cx, _disabled: bool)

fn disabled(&self, _cx: &Cx) -> bool

fn ref_cast_type_id(&self) -> TypeId

where Self: 'static,

fn ui_runner(&self) -> UiRunner<Self>

where Self: Sized + 'static,

impl WidgetNode for Chat

fn visible(&self) -> bool

fn set_visible(&mut self, cx: &mut Cx, visible: bool)

fn area(&self) -> Area

fn walk(&mut self, cx: &mut Cx) -> Walk

fn redraw(&mut self, cx: &mut Cx)

fn find_widgets( &self, path: &[LiveId], cached: WidgetCache, results: &mut WidgetSet, )

fn uid_to_widget(&self, uid: WidgetUid) -> WidgetRef

fn widget_design(&mut self) -> Option<&mut dyn WidgetDesign>

fn set_action_data(&mut self, _data: Arc<dyn ActionTrait>)

fn action_data(&self) -> Option<Arc<dyn ActionTrait>>