Skip to main content

AppEvent

Enum AppEvent 

Source
pub enum AppEvent {
Show 49 variants Input(InputEvent), OpenScreen(ScreenEvent), Quit, Redraw, Autosave, AutosaveCompleted { path: VaultPath, saved_revision: Option<NonZeroU64>, title: Option<String>, }, OpenPath { path: VaultPath, emphasis: Option<Vec<String>>, }, FocusSidebar, OpenDrawerView(DrawerView), RunTagQuery(String), JumpToHeading(String), ExecuteLeaderAction(LeaderAction), FlashMessage(String), ApplyTheme { theme: Box<Theme>, persist: bool, }, LinkTargetMeta { target: String, count: usize, }, BacklinkCountLoaded { path: VaultPath, count: usize, }, GitStatusLoaded(Option<String>), PreferencesSaved, ClosePreferences, OpenFileBrowser, TriggerFastReindex, TriggerFullReindex, IndexingDone(Result<Duration, String>), OpenJournal, CloseOverlay, FollowLink(String), FollowLabel(String), InsertAtCursor(String), ShowFileOpsMenu(VaultPath), ShowDeleteDialog(VaultPath), ShowRenameDialog(VaultPath), ShowMoveDialog(VaultPath), EntryDeleted(VaultPath), EntryRenamed { from: VaultPath, to: VaultPath, }, EntryMoved { from: VaultPath, to: VaultPath, }, EntryCreated(VaultPath), DialogError(String), VaultConflict(String), RenameValidation { available: bool, }, MoveDirectoriesLoaded(Vec<VaultPath>), MoveFilterResults(Vec<VaultPath>), MoveDestValidation { available: bool, }, SavedSearchNamesLoaded(Vec<String>), WorkspaceSwitched(String), SaveSearchConfirmed { name: String, query: String, source: SaveSource, }, SavedSearchPersisted { name: String, query: String, source: SaveSource, }, SavedSearchSaveFailed { name: String, }, SavedSearchSelected { query: String, name: String, }, SortChanged { target: SortTarget, field: SortField, order: SortOrder, group_directories: bool, persist: bool, },
}
Expand description

All events that flow through the system — both input events (from crossterm) and app-level messages sent by components / screens to the main loop.

Variants§

§

Input(InputEvent)

§

OpenScreen(ScreenEvent)

§

Quit

§

Redraw

§

Autosave

§

AutosaveCompleted

Background autosave task finished. saved_revision carries the editor’s content_revision at the moment the save was issued on success, None if the write failed. The editor screen uses path to ignore stale completions for notes the user has already navigated away from, and saved_revision to clear the dirty flag iff the buffer is still at that revision (i.e. no edits during the save). NonZeroU64 because the editor’s content_revision is never zero.

Fields

§saved_revision: Option<NonZeroU64>
§title: Option<String>

The note’s recomputed title (first body line) from the save, so the sidebar row can be retitled. None when the save failed.

§

OpenPath

Open a note (or directory) — emphasis carries the originating query’s needles when the open comes from a query result, so the editor lights up the matched spans (spec §5.1). Use AppEvent::open for the plain case.

Fields

§emphasis: Option<Vec<String>>
§

FocusSidebar

§

OpenDrawerView(DrawerView)

Switch the drawer to the given view and reveal it (sent by the activity rail and, later, by leader paths / mouse clicks).

§

RunTagQuery(String)

Run the query #<label> in the FIND drawer (sent by the TAGS drawer).

§

JumpToHeading(String)

Jump the editor cursor to the first heading with this text (sent by the OUTLINE drawer).

§

ExecuteLeaderAction(LeaderAction)

Run a leader-tree action (sent by the command palette after it has closed itself, so the action sees no open overlay).

§

FlashMessage(String)

Show a transient footer flash — async tasks report results with it.

§

ApplyTheme

Apply (and optionally persist) a resolved theme — sent by the theme picker: previews on selection move, persists on Enter. Carries the full Theme so applying never re-reads the themes directory.

Fields

§theme: Box<Theme>
§persist: bool
§

LinkTargetMeta

