Raxol.Terminal.Config.Manager (Raxol v2.0.1)
View SourceManages terminal configuration including settings, preferences, and environment variables. This module is responsible for handling configuration operations and state.
Summary
Functions
Returns a specification to start this module under a supervisor.
Clears all environment variables. Returns the updated emulator.
Gets all environment variables. Returns the map of environment variables.
Gets an environment variable. Returns the environment variable value or nil.
Gets a preference value. Returns the preference value or nil.
Gets a configuration setting. Returns the setting value or nil.
Callback implementation for Raxol.Core.Behaviours.BaseManager.handle_manager_cast/2.
Callback implementation for Raxol.Core.Behaviours.BaseManager.handle_manager_info/2.
Creates a new config manager.
Resets the config manager to its initial state. Returns the updated emulator.
Sets an environment variable. Returns the updated emulator.
Sets multiple environment variables. Returns the updated emulator.
Sets a preference value. Returns the updated emulator.
Sets a configuration setting. Returns the updated emulator.
Functions
Returns a specification to start this module under a supervisor.
See Supervisor.
@spec clear_environment(Raxol.Terminal.Emulator.t()) :: Raxol.Terminal.Emulator.t()
Clears all environment variables. Returns the updated emulator.
@spec get_all_environment(Raxol.Terminal.Emulator.t()) :: %{ required(String.t()) => String.t() }
Gets all environment variables. Returns the map of environment variables.
@spec get_environment(Raxol.Terminal.Emulator.t(), String.t()) :: String.t() | nil
Gets an environment variable. Returns the environment variable value or nil.
@spec get_preference(Raxol.Terminal.Emulator.t(), atom()) :: any()
Gets a preference value. Returns the preference value or nil.
@spec get_setting(Raxol.Terminal.Emulator.t(), atom()) :: any()
Gets a configuration setting. Returns the setting value or nil.
Callback implementation for Raxol.Core.Behaviours.BaseManager.handle_manager_cast/2.
Callback implementation for Raxol.Core.Behaviours.BaseManager.handle_manager_info/2.
@spec new() :: Raxol.Terminal.Config.t()
Creates a new config manager.
@spec reset_config_manager(Raxol.Terminal.Emulator.t()) :: Raxol.Terminal.Emulator.t()
Resets the config manager to its initial state. Returns the updated emulator.
@spec set_environment(Raxol.Terminal.Emulator.t(), String.t(), String.t()) :: Raxol.Terminal.Emulator.t()
Sets an environment variable. Returns the updated emulator.
@spec set_environment_variables(Raxol.Terminal.Emulator.t(), %{ required(String.t()) => String.t() }) :: Raxol.Terminal.Emulator.t()
Sets multiple environment variables. Returns the updated emulator.
@spec set_preference(Raxol.Terminal.Emulator.t(), atom(), any()) :: Raxol.Terminal.Emulator.t()
Sets a preference value. Returns the updated emulator.
@spec set_setting(Raxol.Terminal.Emulator.t(), atom(), any()) :: Raxol.Terminal.Emulator.t()
Sets a configuration setting. Returns the updated emulator.