Skip to main content

IconRole

native_theme_gpui

Enum IconRole

#[non_exhaustive]pub enum IconRole {
Show 42 variants    DialogWarning,
    DialogError,
    DialogInfo,
    DialogQuestion,
    DialogSuccess,
    Shield,
    WindowClose,
    WindowMinimize,
    WindowMaximize,
    WindowRestore,
    ActionSave,
    ActionDelete,
    ActionCopy,
    ActionPaste,
    ActionCut,
    ActionUndo,
    ActionRedo,
    ActionSearch,
    ActionSettings,
    ActionEdit,
    ActionAdd,
    ActionRemove,
    ActionRefresh,
    ActionPrint,
    NavBack,
    NavForward,
    NavUp,
    NavDown,
    NavHome,
    NavMenu,
    FileGeneric,
    FolderClosed,
    FolderOpen,
    TrashEmpty,
    TrashFull,
    StatusBusy,
    StatusCheck,
    StatusError,
    UserAccount,
    Notification,
    Help,
    Lock,
}

Expand description

Semantic icon roles for cross-platform icon resolution.

Each variant represents a conceptual icon role (not a specific icon image). Platform-specific icon identifiers are resolved via icon_name() using an IconSet.

§Categories

Variants are grouped by prefix into 7 categories:

Dialog (6): Alerts and dialog indicators
Window (4): Window control buttons
Action (14): Common user actions
Navigation (6): Directional and structural navigation
Files (5): File and folder representations
Status (3): State indicators
System (4): System-level UI elements

§Examples

use native_theme::IconRole;

let role = IconRole::ActionSave;
match role {
    IconRole::ActionSave => println!("save icon"),
    _ => println!("other icon"),
}

// Iterate all roles
assert_eq!(IconRole::ALL.len(), 42);

Variants (Non-exhaustive)§

This enum is marked as 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.

DialogWarning

Warning indicator for dialogs

DialogError

Error indicator for dialogs

DialogInfo

Informational indicator for dialogs

DialogQuestion

Question indicator for dialogs

DialogSuccess

Success/confirmation indicator for dialogs

Shield

Security/shield indicator

WindowClose

Close window button

WindowMinimize

Minimize window button

WindowMaximize

Maximize window button

WindowRestore

Restore window button (from maximized state)

ActionSave

Save action

ActionDelete

Delete action

ActionCopy

Copy to clipboard

ActionPaste

Paste from clipboard

ActionCut

Cut to clipboard

ActionUndo

Undo last action

ActionRedo

Redo last undone action

ActionSearch

Search / find

ActionSettings

Settings / preferences

ActionEdit

Edit / modify

ActionAdd

Add / create new item

ActionRemove

Remove item

ActionRefresh

Refresh / reload

ActionPrint

Print

NavBack

Navigate backward

NavForward

Navigate forward

NavUp

Navigate up in hierarchy

NavDown

Navigate down in hierarchy

NavHome

Navigate to home / root

NavMenu

Open menu / hamburger

FileGeneric

Generic file icon

FolderClosed

Closed folder

FolderOpen

Open folder

TrashEmpty

Empty trash / recycle bin

TrashFull

Full trash / recycle bin

StatusBusy

Busy / working state indicator

StatusCheck

Check / success indicator

StatusError

Error state indicator

UserAccount

User account / profile

Notification

Notification / bell

Help

Help / question mark

Lock

Lock / security

Implementations§

impl IconRole

pub const ALL: [IconRole; 42]

All icon role variants, useful for iteration and exhaustive testing.

Contains exactly 42 variants, one for each role, in declaration order.

Trait Implementations§

impl Clone for IconRole

fn clone(&self) -> IconRole

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

impl Debug for IconRole

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

Formats the value using the given formatter. Read more

impl Hash for IconRole

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

Feeds this value into the given Hasher. Read more

1.3.0 · Source§

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

