Enum CursorIcon 

#[non_exhaustive]
pub enum CursorIcon {
    Default,
    Pointer,
    Text,
    Grab,
    Grabbing,
    ColResize,
    RowResize,
    NotAllowed,
}

The pointer-cursor vocabulary, flat-re-exported from frust-core::event (and also available through authoring::CursorIcon).

A widget asks for a shape from its own pointer handling — ctx.set_cursor(CursorIcon::Pointer) — and the desktop shell applies whatever the pass resolved; the request is per-pass and stateless, so a widget that stops asking falls back to CursorIcon::Default with nothing to clear. Lifted flat rather than left inside authoring because a design-system plugin’s public builder API can name a cursor (a Button::cursor(..) override, a disabled control asking for CursorIcon::NotAllowed) without being a widget author itself. #[non_exhaustive]: match with a wildcard arm.

Honoured on desktop only — the mobile shells never read the resolved value, so setting a cursor unconditionally is safe on every platform. The pointer cursor a widget asks the host to display.

A request vocabulary, not a rendering one: platform-neutral names a widget states its intent in (EventCtx::set_cursor), which a desktop shell maps onto its own host API — frust-shell-desktop onto winit’s own cursor icons, the one place any of these names touches a platform. Deliberately tiny: the shapes a desktop-class design system actually needs, not a full CSS cursor set.

#[non_exhaustive] from birth, so widening it later cannot break an out-of-tree match (a shell or design system must carry a wildcard arm and degrade an unknown request to CursorIcon::Default rather than fail to compile).

Nothing below a desktop shell honours a request. The mobile shells never read the resolved value — a touch host has no pointer to shape — so a widget may set a cursor unconditionally and get the desktop behaviour where it exists and no behaviour at all where it does not.

Variants (Non-exhaustive)

Non-exhaustive enums could have additional variants added in future. Therefore, when matching against variants of non-exhaustive enums, an extra wildcard arm must be added to account for any future variants.

Default

The host’s ordinary arrow. The resolved value of any pass in which no widget asked for anything else, so a widget never has to ask for it to “give the cursor back” (see EventCtx::set_cursor).

Pointer

The clickable hand: buttons, links, and anything else a press activates.

Text

The text I-beam: editable or selectable text.

Grab

An open hand: this is draggable, and no drag has started yet.

Grabbing

A closed hand: a drag is in progress.

ColResize

A column-resize handle — a divider the pointer moves horizontally.

RowResize

A row-resize handle — a divider the pointer moves vertically.

NotAllowed

The action under the pointer is refused: a disabled control, or a drop target rejecting what is being dragged.

Trait Implementations

impl Clone for CursorIcon

fn clone(&self) -> CursorIcon

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for CursorIcon

impl Debug for CursorIcon

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

Formats the value using the given formatter.

impl Default for CursorIcon

fn default() -> CursorIcon

Returns the “default value” for a type.

impl Eq for CursorIcon

impl Hash for CursorIcon

fn hash<__H>(&self, state: &mut __H)

where __H: Hasher,

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl PartialEq for CursorIcon

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for CursorIcon