Struct ModelPickerState 

pub struct ModelPickerState { /* private fields */ }

The catalog, the chosen model and its effort, the favorites, the view the rail shows, the search, and the open panel of a ModelPicker.

Owned by the view that shows the picker, which observes it so a change renders. The choice and the favorites are kept by model id, so a catalog that changes under them keeps the ones whose model is still there. The state does not save anything: the application listens for ModelPickerEvent::FavoriteChanged and seeds the favorites again with with_favorites.

Implementations

impl ModelPickerState

pub fn new( providers: impl IntoIterator<Item = ModelProvider>, window: &mut Window, cx: &mut Context<'_, Self>, ) -> Self

A picker over providers with nothing chosen and no favorites. The rail starts on the first provider.

pub fn with_selected(self, id: impl Into<SharedString>) -> Self

Chooses the model with id, if the catalog has it. The rail moves to its provider.

pub fn with_view(self, view: ModelView) -> Self

Starts on view: the favorites, or a provider the catalog holds. A provider it does not hold changes nothing.

pub fn with_effort(self, level: u8) -> Self

Starts the effort at level, clamped to the last level.

pub fn with_effort_levels( self, levels: impl IntoIterator<Item = impl Into<SharedString>>, ) -> Self

The names of the effort levels, lowest first, in place of EFFORT_LABELS. EffortChanged and effort are indices into them. An empty list changes nothing. The effort is clamped to the new last level.

pub fn effort_levels(&self) -> &[SharedString]

The names of the effort levels, lowest first.

pub fn with_favorites( self, ids: impl IntoIterator<Item = impl Into<SharedString>>, ) -> Self

Starts with these favorites, in this order. An id the catalog does not hold is ignored, and so is a repeat.

pub fn providers(&self) -> &[ModelProvider]

The catalog, in order.

pub fn set_providers( &mut self, providers: impl IntoIterator<Item = ModelProvider>, cx: &mut Context<'_, Self>, )

Replaces the catalog. The choice and the favorites stay for models still in the catalog and are dropped for the others.

pub fn selected(&self) -> Option<&SharedString>

The id of the chosen model.

pub fn selected_model(&self) -> Option<(&ModelProvider, &ModelEntry)>

The chosen model and its provider.

pub fn select( &mut self, id: impl Into<SharedString>, cx: &mut Context<'_, Self>, )

Chooses the model with id and emits Selected. An unknown id, or the model already chosen, changes nothing. The rail moves to the model’s provider.

pub fn effort(&self) -> Option<u8>

The effort level of the chosen model, an index into effort_levels (0 to 5 by default), or None when no model is chosen or the chosen model has no effort setting.

pub fn effort_label(&self) -> Option<SharedString>

The name of the effort level, such as “Medium”.

pub fn set_effort(&mut self, level: u8, cx: &mut Context<'_, Self>)

Sets the effort to level, clamped to the last level, and emits EffortChanged.

pub fn favorites(&self) -> &[SharedString]

The favorite models’ ids, in the order they were starred.

pub fn is_favorite(&self, id: &str) -> bool

Whether the model with id is a favorite.

pub fn set_favorite( &mut self, id: impl Into<SharedString>, favorite: bool, cx: &mut Context<'_, Self>, )

Stars or unstars the model with id and emits FavoriteChanged. An unknown id, or a model already in that state, changes nothing.

pub fn toggle_favorite( &mut self, id: impl Into<SharedString>, cx: &mut Context<'_, Self>, )

Stars the model if it is not a favorite and unstars it if it is.

pub fn view(&self) -> &ModelView

What the rail has selected.

pub fn set_view( &mut self, view: ModelView, window: &mut Window, cx: &mut Context<'_, Self>, )

Shows view and clears the search so its models show. A provider the catalog does not hold changes nothing.

pub fn query(&self, cx: &App) -> SharedString

The text of the search.

pub fn set_query( &mut self, query: &str, window: &mut Window, cx: &mut Context<'_, Self>, )

Replaces the text of the search.

pub fn visible(&self) -> Vec<(&ModelProvider, &ModelEntry)>

The models the list shows now, as (provider, model) pairs, in the order of the list.

pub fn has_legacy_group(&self) -> bool

Whether the list shows the “Legacy models” header.

pub fn is_legacy_open(&self) -> bool

Whether the legacy group is open.

pub fn set_legacy_open(&mut self, open: bool, cx: &mut Context<'_, Self>)

Opens or closes the legacy group. It is closed until it is opened, and closes again when the view changes.

pub fn highlighted(&self) -> Option<SharedString>

The id of the model the keyboard or the pointer is on.

pub fn is_open(&self) -> bool

Whether the panel is open.

pub fn set_open( &mut self, open: bool, window: &mut Window, cx: &mut Context<'_, Self>, )

Opens or closes the panel and emits OpenChanged. Closing clears the search.

pub fn select_number( &mut self, number: usize, window: &mut Window, cx: &mut Context<'_, Self>, )

Chooses the model on the numberth row of the list, counting from 1 and only models, as Cmd+1 to Cmd+9 do, and closes the panel.

Trait Implementations

impl EventEmitter<ModelPickerEvent> for ModelPickerState

impl Focusable for ModelPickerState

The search field’s focus, which holds the keyboard while the panel is open.

fn focus_handle(&self, cx: &App) -> FocusHandle

Returns the focus handle associated with this view.