Async-loaded backlink count for the link target under the editor cursor (status line 2’s → target · N backlinks affordance).

Fields

§target: String
§count: usize
§

BacklinkCountLoaded

Async-loaded backlink count for the note at path (status line 2).

Fields

§count: usize
§

GitStatusLoaded(Option<String>)

Async-loaded workspace git summary for the status bar, None when the workspace is not a git repository.

§

PreferencesSaved

Sent by PreferencesScreen when user confirms Save. The shared settings reference already contains the updated values.

§

ClosePreferences

Sent by PreferencesScreen when user discards or closes unchanged.

§

OpenFileBrowser

Sent by VaultSection; PreferencesScreen::handle_app_message intercepts.

§

TriggerFastReindex

Sent by IndexingSection; PreferencesScreen intercepts.

§

TriggerFullReindex

§

IndexingDone(Result<Duration, String>)

Sent by indexing tokio task on completion.

§

OpenJournal

Open (or create) today’s journal entry and switch to it in the editor.

§

CloseOverlay

Dismiss the active editor overlay (note browser, Saved Searches modal, or dialog). The single close path for everything owned by OverlayHost.

Follow the link under the editor cursor: note name/path or external URL.

§

FollowLabel(String)

Open the search modal pre-filled with #<name> to browse notes by label.

§

InsertAtCursor(String)

Insert raw text at the editor’s cursor (replacing any active selection). Used by the screen layer to deliver async results back to the editor — e.g. the markdown link generated after a clipboard image is saved as an attachment.

§

ShowFileOpsMenu(VaultPath)

Request to show the file-operations menu (delete / rename / move).

§

ShowDeleteDialog(VaultPath)

Request to show the delete confirmation dialog for the given entry.

§

ShowRenameDialog(VaultPath)

Request to show the rename dialog for the given entry.

§

ShowMoveDialog(VaultPath)

Request to show the move dialog for the given entry.

§

EntryDeleted(VaultPath)

Confirmation that the given entry was successfully deleted.

§

EntryRenamed

Confirmation that an entry was successfully renamed.

Fields

§

EntryMoved

Confirmation that an entry was successfully moved.

Fields

§

EntryCreated(VaultPath)

Notification that a note was just created at this path. The current screen refreshes its sidebar if it is browsing the note’s directory. Opening the note is a separate concern (the creator emits OpenPath).

§

DialogError(String)

A dialog operation failed; carries a human-readable error message.

§

VaultConflict(String)

A vault was found to be structurally unusable (conflicts, invalid layout, etc.). Carries a formatted, human-readable error message.

Handled by handle_app_message in main.rs, which clears the workspace, saves settings, and opens the settings screen with an error overlay. To add a new conflict source: emit this event from the detection site; no other files need to change.

§

RenameValidation

Rename dialog: name availability check result.

Fields

§available: bool
§

MoveDirectoriesLoaded(Vec<VaultPath>)

Move dialog: directory list has loaded.

§

MoveFilterResults(Vec<VaultPath>)

Move dialog: fuzzy filter results are ready.

§

MoveDestValidation

Move dialog: destination existence check result.

Fields

§available: bool
§

SavedSearchNamesLoaded(Vec<String>)

Save-search dialog: existing saved-search names have loaded (drives the update/overwrite/save-new hint).

§

WorkspaceSwitched(String)

User switched to a different workspace. Carries the workspace name. Handled by main.rs to rebuild the vault and navigate to StartScreen.

§

SaveSearchConfirmed

Persist a saved search (emitted by the save-search dialog on submit). source is the surface the query was sourced from, decided when the dialog opened — it drives whether the panel breadcrumb re-pins.

Fields

§name: String
§query: String
§source: SaveSource
§

SavedSearchPersisted

A saved search was written to disk (success path of SaveSearchConfirmed). The editor re-pins the panel breadcrumb here — only once the write actually succeeded.

Fields

§name: String
§query: String
§source: SaveSource
§

SavedSearchSaveFailed

The background saved-search write failed; surface it to the user.

Fields

§name: String
§

SavedSearchSelected

A saved search was chosen in the Saved Searches modal.

Fields

§query: String
§name: String
§

SortChanged

