Struct UserSettings 

#[non_exhaustive]
pub struct UserSettings {

    pub theme: Option<String>,
    pub symbol: Option<String>,
    pub interval: Option<Timeframe>,
    pub drawing_favorites: Vec<DrawingToolType>,
    pub drawing_favorites_hidden: bool,
    pub drawing_favorites_pos: Option<(f32, f32)>,
    pub magnet_hint_dismissed: bool,
    pub layout: Option<String>,
    pub layout_autosave: bool,
    pub layout_favorites: Vec<String>,
    pub indicator_favorites: Vec<String>,
    pub interval_favorites: Vec<Timeframe>,
    pub drawing_defaults: BTreeMap<String, Value>,
    pub watchlists: Vec<Watchlist>,
    pub market_heatmap: MarketHeatmapSelection,
    pub replay_session: Option<(ReplaySession, Timeframe)>,
}

What the library keeps of the user between sessions, in the StoreKind::Settings document settings that SettingsStore reads and writes.

Build it with Default and assign fields: later releases add fields without a breaking change.

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

theme: Option<String>

Name of the theme preset, as listed by presets.

symbol: Option<String>

The symbol shown last.

interval: Option<Timeframe>

The interval shown last.

drawing_favorites: Vec<DrawingToolType>

The drawing tools on the drawing toolbar’s favourites bar, in order. A tool this release does not know is left out when reading.

drawing_favorites_hidden: bool

Whether the user hid the favourites strip with its close or toggle button.

drawing_favorites_pos: Option<(f32, f32)>

The top-left corner of the favourites strip, in logical points, where the user left it; None until it has been shown, when it starts beside the drawing toolbar.

magnet_hint_dismissed: bool

Whether the user dismissed the drawing toolbar’s card that explains the magnet; a document without it reads as not dismissed.

layout: Option<String>

The layout open last, to open again on start.

layout_autosave: bool

Whether the open layout is saved after each change.

layout_favorites: Vec<String>

The names of the starred layouts.

indicator_favorites: Vec<String>

Factory names of the starred studies of the indicator dialog, in order.

interval_favorites: Vec<Timeframe>

The intervals starred in the interval menu, in order.

drawing_defaults: BTreeMap<String, Value>

The properties each drawing tool starts with, keyed by tool, as the JSON of its DrawingTemplate. A tool without an entry starts with the built-in defaults.

watchlists: Vec<Watchlist>

The watchlists, in order.

market_heatmap: MarketHeatmapSelection

The market heatmap’s universe, size metric and colour metric.

replay_session: Option<(ReplaySession, Timeframe)>

The replay position to resume, with the interval its history was fetched at.

Implementations

impl UserSettings

pub const VERSION: u32 = 1

The version of the document to_json writes.

pub fn to_json(&self) -> String

The settings as a versioned JSON document.

pub fn from_json(json: &str) -> Result<Self, Error>

Reads a document to_json wrote, migrating older versions. Fails on invalid JSON and on a version this release does not know. A missing field takes its default.

Trait Implementations

impl Clone for UserSettings

fn clone(&self) -> UserSettings

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for UserSettings

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

Formats the value using the given formatter.

impl Default for UserSettings

fn default() -> UserSettings

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for UserSettings

where UserSettings: Default,

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for UserSettings

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

Equality operator ==.

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=.

impl Serialize for UserSettings

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for UserSettings