Struct settings2::SettingsStore

pub struct SettingsStore { /* private fields */ }

A set of strongly-typed setting values defined via multiple JSON files.

Implementations

impl SettingsStore

pub fn register_setting<T: Settings>(&mut self, cx: &mut AppContext)

Add a new type of setting to the store.

pub fn get<T: Settings>(&self, path: Option<(usize, &Path)>) -> &T

Get the value of a setting.

Panics if the given setting type has not been registered, or if there is no value for this setting.

pub fn override_global<T: Settings>(&mut self, value: T)

Override the global value for a setting.

The given value will be overwritten if the user settings file changes.

pub fn raw_user_settings(&self) -> &Value

Get the user’s settings as a raw JSON value.

This is only for debugging and reporting. For user-facing functionality, use the typed setting interface.

pub fn new_text_for_update<T: Settings>( &self, old_text: String, update: impl FnOnce(&mut T::FileContent) ) -> String

Update the value of a setting in a JSON file, returning the new text for that JSON file.

pub fn edits_for_update<T: Settings>( &self, text: &str, update: impl FnOnce(&mut T::FileContent) ) -> Vec<(Range<usize>, String)>

Update the value of a setting in a JSON file, returning a list of edits to apply to the JSON file.

pub fn set_json_tab_size_callback<T: Settings>( &mut self, get_tab_size: fn(_: &T) -> Option<usize> )

Configure the tab sized when updating JSON files.

pub fn set_default_settings( &mut self, default_settings_content: &str, cx: &mut AppContext ) -> Result<()>

Set the default settings via a JSON string.

The string should contain a JSON object with a default value for every setting.

pub fn set_user_settings( &mut self, user_settings_content: &str, cx: &mut AppContext ) -> Result<()>

Set the user settings via a JSON string.

pub fn set_local_settings( &mut self, root_id: usize, path: Arc<Path>, settings_content: Option<&str>, cx: &mut AppContext ) -> Result<()>

Add or remove a set of local settings via a JSON string.

pub fn clear_local_settings( &mut self, root_id: usize, cx: &mut AppContext ) -> Result<()>

Add or remove a set of local settings via a JSON string.

pub fn local_settings( &self, root_id: usize ) -> impl '_ + Iterator<Item = (Arc<Path>, String)>

pub fn json_schema( &self, schema_params: &SettingsJsonSchemaParams<'_>, cx: &AppContext ) -> Value

Trait Implementations

impl Debug for SettingsStore

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

Formats the value using the given formatter.

impl Default for SettingsStore

fn default() -> Self

Returns the “default value” for a type.