Feeds a slice of this type into the given Hasher. Read more

impl IconProvider for IconRole

fn icon_name(&self, set: IconSet) -> Option<&str>

Return the platform/theme-specific icon name for this icon in the given set.

fn icon_svg(&self, set: IconSet) -> Option<&'static [u8]>

Return bundled SVG bytes for this icon in the given set.

impl PartialEq for IconRole

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

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

1.0.0 · Source§

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 Copy for IconRole

impl Eq for IconRole

impl StructuralPartialEq for IconRole

Auto Trait Implementations§

impl Freeze for IconRole

impl RefUnwindSafe for IconRole

impl Send for IconRole

impl Sync for IconRole

impl Unpin for IconRole

impl UnsafeUnpin for IconRole

impl UnwindSafe for IconRole

Blanket Implementations§

impl<T> Any for T
where T: 'static + ?Sized,

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more

impl<T> Borrow<T> for T
where T: ?Sized,

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

impl<T> BorrowMut<T> for T
where T: ?Sized,

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more

impl<T> CloneToUninit for T
where T: Clone,

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

impl<T> Downcast for T
where T: Any,

fn into_any(self: Box<T>) -> Box<dyn Any>

Convert Box<dyn Trait> (where Trait: Downcast) to Box<dyn Any>. Box<dyn Any> can then be further downcast into Box<ConcreteType> where ConcreteType implements Trait.

fn into_any_rc(self: Rc<T>) -> Rc<dyn Any>

Convert Rc<Trait> (where Trait: Downcast) to Rc<Any>. Rc<Any> can then be further downcast into Rc<ConcreteType> where ConcreteType implements Trait.

fn as_any(&self) -> &(dyn Any + 'static)

Convert &Trait (where Trait: Downcast) to &Any. This is needed since Rust cannot generate &Any’s vtable from &Trait’s.

fn as_any_mut(&mut self) -> &mut (dyn Any + 'static)

Convert &mut Trait (where Trait: Downcast) to &Any. This is needed since Rust cannot generate &mut Any’s vtable from &mut Trait’s.

impl<T> DowncastSync for T
where T: Any + Send + Sync,

fn into_any_arc(self: Arc<T>) -> Arc<dyn Any + Send + Sync>

Convert Arc<Trait> (where Trait: Downcast) to Arc<Any>. Arc<Any> can then be further downcast into Arc<ConcreteType> where ConcreteType implements Trait.

impl<T> DynClone for T
where T: Clone,

fn __clone_box(&self, _: Private) -> *mut ()

impl<Q, K> Equivalent<K> for Q
where Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,

fn equivalent(&self, key: &K) -> bool

Checks if this value is equivalent to the given key. Read more

impl<Q, K> Equivalent<K> for Q
where Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,

fn equivalent(&self, key: &K) -> bool

Compare self to key and return true if they are equal.

impl<Q, K> Equivalent<K> for Q
where Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,

fn equivalent(&self, key: &K) -> bool

Checks if this value is equivalent to the given key. Read more

impl<Q, K> Equivalent<K> for Q
where Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,

fn equivalent(&self, key: &K) -> bool

Checks if this value is equivalent to the given key. Read more

impl<T> From<T> for T

fn from(t: T) -> T

Returns the argument unchanged.

impl<T> Instrument for T

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more

impl<T, U> Into<U> for T
where U: From<T>,

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

impl<T> IntoEither for T

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more

impl<T> Pointable for T

const ALIGN: usize

The alignment of pointer.

type Init = T

The type for initializers.

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more

impl<T> Same for T

type Output = T

Should always be Self

impl<T> ToOwned for T
where T: Clone,

type Owned = T

The resulting type after obtaining ownership.

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more

impl<T, U> TryFrom<U> for T
where U: Into<T>,

type Error = Infallible

The type returned in the event of a conversion error.

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

fn vzip(self) -> V

impl<T> WithSubscriber for T

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

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more