Struct AltairConfigOptions

pub struct AltairConfigOptions {
    pub window_options: Option<AltairWindowOptions>,
    pub initial_environments: Option<AltairInitialEnvironments>,
    pub instance_storage_namespace: Option<String>,
    pub initial_settings: Option<AltairSettingsState>,
    pub preserve_state: Option<bool>,
    pub initial_windows: Vec<AltairWindowOptions>,
    pub persisted_settings: Option<AltairSettingsState>,
    pub disable_account: Option<bool>,
}

Altair config options

Fields

window_options: Option<AltairWindowOptions>

Options to be applied on every new window (including the initial)

initial_environments: Option<AltairInitialEnvironments>

Initial Environments to be added

 {
   base: {
    title: 'Environment',
    variables: {}
  },
  subEnvironments: [
    {
      title: 'sub-1',
      variables: {}
    }
  ]
}

instance_storage_namespace: Option<String>

Namespace for storing the data for the altair instance.

Use this when you have multiple altair instances running on the same domain.

e.g. altair_dev_

initial_settings: Option<AltairSettingsState>

Initial app settings to use

preserve_state: Option<bool>

Indicates if the state should be preserved for subsequent app loads (default true)

initial_windows: Vec<AltairWindowOptions>

List of options for windows to be loaded

persisted_settings: Option<AltairSettingsState>

Persisted settings for the app. The settings will be merged with the app settings.

disable_account: Option<bool>

Disable the account and remote syncing functionality

Trait Implementations

impl Default for AltairConfigOptions

fn default() -> AltairConfigOptions

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for AltairConfigOptions

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl JsonSchema for AltairConfigOptions

fn schema_name() -> String

The name of the generated JSON Schema.

fn schema_id() -> Cow<'static, str>

Returns a string that uniquely identifies the schema produced by this type.

fn json_schema(gen: &mut SchemaGenerator) -> Schema

Generates a JSON Schema for this type.

fn is_referenceable() -> bool

Whether JSON Schemas generated for this type should be re-used where possible using the $ref keyword.

impl Serialize for AltairConfigOptions

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

where __S: Serializer,

Serialize this value into the given Serde serializer.