Sort selection changed in the sort dialog — apply live to target. When persist is set (sidebar’s “save as default”), also write the choice to settings. group_directories is sidebar-only (the query panel ignores it).

Fields

§target: SortTarget
§group_directories: bool
§persist: bool

Implementations§

Source§

impl AppEvent

Source

pub fn send_input(event: InputEvent) -> Self

Source

pub fn open(path: VaultPath) -> Self

OpenPath without query emphasis — the common case.

Trait Implementations§

Source§

impl Clone for AppEvent

Source§

fn clone(&self) -> AppEvent

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for AppEvent

Source§

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

Formats the value using the given formatter. Read more

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> DynClone for T
where T: Clone,

Source§

fn __clone_box(&self, _: Private) -> *mut ()

Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

impl<D> OwoColorize for D

Source§

fn fg<C>(&self) -> FgColorDisplay<'_, C, Self>
where C: Color,

Set the foreground color generically Read more
Source§

fn bg<C>(&self) -> BgColorDisplay<'_, C, Self>
where C: Color,

Set the background color generically. Read more
Source§

fn black(&self) -> FgColorDisplay<'_, Black, Self>

Change the foreground color to black
Source§

fn on_black(&self) -> BgColorDisplay<'_, Black, Self>

Change the background color to black
Source§

fn red(&self) -> FgColorDisplay<'_, Red, Self>

Change the foreground color to red
Source§

fn on_red(&self) -> BgColorDisplay<'_, Red, Self>

Change the background color to red
Source§

fn green(&self) -> FgColorDisplay<'_, Green, Self>

Change the foreground color to green
Source§

fn on_green(&self) -> BgColorDisplay<'_, Green, Self>

Change the background color to green
Source§

fn yellow(&self) -> FgColorDisplay<'_, Yellow, Self>

Change the foreground color to yellow
Source§

fn on_yellow(&self) -> BgColorDisplay<'_, Yellow, Self>

Change the background color to yellow
Source§

fn blue(&self) -> FgColorDisplay<'_, Blue, Self>

Change the foreground color to blue
Source§

fn on_blue(&self) -> BgColorDisplay<'_, Blue, Self>

Change the background color to blue
Source§

fn magenta(&self) -> FgColorDisplay<'_, Magenta, Self>

Change the foreground color to magenta
Source§

fn on_magenta(&self) -> BgColorDisplay<'_, Magenta, Self>

Change the background color to magenta
Source§

fn purple(&self) -> FgColorDisplay<'_, Magenta, Self>

Change the foreground color to purple
Source§

fn on_purple(&self) -> BgColorDisplay<'_, Magenta, Self>

Change the background color to purple
Source§

fn cyan(&self) -> FgColorDisplay<'_, Cyan, Self>

Change the foreground color to cyan
Source§

fn on_cyan(&self) -> BgColorDisplay<'_, Cyan, Self>

Change the background color to cyan
Source§

fn white(&self) -> FgColorDisplay<'_, White, Self>

Change the foreground color to white
Source§

fn on_white(&self) -> BgColorDisplay<'_, White, Self>

Change the background color to white
Source§

fn default_color(&self) -> FgColorDisplay<'_, Default, Self>

Change the foreground color to the terminal default
Source§

fn on_default_color(&self) -> BgColorDisplay<'_, Default, Self>

Change the background color to the terminal default
Source§

fn bright_black(&self) -> FgColorDisplay<'_, BrightBlack, Self>

Change the foreground color to bright black
Source§

fn on_bright_black(&self) -> BgColorDisplay<'_, BrightBlack, Self>

Change the background color to bright black
Source§

fn bright_red(&self) -> FgColorDisplay<'_, BrightRed, Self>

Change the foreground color to bright red
Source§

fn on_bright_red(&self) -> BgColorDisplay<'_, BrightRed, Self>

Change the background color to bright red
Source§

fn bright_green(&self) -> FgColorDisplay<'_, BrightGreen, Self>

Change the foreground color to bright green
Source§

fn on_bright_green(&self) -> BgColorDisplay<'_, BrightGreen, Self>

Change the background color to bright green
Source§

