Struct zng::config::settings::SETTINGS

pub struct SETTINGS;

Settings metadata service.

Implementations

impl SETTINGS

pub fn register( &self, f: impl Fn(&mut SettingsBuilder<'_>) + Send + Sync + 'static, )

Register a closure that provides settings metadata.

pub fn register_categories( &self, f: impl Fn(&mut CategoriesBuilder<'_>) + Send + Sync + 'static, )

Register a closure that provides category metadata.

pub fn get( &self, filter: impl FnMut(&Txt, &CategoryId) -> bool, sort: bool, ) -> Vec<(Category, Vec<Setting>)>

Select and sort settings matched by filter.

pub fn any(&self, filter: impl FnMut(&Txt, &CategoryId) -> bool) -> bool

Gets if there are any setting matched by filter.

pub fn count(&self, filter: impl FnMut(&Txt, &CategoryId) -> bool) -> usize

Count how many settings match the filter.

pub fn categories( &self, filter: impl FnMut(&CategoryId) -> bool, include_empty: bool, sort: bool, ) -> Vec<Category>

Select and sort categories matched by filter.

If include_empty is true includes categories that have no settings.

pub fn sort_settings(&self, settings: &mut [Setting])

Sort settings.

pub fn sort_categories(&self, categories: &mut [Category])

Sort categories.

pub fn sort(&self, settings: &mut [(Category, Vec<Setting>)])

Sort categories and settings.

Trait Implementations

impl SettingsCtxExt for SETTINGS

fn editor_search(&self) -> ContextVar<Txt>

Gets a read-write context var that tracks the search text.

fn editor_selected_category(&self) -> ContextVar<CategoryId>

Gets a read-write context var that tracks the selected category.

fn editor_state( &self, ) -> ReadOnlyVar<Option<SettingsEditorState>, ContextVar<Option<SettingsEditorState>>>

Gets a read-only context var that tracks the current editor data state.

fn editor_setting( &self, ) -> ReadOnlyVar<Option<Setting>, ContextVar<Option<Setting>>>

Gets a read-only context var that tracks the Setting entry the widget is inside, or will be.