Enum IconSupport 

#[non_exhaustive]
pub enum IconSupport {
    Available,
    Degraded {
        reason: &'static str,
    },
    Unsupported {
        reason: &'static str,
    },
}

Whether this process can set its host window’s icon.

Capability matrix

Host	Verdict	Backend
Windows conhost	Available	WM_SETICON
Windows Terminal	Degraded	OSC 1 name only; set the profile’s icon field for a real image
Other Windows emulators	Degraded	OSC 1 name only
Linux X11	Degraded	OSC 1 name only (_NET_WM_ICON not yet implemented)
Linux Wayland	Unsupported	compositors do not let a client set another window’s icon
macOS	Unsupported	the window belongs to Terminal.app / iTerm2, not to this process
No terminal	Unsupported	nothing to set an icon on

An out-of-date row here is a documentation regression: callers decide whether to ship an icon at all based on this table.

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.

Available

The host window accepts an icon.

Degraded

The host accepts only a symbolic name, not an image.

Reported rather than folded into Available because the difference is visible to the user: an OSC 1 name may be shown, ignored, or applied to something other than the window icon, and a caller told “yes” that then sees nothing change cannot tell a failure from a terminal that simply does not do icons.

Fields

reason: &'static str

What will actually happen, and why it is less than asked for.

Unsupported

It does not, and this is why.

The reason is carried so a caller can log something an operator can act on, rather than a bare boolean that invites retrying forever.

Fields

reason: &'static str

Human-readable explanation.

Implementations

impl IconSupport

pub fn is_available(&self) -> bool

Whether a real image icon can be set.

False for IconSupport::Degraded: a caller choosing whether to embed and ship an icon file wants to know whether the file will be used, and on a degraded host it will not be.

pub fn is_attemptable(&self) -> bool

Whether an attempt will do something, image or not.

True for both IconSupport::Available and IconSupport::Degraded — the distinction a caller wants when deciding whether to bother calling at all, as opposed to whether to ship an image.

pub fn reason(&self) -> Option<&'static str>

The reason support is absent or reduced, if it is.

Trait Implementations

impl Clone for IconSupport

fn clone(&self) -> IconSupport

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for IconSupport

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

Formats the value using the given formatter.

impl Eq for IconSupport

impl PartialEq for IconSupport

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for IconSupport