fn bright_yellow(&self) -> FgColorDisplay<'_, BrightYellow, Self>

Change the foreground color to bright yellow
Source§

fn on_bright_yellow(&self) -> BgColorDisplay<'_, BrightYellow, Self>

Change the background color to bright yellow
Source§

fn bright_blue(&self) -> FgColorDisplay<'_, BrightBlue, Self>

Change the foreground color to bright blue
Source§

fn on_bright_blue(&self) -> BgColorDisplay<'_, BrightBlue, Self>

Change the background color to bright blue
Source§

fn bright_magenta(&self) -> FgColorDisplay<'_, BrightMagenta, Self>

Change the foreground color to bright magenta
Source§

fn on_bright_magenta(&self) -> BgColorDisplay<'_, BrightMagenta, Self>

Change the background color to bright magenta
Source§

fn bright_purple(&self) -> FgColorDisplay<'_, BrightMagenta, Self>

Change the foreground color to bright purple
Source§

fn on_bright_purple(&self) -> BgColorDisplay<'_, BrightMagenta, Self>

Change the background color to bright purple
Source§

fn bright_cyan(&self) -> FgColorDisplay<'_, BrightCyan, Self>

Change the foreground color to bright cyan
Source§

fn on_bright_cyan(&self) -> BgColorDisplay<'_, BrightCyan, Self>

Change the background color to bright cyan
Source§

fn bright_white(&self) -> FgColorDisplay<'_, BrightWhite, Self>

Change the foreground color to bright white
Source§

fn on_bright_white(&self) -> BgColorDisplay<'_, BrightWhite, Self>

Change the background color to bright white
Source§

fn bold(&self) -> BoldDisplay<'_, Self>

Make the text bold
Source§

fn dimmed(&self) -> DimDisplay<'_, Self>

Make the text dim
Source§

fn italic(&self) -> ItalicDisplay<'_, Self>

Make the text italicized
Source§

fn underline(&self) -> UnderlineDisplay<'_, Self>

Make the text underlined
Make the text blink
Make the text blink (but fast!)
Source§

fn reversed(&self) -> ReversedDisplay<'_, Self>

Swap the foreground and background colors
Source§

fn hidden(&self) -> HiddenDisplay<'_, Self>

Hide the text
Source§

fn strikethrough(&self) -> StrikeThroughDisplay<'_, Self>

Cross out the text
Source§

fn color<Color>(&self, color: Color) -> FgDynColorDisplay<'_, Color, Self>
where Color: DynColor,

Set the foreground color at runtime. Only use if you do not know which color will be used at compile-time. If the color is constant, use either OwoColorize::fg or a color-specific method, such as OwoColorize::green, Read more
Source§

fn on_color<Color>(&self, color: Color) -> BgDynColorDisplay<'_, Color, Self>
where Color: DynColor,

Set the background color at runtime. Only use if you do not know what color to use at compile-time. If the color is constant, use either OwoColorize::bg or a color-specific method, such as OwoColorize::on_yellow, Read more
Source§

fn fg_rgb<const R: u8, const G: u8, const B: u8>( &self, ) -> FgColorDisplay<'_, CustomColor<R, G, B>, Self>

Set the foreground color to a specific RGB value.
Source§

fn bg_rgb<const R: u8, const G: u8, const B: u8>( &self, ) -> BgColorDisplay<'_, CustomColor<R, G, B>, Self>

Set the background color to a specific RGB value.
Source§

fn truecolor(&self, r: u8, g: u8, b: u8) -> FgDynColorDisplay<'_, Rgb, Self>

Sets the foreground color to an RGB value.
Source§

fn on_truecolor(&self, r: u8, g: u8, b: u8) -> BgDynColorDisplay<'_, Rgb, Self>

Sets the background color to an RGB value.
Source§

fn style(&self, style: Style) -> Styled<&Self>

Apply a runtime-determined style
Source§

impl<T> Pointable for T

Source§

const ALIGN: usize

The alignment of pointer.
Source§

type Init = T

The type for initializers.
Source§

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more
Source§

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more
Source§

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more
Source§

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more
Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

Source§

fn vzip(self) -> V

Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more