Skip to main content

PromptRegistry

Struct PromptRegistry 

Source
pub struct PromptRegistry { /* private fields */ }
Expand description

Persistent dismissed-prompt registry.

load populates from disk (returns an empty registry if the file does not exist); mutations are in-memory until save is called.

Implementations§

Source§

impl PromptRegistry

Source

pub fn load(fs: &dyn Fs, path: PathBuf) -> Result<Self>

Load the registry from path. A missing file is treated as an empty registry — first-run users have nothing to read.

Source

pub fn save(&self, fs: &dyn Fs) -> Result<()>

Persist the registry to its backing path. Creates parent dirs as needed.

Source

pub fn path(&self) -> &Path

Backing file path (for diagnostic messages and dodot prompts list).

Source

pub fn is_dismissed(&self, key: &str) -> bool

True if the prompt with this key has been dismissed.

Source

pub fn dismiss(&mut self, key: &str)

Record that the user dismissed this prompt. Idempotent — calling twice updates dismissed_at to the latest call.

Source

pub fn dismiss_at(&mut self, key: &str, dismissed_at: u64)

Test-friendly sibling of [dismiss] that takes an explicit timestamp instead of reading the wall clock.

Source

pub fn reset(&mut self, key: &str) -> bool

Clear a single dismissal so the prompt fires again next time. Returns true if the key was present.

Source

pub fn reset_all(&mut self) -> usize

Clear every dismissal. Returns the count cleared.

Source

pub fn dismissed(&self) -> Vec<(&str, &PromptRecord)>

Snapshot of dismissed prompts, sorted by key. Suitable for rendering by dodot prompts list. Allocates; if you only need per-key lookups, prefer dismissed_at.

Source

pub fn dismissed_at(&self, key: &str) -> Option<u64>

O(log n) lookup of a single prompt’s dismissal timestamp. Returns None if the prompt is currently active. Pair with is_dismissed when you only need the boolean — this returns the timestamp too for UIs that show “dismissed at …”.

Trait Implementations§

Source§

impl Clone for PromptRegistry

Source§

fn clone(&self) -> PromptRegistry

Returns a duplicate of the value. Read more
1.0.0 · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for PromptRegistry

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> 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> 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