<!DOCTYPE html><html lang="en"><head><meta charset="utf-8"><meta name="viewport" content="width=device-width, initial-scale=1.0"><meta name="generator" content="rustdoc"><meta name="description" content="API documentation for the Rust `config` mod in crate `alacritty`."><meta name="keywords" content="rust, rustlang, rust-lang, config"><title>alacritty::config - Rust</title><link rel="stylesheet" type="text/css" href="../../normalize.css"><link rel="stylesheet" type="text/css" href="../../rustdoc.css" id="mainThemeStyle"><link rel="stylesheet" type="text/css" href="../../dark.css"><link rel="stylesheet" type="text/css" href="../../light.css" id="themeStyle"><script src="../../storage.js"></script><noscript><link rel="stylesheet" href="../../noscript.css"></noscript><link rel="shortcut icon" href="../../favicon.ico"><style type="text/css">#crate-search{background-image:url("../../down-arrow.svg");}</style></head><body class="rustdoc mod"><!--[if lte IE 8]><div class="warning">This old browser is unsupported and will most likely display funky things.</div><![endif]--><nav class="sidebar"><div class="sidebar-menu">☰</div><a href='../../alacritty/index.html'><img src='../../rust-logo.png' alt='logo' width='100'></a><p class='location'>Module config</p><div class="sidebar-elems"><div class="block items"><ul><li><a href="#structs">Structs</a></li><li><a href="#enums">Enums</a></li><li><a href="#constants">Constants</a></li><li><a href="#traits">Traits</a></li><li><a href="#types">Type Definitions</a></li></ul></div><p class='location'><a href='../index.html'>alacritty</a></p><script>window.sidebarCurrent = {name: 'config', ty: 'mod', relpath: '../'};</script><script defer src="../sidebar-items.js"></script></div></nav><div class="theme-picker"><button id="theme-picker" aria-label="Pick another theme!"><img src="../../brush.svg" width="18" alt="Pick another theme!"></button><div id="theme-choices"></div></div><script src="../../theme.js"></script><nav class="sub"><form class="search-form js-only"><div class="search-container"><div><select id="crate-search"><option value="All crates">All crates</option></select><input class="search-input" name="search" autocomplete="off" spellcheck="false" placeholder="Click or press ‘S’ to search, ‘?’ for more options…" type="search"></div><a id="settings-menu" href="../../settings.html"><img src="../../wheel.svg" width="18" alt="Change settings"></a></div></form></nav><section id="main" class="content"><h1 class='fqn'><span class='out-of-band'><span id='render-detail'><a id="toggle-all-docs" href="javascript:void(0)" title="collapse all docs">[<span class='inner'>−</span>]</a></span><a class='srclink' href='../../src/alacritty/config/mod.rs.html#1-2714' title='goto source code'>[src]</a></span><span class='in-band'>Module <a href='../index.html'>alacritty</a>::<wbr><a class="mod" href=''>config</a></span></h1><div class='docblock'><p>Configuration definitions and file loading</p>
<p>Alacritty reads from a config file at startup to determine various runtime
parameters including font family and style, font size, etc. In the future,
the config file will also hold user and platform specific keybindings.</p>
</div><h2 id='structs' class='section-header'><a href="#structs">Structs</a></h2>
<table><tr class='module-item'><td><a class="struct" href="struct.Alpha.html" title='alacritty::config::Alpha struct'>Alpha</a></td><td class='docblock-short'><p>Wrapper around f32 that represents an alpha value between 0.0 and 1.0</p>
</td></tr><tr class='module-item'><td><a class="struct" href="struct.AnsiColors.html" title='alacritty::config::AnsiColors struct'>AnsiColors</a></td><td class='docblock-short'><p>The 8-colors sections of config</p>
</td></tr><tr class='module-item'><td><a class="struct" href="struct.ClickHandler.html" title='alacritty::config::ClickHandler struct'>ClickHandler</a></td><td class='docblock-short'></td></tr><tr class='module-item'><td><a class="struct" href="struct.Colors.html" title='alacritty::config::Colors struct'>Colors</a></td><td class='docblock-short'></td></tr><tr class='module-item'><td><a class="struct" href="struct.Config.html" title='alacritty::config::Config struct'>Config</a></td><td class='docblock-short'><p>Top-level config type</p>
</td></tr><tr class='module-item'><td><a class="struct" href="struct.Cursor.html" title='alacritty::config::Cursor struct'>Cursor</a></td><td class='docblock-short'></td></tr><tr class='module-item'><td><a class="struct" href="struct.CursorColors.html" title='alacritty::config::CursorColors struct'>CursorColors</a></td><td class='docblock-short'></td></tr><tr class='module-item'><td><a class="struct" href="struct.Delta.html" title='alacritty::config::Delta struct'>Delta</a></td><td class='docblock-short'><p>A delta for a point in a 2 dimensional plane</p>
</td></tr><tr class='module-item'><td><a class="struct" href="struct.Dimensions.html" title='alacritty::config::Dimensions struct'>Dimensions</a></td><td class='docblock-short'><p>Window Dimensions</p>
</td></tr><tr class='module-item'><td><a class="struct" href="struct.Font.html" title='alacritty::config::Font struct'>Font</a></td><td class='docblock-short'><p>Font config</p>
</td></tr><tr class='module-item'><td><a class="struct" href="struct.FontDescription.html" title='alacritty::config::FontDescription struct'>FontDescription</a></td><td class='docblock-short'><p>Description of the normal font</p>
</td></tr><tr class='module-item'><td><a class="struct" href="struct.IndexedColor.html" title='alacritty::config::IndexedColor struct'>IndexedColor</a></td><td class='docblock-short'></td></tr><tr class='module-item'><td><a class="struct" href="struct.Monitor.html" title='alacritty::config::Monitor struct'>Monitor</a></td><td class='docblock-short'></td></tr><tr class='module-item'><td><a class="struct" href="struct.Mouse.html" title='alacritty::config::Mouse struct'>Mouse</a></td><td class='docblock-short'></td></tr><tr class='module-item'><td><a class="struct" href="struct.PrimaryColors.html" title='alacritty::config::PrimaryColors struct'>PrimaryColors</a></td><td class='docblock-short'></td></tr><tr class='module-item'><td><a class="struct" href="struct.Scrolling.html" title='alacritty::config::Scrolling struct'>Scrolling</a></td><td class='docblock-short'><p>Struct for scrolling related settings</p>
</td></tr><tr class='module-item'><td><a class="struct" href="struct.SecondaryFontDescription.html" title='alacritty::config::SecondaryFontDescription struct'>SecondaryFontDescription</a></td><td class='docblock-short'><p>Description of the italic and bold font</p>
</td></tr><tr class='module-item'><td><a class="struct" href="struct.Selection.html" title='alacritty::config::Selection struct'>Selection</a></td><td class='docblock-short'></td></tr><tr class='module-item'><td><a class="struct" href="struct.SelectionColors.html" title='alacritty::config::SelectionColors struct'>SelectionColors</a></td><td class='docblock-short'></td></tr><tr class='module-item'><td><a class="struct" href="struct.Shell.html" title='alacritty::config::Shell struct'>Shell</a></td><td class='docblock-short'></td></tr><tr class='module-item'><td><a class="struct" href="struct.Url.html" title='alacritty::config::Url struct'>Url</a></td><td class='docblock-short'></td></tr><tr class='module-item'><td><a class="struct" href="struct.VisualBellConfig.html" title='alacritty::config::VisualBellConfig struct'>VisualBellConfig</a></td><td class='docblock-short'></td></tr><tr class='module-item'><td><a class="struct" href="struct.WindowConfig.html" title='alacritty::config::WindowConfig struct'>WindowConfig</a></td><td class='docblock-short'></td></tr></table><h2 id='enums' class='section-header'><a href="#enums">Enums</a></h2>
<table><tr class='module-item'><td><a class="enum" href="enum.CommandWrapper.html" title='alacritty::config::CommandWrapper enum'>CommandWrapper</a></td><td class='docblock-short'></td></tr><tr class='module-item'><td><a class="enum" href="enum.Decorations.html" title='alacritty::config::Decorations enum'>Decorations</a></td><td class='docblock-short'></td></tr><tr class='module-item'><td><a class="enum" href="enum.Error.html" title='alacritty::config::Error enum'>Error</a></td><td class='docblock-short'><p>Errors occurring during config loading</p>
</td></tr><tr class='module-item'><td><a class="enum" href="enum.Key.html" title='alacritty::config::Key enum'>Key</a></td><td class='docblock-short'></td></tr><tr class='module-item'><td><a class="enum" href="enum.VisualBellAnimation.html" title='alacritty::config::VisualBellAnimation enum'>VisualBellAnimation</a></td><td class='docblock-short'><p><code>VisualBellAnimations</code> are modeled after a subset of CSS transitions and Robert
Penner's Easing Functions.</p>
</td></tr></table><h2 id='constants' class='section-header'><a href="#constants">Constants</a></h2>
<table><tr class='module-item'><td><a class="constant" href="constant.SOURCE_FILE_PATH.html" title='alacritty::config::SOURCE_FILE_PATH constant'>SOURCE_FILE_PATH</a></td><td class='docblock-short'></td></tr></table><h2 id='traits' class='section-header'><a href="#traits">Traits</a></h2>
<table><tr class='module-item'><td><a class="trait" href="trait.OnConfigReload.html" title='alacritty::config::OnConfigReload trait'>OnConfigReload</a></td><td class='docblock-short'></td></tr></table><h2 id='types' class='section-header'><a href="#types">Type Definitions</a></h2>
<table><tr class='module-item'><td><a class="type" href="type.Result.html" title='alacritty::config::Result type'>Result</a></td><td class='docblock-short'><p>Result from config loading</p>
</td></tr></table></section><section id="search" class="content hidden"></section><section class="footer"></section><aside id="help" class="hidden"><div><h1 class="hidden">Help</h1><div class="shortcuts"><h2>Keyboard Shortcuts</h2><dl><dt><kbd>?</kbd></dt><dd>Show this help dialog</dd><dt><kbd>S</kbd></dt><dd>Focus the search field</dd><dt><kbd>↑</kbd></dt><dd>Move up in search results</dd><dt><kbd>↓</kbd></dt><dd>Move down in search results</dd><dt><kbd>↹</kbd></dt><dd>Switch tab</dd><dt><kbd>⏎</kbd></dt><dd>Go to active search result</dd><dt><kbd>+</kbd></dt><dd>Expand all sections</dd><dt><kbd>-</kbd></dt><dd>Collapse all sections</dd></dl></div><div class="infos"><h2>Search Tricks</h2><p>Prefix searches with a type followed by a colon (e.g., <code>fn:</code>) to restrict the search to a given type.</p><p>Accepted types are: <code>fn</code>, <code>mod</code>, <code>struct</code>, <code>enum</code>, <code>trait</code>, <code>type</code>, <code>macro</code>, and <code>const</code>.</p><p>Search functions by type signature (e.g., <code>vec -> usize</code> or <code>* -> vec</code>)</p><p>Search multiple things at once by splitting your query with comma (e.g., <code>str,u8</code> or <code>String,struct:Vec,test</code>)</p></div></div></aside><script>window.rootPath = "../../";window.currentCrate = "alacritty";</script><script src="../../aliases.js"></script><script src="../../main.js"></script><script defer src="../../search-index.js"></script></body></html>
