Colorchoice

https://docs.rs/colorchoice/

Admin

colorchoice is a Rust crate that provides a global override and control mechanism for terminal color...

Tokens:1,277

Snippets:22

Trust Score:9.1

Update:4 weeks ago

Show doc for...

Tokens:

Raw

### ColorChoice::global

Source: https://docs.rs/colorchoice/latest/colorchoice/enum.ColorChoice.html

Gets the current global ColorChoice state.

```APIDOC
## ColorChoice::global

### Description
Returns the current global `ColorChoice` state.

### Method
`pub fn global() -> Self`

### Parameters
None

### Returns
- **Self** - The current `ColorChoice` value.

### Example
```rust
let choice = ColorChoice::global();
```

```

--------------------------------

### ColorChoice::global()

Source: https://docs.rs/colorchoice/latest/src/colorchoice/lib.rs.html

Retrieves the current global ColorChoice state. This method returns the currently configured color selection, which defaults to Auto.

```APIDOC
## ColorChoice::global()

### Description
Returns the current global color choice state.

### Method
`pub fn global() -> Self`

### Parameters
None

### Returns
- **Self** - The current `ColorChoice` value.

### Example
```rust
let current = ColorChoice::global();
```

```

--------------------------------

### ColorChoice::write_global

Source: https://docs.rs/colorchoice/latest/colorchoice/enum.ColorChoice.html

Overrides the detected global ColorChoice state.

```APIDOC
## ColorChoice::write_global

### Description
Overrides the detected global `ColorChoice` state with the provided value.

### Method
`pub fn write_global(self)`

### Parameters
- **self** (ColorChoice) - The new `ColorChoice` value to set as global.

### Returns
`()` (unit)

### Example
```rust
ColorChoice::Never.write_global();
```

```

--------------------------------

### ColorChoice enum definition

Source: https://docs.rs/colorchoice/latest/colorchoice/enum.ColorChoice.html

Defines the ColorChoice enum with four variants: Auto, AlwaysAnsi, Always, and Never. Auto uses colors if the output device supports them, AlwaysAnsi only emits ANSI codes, Always tries hard to emit colors including on Windows, and Never disables colors.

```rust
pub enum ColorChoice {
    Auto,
    AlwaysAnsi,
    Always,
    Never,
}
```

Tokens:

Raw