pub struct DashboardSource;Expand description
Path to a file whose contents fully replace the composed sections — the “author the entire dashboard” escape hatch. Empty (the default) uses section composition. A missing or unreadable path falls back to the sections with a logged warning.
Implementations§
Source§impl DashboardSource
impl DashboardSource
Sourcepub fn build_spec() -> Option<String>
pub fn build_spec() -> Option<String>
Build the runtime spec for this declaration.
Used by the registry’s self-registration boot
path; not generally called by hand. Direct
construction of Option<T> is the macro’s
internal-only path – consumer code uses
config.get_typed::<#name_ident>() to read
and config.set_typed::<#name_ident>(...) to
write.
Trait Implementations§
Source§impl HasGroup for DashboardSource
impl HasGroup for DashboardSource
Source§const GROUP_NAME: &'static str = <Dashboard as ::lattice_config::OptionGroup>::NAME
const GROUP_NAME: &'static str = <Dashboard as ::lattice_config::OptionGroup>::NAME
Group display name (
"editor", "lsp", …). The macro
pulls this from the group = SomeGroup; directive at the
declaration block’s head.Source§impl OptionDecl for DashboardSource
impl OptionDecl for DashboardSource
Source§const NAME: &'static str = DashboardSource
const NAME: &'static str = DashboardSource
Public display name. Boundary-facing only –
:set <NAME>=…,
TOML keys, completion candidates, :describe-option.
Internal access is type-driven. The macro derives this
from the option’s identifier (with namespace prefix when
declared via mode_options!); manually-typed NAMEs are
not supported for built-in options.Source§const DOC: &'static str = DashboardSource
const DOC: &'static str = DashboardSource
Doc string. Shown in
:describe-option, the :customize
form’s per-row help, and :apropos results.Source§const CUSTOMIZABLE: bool = true
const CUSTOMIZABLE: bool = true
Customize-visibility flag.
true (the default) ⇒ option
appears in :set autocomplete + the :customize group
view. false ⇒ plugin / engine-internal state, hidden
from user surfaces. Equivalent of emacs’s defvar vs
defcustom. (See mode-architecture.md §6.5.3.)Source§type Value = String
type Value = String
The runtime value type.
bool, i64, String, plus any
domain enum that impls [OptionType].Source§fn default_value() -> Self::Value
fn default_value() -> Self::Value
Default value. Returned by a function (rather than a
const) so non-const-constructible types like String
can be defaults.Auto Trait Implementations§
impl Freeze for DashboardSource
impl RefUnwindSafe for DashboardSource
impl Send for DashboardSource
impl Sync for DashboardSource
impl Unpin for DashboardSource
impl UnsafeUnpin for DashboardSource
impl UnwindSafe for DashboardSource
Blanket Implementations§
Source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
Source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more