Struct Cursor 

pub struct Cursor {
    pub blink_speed: Duration,
    pub style: Style,
    pub text_style: Style,
    /* private fields */
}

A cursor component for text input.

Fields

blink_speed: Duration

The blink speed.

style: Style

Style for the cursor block.

text_style: Style

Style for text when cursor is hidden (blinking off).

Implementations

impl Cursor

pub fn new() -> Self

Creates a new cursor with default settings.

pub fn id(&self) -> u64

Returns the cursor’s unique ID.

pub fn mode(&self) -> Mode

Returns the current cursor mode.

pub fn set_mode(&mut self, mode: Mode) -> Option<Cmd>

Sets the cursor mode.

Returns a command to start blinking if the mode is Blink.

pub fn set_char(&mut self, c: &str)

Sets the character displayed under the cursor.

pub fn char(&self) -> &str

Returns the character under the cursor.

pub fn focused(&self) -> bool

Returns whether the cursor is currently focused.

pub fn is_blinking_off(&self) -> bool

Returns whether the cursor is currently in its “off” blink state.

pub fn focus(&mut self) -> Option<Cmd>

Focuses the cursor, allowing it to blink if in blink mode.

Returns a command to start blinking.

pub fn blur(&mut self)

Blurs (unfocuses) the cursor.

pub fn update(&mut self, msg: Message) -> Option<Cmd>

Updates the cursor state based on incoming messages.

pub fn view(&self) -> String

Renders the cursor.

Trait Implementations

impl Clone for Cursor

fn clone(&self) -> Cursor

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Cursor

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

Formats the value using the given formatter.

impl Default for Cursor

fn default() -> Self

Returns the “default value” for a type.

impl Model for Cursor

fn init(&self) -> Option<Cmd>

Initialize the cursor and return a blink command if in blink mode and focused.

fn update(&mut self, msg: Message) -> Option<Cmd>

Update the cursor state based on incoming messages.

Handles:

• InitialBlinkMsg - Start blinking if focused and in blink mode
• FocusMsg - Focus the cursor and start blinking
• BlurMsg - Blur the cursor and stop blinking
• BlinkMsg - Toggle blink state and schedule next blink

fn view(&self) -> String

Render the cursor.

Returns the cursor character styled appropriately based on blink state.