Struct PromptSpec 

pub struct PromptSpec {
    pub id: &'static str,
    pub prefix: String,
    pub placeholder: String,
    pub placement: PromptPlacement,
    pub live_update: bool,
}

How a prompt was opened. Semantics belong to hooks; this is only the view-model a frontend renders.

Fields

id: &'static str

Stable id so hooks recognize their own prompt ("search", "vim-ex").

prefix: String

Leading adornment ("/", ":", "").

placeholder: String

Ghost text shown while the input is empty.

placement: PromptPlacement

Where the frontend should anchor the box.

live_update: bool

Hint that the hook refreshes live on every keystroke (search) rather than only on submit (ex-commands).

Implementations

impl PromptSpec

pub fn new( id: &'static str, prefix: &str, placeholder: &str, placement: PromptPlacement, live_update: bool, ) -> Self

Creates a prompt spec.

Trait Implementations

impl Clone for PromptSpec

fn clone(&self) -> PromptSpec

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for PromptSpec

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

Formats the value using the given formatter.

impl Eq for PromptSpec

impl PartialEq for PromptSpec

fn eq(&self, other: &PromptSpec) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for PromptSpec