Struct Settings 

pub struct Settings { /* private fields */ }

Implementations

impl Settings

pub fn global() -> Ref<Self>

Retrieve the global settings instance, this will be populated by both the core and plugins.

If you wish to construct your own instance, use Settings::new_with_id instead.

pub fn global_default() -> Ref<Self>

Retrieve the default global settings instance, this is the same as Settings::global but the values will be set to the registered default values.

If you wish to construct your own instance, use Settings::new_with_id instead.

pub fn new_with_id(instance_id: &str) -> Ref<Self>

Create (or get) the settings instance with the given id.

Two special instances can be retrieved by passing DEFAULT_INSTANCE_ID and GLOBAL_INSTANCE_ID.

pub fn set_resource_id(&self, resource_id: &str)

pub fn serialize_schema(&self) -> String

pub fn deserialize_schema(&self, schema: &str) -> bool

pub fn deserialize_schema_with_scope( &self, schema: &str, scope: SettingsScope, ) -> bool

pub fn contains(&self, key: &str) -> bool

pub fn keys(&self) -> Array<BnString>

pub fn get_bool(&self, key: &str) -> bool

pub fn get_bool_with_opts( &self, key: &str, options: &mut QueryOptions<'_>, ) -> bool

pub fn get_double(&self, key: &str) -> f64

pub fn get_double_with_opts( &self, key: &str, options: &mut QueryOptions<'_>, ) -> f64

pub fn get_integer(&self, key: &str) -> u64

pub fn get_integer_with_opts( &self, key: &str, options: &mut QueryOptions<'_>, ) -> u64

pub fn get_string(&self, key: &str) -> String

pub fn get_string_with_opts( &self, key: &str, options: &mut QueryOptions<'_>, ) -> String

pub fn get_string_list(&self, key: &str) -> Array<BnString>

pub fn get_string_list_with_opts( &self, key: &str, options: &mut QueryOptions<'_>, ) -> Array<BnString>

pub fn get_json(&self, key: &str) -> String

pub fn get_json_with_opts( &self, key: &str, options: &mut QueryOptions<'_>, ) -> String

pub fn set_bool(&self, key: &str, value: bool)

pub fn set_bool_with_opts( &self, key: &str, value: bool, options: &QueryOptions<'_>, )

pub fn set_double(&self, key: &str, value: f64)

pub fn set_double_with_opts( &self, key: &str, value: f64, options: &QueryOptions<'_>, )

pub fn set_integer(&self, key: &str, value: u64)

pub fn set_integer_with_opts( &self, key: &str, value: u64, options: &QueryOptions<'_>, )

pub fn set_string(&self, key: &str, value: &str)

pub fn set_string_with_opts( &self, key: &str, value: &str, options: &QueryOptions<'_>, )

pub fn set_string_list<I: IntoIterator<Item = String>>( &self, key: &str, value: I, ) -> bool

pub fn set_string_list_with_opts<I: IntoIterator<Item = String>>( &self, key: &str, value: I, options: &QueryOptions<'_>, ) -> bool

pub fn set_json(&self, key: &str, value: &str) -> bool

pub fn set_json_with_opts( &self, key: &str, value: &str, options: &QueryOptions<'_>, ) -> bool

pub fn get_property_string(&self, key: &str, property: &str) -> String

pub fn get_property_string_list( &self, key: &str, property: &str, ) -> Array<BnString>

pub fn update_bool_property(&self, key: &str, property: &str, value: bool)

pub fn update_integer_property(&self, key: &str, property: &str, value: u64)

pub fn update_double_property(&self, key: &str, property: &str, value: f64)

pub fn update_string_property(&self, key: &str, property: &str, value: &str)

pub fn update_string_list_property<I: IntoIterator<Item = String>>( &self, key: &str, property: &str, value: I, )

pub fn register_group(&self, group: &str, title: &str) -> bool

pub fn register_setting_json(&self, group: &str, properties: &str) -> bool

Trait Implementations

impl Hash for Settings

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl PartialEq for Settings

fn eq(&self, other: &Settings) -> bool

Tests for self and other values to be equal, and is used by ==.

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 ToOwned for Settings

type Owned = Ref<Settings>

The resulting type after obtaining ownership.

fn to_owned(&self) -> Self::Owned

Creates owned data from borrowed data, usually by cloning.

fn clone_into(&self, target: &mut Self::Owned)

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

impl Eq for Settings

impl Send for Settings

impl StructuralPartialEq for Settings

impl Sync for Settings