Struct CaretConfig 

pub struct CaretConfig {
    pub shape: CaretShape,
    pub color: Option<String>,
    pub blink: f32,
    pub hide_when_done: bool,
}

A caret pinned to a text’s reveal head.

Only meaningful alongside a typewriter animation: the caret follows the last revealed character and stops at the end of the line once the reveal finishes. Composing a standalone cursor component next to the text gets you a caret that stays where you put it while the text grows out from under it, which is the thing this exists to avoid.

Fields

shape: CaretShape

Caret shape.

color: Option<String>

Caret colour (hex). Defaults to the text’s own colour, so a caret inherits a theme change without being restated.

blink: f32

Blink period in seconds — one full off/on cycle. 0 disables the blink and leaves the caret solid.

hide_when_done: bool

Hide the caret once the reveal has finished, instead of leaving it parked at the end of the text.

Trait Implementations

impl Clone for CaretConfig

fn clone(&self) -> CaretConfig

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for CaretConfig

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

Formats the value using the given formatter.

impl Default for CaretConfig

fn default() -> Self

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for CaretConfig

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl JsonSchema for CaretConfig

fn schema_name() -> String

The name of the generated JSON Schema.

fn schema_id() -> Cow<'static, str>

Returns a string that uniquely identifies the schema produced by this type.

fn json_schema(generator: &mut SchemaGenerator) -> Schema

Generates a JSON Schema for this type.

fn is_referenceable() -> bool

Whether JSON Schemas generated for this type should be re-used where possible using the $ref keyword.

impl PartialEq for CaretConfig

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

Equality operator ==.

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

Inequality operator !=.

impl Serialize for CaretConfig

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for CaretConfig