Deadnix

https://docs.rs/deadnix/1.3.1/
Admin
Deadnix is a Rust library that scans .nix files to detect and identify dead code, including unused...
Tokens:28,535
Snippets:271
Trust Score:9.1
Update:5 months ago
Show doc for...
Tokens:
Raw
### Create New Painted Instance

Source: https://docs.rs/deadnix/1.3.1/deadnix/struct.Settings.html

Creates a new `Painted` instance with a default style. This is the starting point for applying styles.

```rust
fn new(self) -> Painted<Self>
where Self: Sized,
Create a new `Painted` with a default `Style`. Read more
```

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

### Binding::starts_with_underscore

Source: https://docs.rs/deadnix/1.3.1/src/deadnix/binding.rs.html

Determines if the binding's name starts with an underscore, indicating an anonymous variable.

```APIDOC
/// Does the name start with `_`, signifying an anonymous
/// variable?
pub fn starts_with_underscore(&self) -> bool
```

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

### Find dead code in Nix files

Source: https://docs.rs/deadnix/1.3.1/src/deadnix/lib.rs.html

Use the `Settings` struct to configure dead code detection and then call `find_dead_code` with the parsed Nix syntax tree. This example demonstrates how to print the names of unused bindings.

```rust
let content = "
    let
      foo = {};
      inherit (foo) bar baz;
    in baz
";
let ast = rnix::Root::parse(content);
assert_eq!(0, ast.errors().len());

let results = deadnix::Settings {
    no_lambda_arg: false,
    no_lambda_pattern_names: false,
    no_underscore: false,
    warn_used_underscore: false,
}.find_dead_code(&ast.syntax());

for dead_code in &results {
    println!("unused binding: {}", dead_code.binding.name);
}

```

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

### Check if Binding Name Starts with Underscore

Source: https://docs.rs/deadnix/1.3.1/deadnix/struct.Binding.html

Identifies if the binding's name begins with an underscore, which typically signifies an anonymous variable.

```rust
pub fn starts_with_underscore(&self) -> bool
```

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

### Conditionally Enable Styling

Source: https://docs.rs/deadnix/1.3.1/deadnix/struct.Binding.html

Conditionally enables styling based on a `Condition`. This example shows enabling styling only when both stdout and stderr are TTYs.

```rust
use yansi::{Paint, Condition};

painted.red().on_yellow().whenever(Condition::STDOUTERR_ARE_TTY);
```

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

### Initialization and Styling

Source: https://docs.rs/deadnix/1.3.1/deadnix/struct.Binding.html

Methods for creating and applying styles.

```APIDOC
## fn new(self) -> Painted<Self>

where Self: Sized,
Create a new `Painted` with a default `Style`. Read more

## fn paint<S>(&self, style: S) -> Painted<&Self>

where S: Into<Style>,
Apply a style wholesale to `self`. Any previous style is replaced. Read more
```

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

### Get Type ID of Binding

Source: https://docs.rs/deadnix/1.3.1/deadnix/struct.Binding.html

Retrieves the `TypeId` of the Binding, useful for runtime type identification.

```rust
fn type_id(&self) -> TypeId
```

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

### new

Source: https://docs.rs/deadnix/1.3.1/deadnix/struct.Settings.html

Create a new `Painted` with a default `Style`. Read more

```APIDOC
## fn new(self) -> Painted<Self>

where Self: Sized,
Create a new `Painted` with a default `Style`. Read more
```

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

### Get Scope Color for RecAttrSet

Source: https://docs.rs/deadnix/1.3.1/src/deadnix/scope.rs.html

Returns the color associated with the RecAttrSet scope, used for dead code warnings.

```rust
Scope::RecAttrSet(_) => Color::Yellow,
```

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

### Binding::new

Source: https://docs.rs/deadnix/1.3.1/src/deadnix/binding.rs.html

Constructor for creating a new Binding instance.

```APIDOC
/// Create a new Binding
pub fn new(name: Ident, decl_node: SyntaxNode<NixLanguage>, mortal: bool) -> Self
```

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

### Get Scope Color for LetIn

Source: https://docs.rs/deadnix/1.3.1/src/deadnix/scope.rs.html

Returns the color associated with the LetIn scope, used for dead code warnings.

```rust
Scope::LetIn(_) => Color::Red,
```

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

### Get Scope Color for LambdaArg

Source: https://docs.rs/deadnix/1.3.1/src/deadnix/scope.rs.html

Returns the color associated with the LambdaArg scope, used for dead code warnings.

```rust
Scope::LambdaArg(_, _) => Color::Cyan,
```

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

### paint

Source: https://docs.rs/deadnix/1.3.1/deadnix/enum.Scope.html

Apply a style wholesale to `self`. Any previous style is replaced.

```APIDOC
## fn paint<S>(&self, style: S) -> Painted<&Self>

### Description
Apply a style wholesale to `self`. Any previous style is replaced.

### Method
`paint`

### Parameters
* **style** (S: Into<Style>) - The style to apply.

### Response
Returns a `Painted` reference with the specified style applied.

### Request Example
```
let styled_text = painted_object.paint(Style::new().bold());
```
```

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

### Apply Text Quirks using quirk() and specific methods

Source: https://docs.rs/deadnix/1.3.1/deadnix/enum.Scope.html

Demonstrates how to apply text quirks like wrapping. Prefer specific methods like `wrap()` over the general `quirk()` method for conciseness.

```rust
use yansi::{Paint, Quirk};

painted.quirk(Quirk::Wrap);
```

```rust
use yansi::Paint;

painted.wrap();
```

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

### Get Scope Color for LambdaPattern

Source: https://docs.rs/deadnix/1.3.1/src/deadnix/scope.rs.html

Returns the color associated with the LambdaPattern scope, used for dead code warnings.

```rust
Scope::LambdaPattern(_, _) => Color::Magenta,
```

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

### Enable Wrapping using quirk()

Source: https://docs.rs/deadnix/1.3.1/deadnix/struct.Binding.html

Demonstrates enabling the wrap quirk using the generic `quirk()` method. Prefer specific methods like `wrap()` when available.

```rust
use yansi::{Paint, Quirk};

painted.quirk(Quirk::Wrap);
```

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

### Default Settings Implementation

Source: https://docs.rs/deadnix/1.3.1/deadnix/struct.Settings.html

Provides the default configuration for the Settings struct.

```rust
fn default() -> Settings
```

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

### Formatted Output with Color

Source: https://docs.rs/deadnix/1.3.1/deadnix/enum.Scope.html

Applies foreground or background colors to displayed output.

```rust
fn fg<C>(self, color: C) -> Foreground<Self>
where C: Into<Option<Color>>
```

```rust
fn bg<C>(self, color: C) -> Background<Self>
where C: Into<Option<Color>>
```

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

### Enable Wrap Quirk using wrap()

Source: https://docs.rs/deadnix/1.3.1/deadnix/struct.Settings.html

This method demonstrates enabling the wrap quirk using the dedicated `wrap()` method. This is the preferred approach.

```rust
use yansi::Paint;

painted.wrap();
```

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

### Check if Binding is Mortal

Source: https://docs.rs/deadnix/1.3.1/deadnix/struct.Binding.html

Determines if a binding is mortal. Bindings that are part of a `rec { ... }` block or lambda arguments starting with `_` are not considered mortal.

```rust
pub fn is_mortal(&self) -> bool
```

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

### Binding::is_mortal

Source: https://docs.rs/deadnix/1.3.1/src/deadnix/binding.rs.html

Checks if the binding is considered 'mortal', meaning it can be removed by deadnix. Bindings that are part of a `rec { ... }` or have lambda arguments starting with `_` are not mortal.

```APIDOC
/// Can die?
///
/// Not mortal are `rec { ... }`, and lambda args that already
/// start with `_`.
pub fn is_mortal(&self) -> bool
```

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

### Styling Output with Paint

Source: https://docs.rs/deadnix/1.3.1/deadnix/enum.Scope.html

Provides methods to apply various colors to output strings using the `yansi` crate.

```rust
fn fg(&self, value: Color) -> Painted<&T>
```

```rust
fn primary(&self) -> Painted<&T>
```

```rust
fn fixed(&self, color: u8) -> Painted<&T>
```

```rust
fn rgb(&self, r: u8, g: u8, b: u8) -> Painted<&T>
```

```rust
fn black(&self) -> Painted<&T>
```

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

### paint

Source: https://docs.rs/deadnix/1.3.1/deadnix/struct.Settings.html

Apply a style wholesale to `self`. Any previous style is replaced. Read more

```APIDOC
## fn paint<S>(&self, style: S) -> Painted<&Self>

where S: Into<Style>,
Apply a style wholesale to `self`. Any previous style is replaced. Read more
```

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

### Convert Dead Code to Edit Operation

Source: https://docs.rs/deadnix/1.3.1/src/deadnix/edit.rs.html

Converts a `DeadCode` struct into an `Edit` struct, determining the start and end positions and the replacement string for the dead binding. Handles special cases like lambda patterns.

```rust
fn dead_to_edit(dead_code: DeadCode) -> Option<Edit> {
    let range = dead_code.binding.decl_node.text_range();
    let mut start = usize::from(range.start());
    let mut end = usize::from(range.end());
    let mut replace_node = dead_code.binding.decl_node.clone();
    let mut replacement = None;
    match dead_code.scope {
        Scope::LambdaPattern(pattern, _) => {
            if pattern.pat_bind().is_some_and(|at| {
                at.ident().expect("at.ident").syntax() == &dead_code.binding.decl_node
            }) {
                if let Some(pattern_bind_node) = pattern
                    .syntax()
                    .children()
                    .find(|child| child.kind() == SyntaxKind::NODE_PAT_BIND)
                {
                    // `dead @ { ... }`, `{ ... } @ dead` forms
                    let pattern_bind_range = pattern_bind_node.text_range();
                    start = usize::from(pattern_bind_range.start());
                    end = usize::from(pattern_bind_range.end());
                    // also remove trailing whitespace for this form
                    if let Some(next) = pattern_bind_node.next_sibling_or_token() {
                        if next.kind() == SyntaxKind::TOKEN_WHITESPACE {
                            end = usize::from(next.text_range().end());
                        }
                    }
                    replacement = Some(String::new());
                    replace_node = pattern_bind_node;
                }
            } else {
                let mut tokens = pattern.syntax().children_with_tokens().skip_while(|node| {
                    node.as_node()
                        .is_none_or(|node| *node != dead_code.binding.decl_node)
                });
                tokens.next();
                for token in tokens {
                    replacement = Some(String::new());
                    if token.kind() == SyntaxKind::TOKEN_COMMA {
                        // up to the next comma
                        end = usize::from(token.text_range().end());
                        break;
                    } else if token.kind() == SyntaxKind::TOKEN_R_BRACE {
                        // last binding before `}`, find the trailing comma before
                        let Some(mut prev) = dead_code.binding.decl_node.prev_sibling_or_token() else {
                            break;
                        };
                        while prev.kind() == SyntaxKind::TOKEN_WHITESPACE {
                            match prev.prev_sibling_or_token() {
                                Some(prev_token) => prev = prev_token,
                                None => break,
                            }
                        }
                        if prev.kind() == SyntaxKind::TOKEN_COMMA {
                            start = usize::from(prev.text_range().start());
                        }
                        break;
                    } else if token.kind() != SyntaxKind::TOKEN_WHITESPACE {
                        // delete only whitespace
                        break;
                    }
                }
            }
        }

        Scope::LambdaArg(name, _) => {

```

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

### Color Methods

Source: https://docs.rs/deadnix/1.3.1/deadnix/struct.Binding.html

Methods for setting background colors.

```APIDOC
## fn on_bright_cyan()

Returns `self` with the `bg()` set to [`Color :: BrightCyan`].

##### §Example
```
println!("{}", value.on_bright_cyan());
```

## fn on_bright_white()

Returns `self` with the `bg()` set to [`Color :: BrightWhite`].

##### §Example
```
println!("{}", value.on_bright_white());
```
```

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

### Style Application

Source: https://docs.rs/deadnix/1.3.1/deadnix/struct.DeadCode.html

Methods for creating and applying styles.

```APIDOC
## new()

### Description
Create a new `Painted` with a default `Style`.

### Method
`new()`

### Example
```rust
let painted = Painted::new();
```
```

```APIDOC
## paint<S>(style: S)

### Description
Apply a style wholesale to `self`. Any previous style is replaced.

### Method
`paint<S>(style: S)`

### Parameters
#### Path Parameters
- **style** (S: Into<Style>) - Required - The style to apply.

### Example
```rust
let styled_text = painted.paint(yansi::Style::new().bold().red());
```
```

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

### Apply Text Attributes using attr() and specific methods

Source: https://docs.rs/deadnix/1.3.1/deadnix/enum.Scope.html

Demonstrates how to apply text attributes like bold. Prefer specific methods like `bold()` over the general `attr()` method for conciseness.

```rust
use yansi::{Paint, Attribute};

painted.attr(Attribute::Bold);
```

```rust
use yansi::Paint;

painted.bold();
```

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

### Enable Bold Attribute using bold()

Source: https://docs.rs/deadnix/1.3.1/deadnix/struct.Settings.html

This method demonstrates enabling the bold attribute using the dedicated `bold()` method. This is the preferred approach.

```rust
use yansi::Paint;

painted.bold();
```

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

### Color Styling Methods

Source: https://docs.rs/deadnix/1.3.1/deadnix/struct.DeadCode.html

Methods for applying background colors to text.

```APIDOC
## on_bright_cyan()

### Description
Returns `self` with the `bg()` set to [`Color :: BrightCyan`].

### Method
`on_bright_cyan()`

### Example
```rust
println!("{}", value.on_bright_cyan());
```
```

```APIDOC
## on_bright_white()

### Description
Returns `self` with the `bg()` set to [`Color :: BrightWhite`].

### Method
`on_bright_white()`

### Example
```rust
println!("{}", value.on_bright_white());
```
```

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

### TryFrom

Source: https://docs.rs/deadnix/1.3.1/deadnix/struct.DeadCode.html

Enables attempting to convert one type into another, returning a `Result` to handle potential errors.

```APIDOC
## try_from

### Description
Performs the conversion from type `U` into type `T`.

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

### Associated Type
`type Error = Infallible` - The type returned in the event of a conversion error.
```

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

### Find Dead Code Entry Point

Source: https://docs.rs/deadnix/1.3.1/src/deadnix/dead_code.rs.html

The main entry point for finding unused bindings. It iteratively scans the AST until no new unused bindings are discovered.

```rust
impl Settings {
    /// Find unused bindings
    ///
    /// Loops until no more new [`Binding`] is found that is used only
    /// by [`DeadCode`] that was found in a previous iteration.
    pub fn find_dead_code(&self, node: &SyntaxNode<NixLanguage>) -> Vec<DeadCode> {
        let mut dead = HashSet::new();
        let mut results = HashMap::new();
        let mut prev_results_len = 1;
        while prev_results_len != results.len() {
            prev_results_len = results.len();
            self.scan(node, &mut dead, &mut results);
        }

        let mut results = results.into_values().collect::<Vec<_>>();
        results.sort_unstable_by_key(|result| result.binding.name.syntax().text_range().start());
        results
    }

    /// Recursively scan the AST, accumulating results
    fn scan(
        &self,
        node: &SyntaxNode<NixLanguage>,
        dead: &mut HashSet<SyntaxNode<NixLanguage>>,
        results: &mut HashMap<SyntaxNode<NixLanguage>, DeadCode>,
    ) {
        // check the scope of this `node`
        if let Some(scope) = Scope::new(node) {
            if !(self.no_lambda_arg && scope.is_lambda_arg()) {
                for binding in scope.bindings() {
                    if self.no_underscore && binding.starts_with_underscore() {
                        continue;
                    }
                    if self.no_lambda_pattern_names && scope.is_lambda_pattern_name(&binding.name) {
                        continue;
                    }

                    if binding.is_mortal() && !binding.has_pragma_skip() {
                        let unused = scope.bodies().all(|body|
                            // remove this binding's own node
                            body == binding.decl_node
                            // excluding already unused results
                            || dead.contains(&body)
                            || is_dead_inherit(dead, &body)
                            // or not used anywhere
                            || ! usage::find(&binding.name, &body));
                        if unused
                            || (self.warn_used_underscore
                                && binding.name.syntax().text().char_at(0.into()) == Some('_')
                                && !unused)
                        {
                            dead.insert(binding.decl_node.clone());
                            results.insert(
                                binding.decl_node.clone(),
                                DeadCode {
                                    scope: scope.clone(),
                                    binding,
                                    unused,
                                },
                            );
                        }
                    }
                }
            }
        }

        // recurse through the AST
        for child in node.children() {
            self.scan(&child, dead, results);
        }
    }
}
```

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

### Clone Implementation for Settings

Source: https://docs.rs/deadnix/1.3.1/deadnix/struct.Settings.html

Allows creating a duplicate of the Settings struct.

```rust
fn clone(&self) -> Settings
```

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

### Settings Struct Definition

Source: https://docs.rs/deadnix/1.3.1/deadnix/struct.Settings.html

Defines the configuration options for deadnix code analysis.

```rust
pub struct Settings {
    pub no_lambda_arg: bool,
    pub no_lambda_pattern_names: bool,
    pub no_underscore: bool,
    pub warn_used_underscore: bool,
}
```

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

### Color Methods

Source: https://docs.rs/deadnix/1.3.1/deadnix/enum.Scope.html

Methods for setting the background color of the text.

```APIDOC
## on_bright_red()

### Description
Returns `self` with the `bg()` set to [`Color :: BrightRed`].

### Method
`on_bright_red()`

### Response
#### Success Response (Painted<&T>)
Returns a `Painted` reference with the background color set.

### Request Example
```rust
println!("{}", value.on_bright_red());
```
```

```APIDOC
## on_bright_green()

### Description
Returns `self` with the `bg()` set to [`Color :: BrightGreen`].

### Method
`on_bright_green()`

### Response
#### Success Response (Painted<&T>)
Returns a `Painted` reference with the background color set.

### Request Example
```rust
println!("{}", value.on_bright_green());
```
```

```APIDOC
## on_bright_yellow()

### Description
Returns `self` with the `bg()` set to [`Color :: BrightYellow`].

### Method
`on_bright_yellow()`

### Response
#### Success Response (Painted<&T>)
Returns a `Painted` reference with the background color set.

### Request Example
```rust
println!("{}", value.on_bright_yellow());
```
```

```APIDOC
## on_bright_blue()

### Description
Returns `self` with the `bg()` set to [`Color :: BrightBlue`].

### Method
`on_bright_blue()`

### Response
#### Success Response (Painted<&T>)
Returns a `Painted` reference with the background color set.

### Request Example
```rust
println!("{}", value.on_bright_blue());
```
```

```APIDOC
## on_bright_magenta()

### Description
Returns `self` with the `bg()` set to [`Color :: BrightMagenta`].

### Method
`on_bright_magenta()`

### Response
#### Success Response (Painted<&T>)
Returns a `Painted` reference with the background color set.

### Request Example
```rust
println!("{}", value.on_bright_magenta());
```
```

```APIDOC
## on_bright_cyan()

### Description
Returns `self` with the `bg()` set to [`Color :: BrightCyan`].

### Method
`on_bright_cyan()`

### Response
#### Success Response (Painted<&T>)
Returns a `Painted` reference with the background color set.

### Request Example
```rust
println!("{}", value.on_bright_cyan());
```
```

```APIDOC
## on_bright_white()

### Description
Returns `self` with the `bg()` set to [`Color :: BrightWhite`].

### Method
`on_bright_white()`

### Response
#### Success Response (Painted<&T>)
Returns a `Painted` reference with the background color set.

### Request Example
```rust
println!("{}", value.on_bright_white());
```
```

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

### whenever

Source: https://docs.rs/deadnix/1.3.1/deadnix/enum.Scope.html

Conditionally enable styling based on whether the `Condition` `value` applies. Replaces any previous condition.

```APIDOC
## fn whenever(&self, value: Condition) -> Painted<&T>

### Description
Conditionally enable styling based on whether the `Condition` `value` applies. Replaces any previous condition.
See the crate level docs for more details.

### Method
`whenever`

### Parameters
* **value** (Condition) - The condition to apply for styling.

### Response
Returns a `Painted` reference with the conditional styling applied.

### Request Example
```
use yansi::{Paint, Condition};

painted.red().on_yellow().whenever(Condition::STDOUTERR_ARE_TTY);
```
```

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

### Background Color Methods

Source: https://docs.rs/deadnix/1.3.1/deadnix/enum.Scope.html

These methods allow you to set the background color of the painted text. Each method corresponds to a specific color.

```APIDOC
## bg(value: Color)

### Description
Returns a styled value derived from `self` with the background set to `value`. This method should be used rarely. Instead, prefer to use color-specific builder methods like `on_red()` and `on_green()`, which have the same functionality but are pithier.

### Method
`bg(value: Color)`

### Parameters
#### Path Parameters
- **value** (Color) - Required - The color to set as the background.

### Example
Set background color to red using `fg()`:
```rust
use yansi::{Paint, Color};

painted.bg(Color::Red);
```

Set background color to red using `on_red()`:
```rust
use yansi::Paint;

painted.on_red();
```
```

```APIDOC
## on_primary()

### Description
Returns `self` with the `bg()` set to [`Color :: Primary`].

### Method
Implicitly `self.bg(Color::Primary)`

### Example
```rust
println!("{}", value.on_primary());
```
```

```APIDOC
## on_fixed(color: u8)

### Description
Returns `self` with the `bg()` set to [`Color :: Fixed`].

### Method
`on_fixed(color: u8)`

### Parameters
#### Path Parameters
- **color** (u8) - Required - The fixed color value.

### Example
```rust
println!("{}", value.on_fixed(color));
```
```

```APIDOC
## on_rgb(r: u8, g: u8, b: u8)

### Description
Returns `self` with the `bg()` set to [`Color :: Rgb`].

### Method
`on_rgb(r: u8, g: u8, b: u8)`

### Parameters
#### Path Parameters
- **r** (u8) - Required - The red component.
- **g** (u8) - Required - The green component.
- **b** (u8) - Required - The blue component.

### Example
```rust
println!("{}", value.on_rgb(r, g, b));
```
```

```APIDOC
## on_black()

### Description
Returns `self` with the `bg()` set to [`Color :: Black`].

### Method
Implicitly `self.bg(Color::Black)`

### Example
```rust
println!("{}", value.on_black());
```
```

```APIDOC
## on_red()

### Description
Returns `self` with the `bg()` set to [`Color :: Red`].

### Method
Implicitly `self.bg(Color::Red)`

### Example
```rust
println!("{}", value.on_red());
```
```

```APIDOC
## on_green()

### Description
Returns `self` with the `bg()` set to [`Color :: Green`].

### Method
Implicitly `self.bg(Color::Green)`

### Example
```rust
println!("{}", value.on_green());
```
```

```APIDOC
## on_yellow()

### Description
Returns `self` with the `bg()` set to [`Color :: Yellow`].

### Method
Implicitly `self.bg(Color::Yellow)`

### Example
```rust
println!("{}", value.on_yellow());
```
```

```APIDOC
## on_blue()

### Description
Returns `self` with the `bg()` set to [`Color :: Blue`].

### Method
Implicitly `self.bg(Color::Blue)`

### Example
```rust
println!("{}", value.on_blue());
```
```

```APIDOC
## on_magenta()

### Description
Returns `self` with the `bg()` set to [`Color :: Magenta`].

### Method
Implicitly `self.bg(Color::Magenta)`

### Example
```rust
println!("{}", value.on_magenta());
```
```

```APIDOC
## on_cyan()

### Description
Returns `self` with the `bg()` set to [`Color :: Cyan`].

### Method
Implicitly `self.bg(Color::Cyan)`

### Example
```rust
println!("{}", value.on_cyan());
```
```

```APIDOC
## on_white()

### Description
Returns `self` with the `bg()` set to [`Color :: White`].

### Method
Implicitly `self.bg(Color::White)`

### Example
```rust
println!("{}", value.on_white());
```
```

```APIDOC
## on_bright_black()

### Description
Returns `self` with the `bg()` set to [`Color :: BrightBlack`].

### Method
Implicitly `self.bg(Color::BrightBlack)`

### Example
```rust
println!("{}", value.on_bright_black());
```
```

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

### Background Color Methods

Source: https://docs.rs/deadnix/1.3.1/deadnix/struct.Settings.html

Methods to set the background color of the text.

```APIDOC
## fn bg(&self, value: Color) -> Painted<&T>

### Description
Returns a styled value derived from `self` with the background set to `value`. This method should be used rarely. Instead, prefer to use color-specific builder methods like `on_red()` and `on_green()`, which have the same functionality but are pithier.

### Method
(Implicitly called on a `Painted` object)

### Parameters
#### Query Parameters
- **value** (Color) - Required - The color to set as the background.

### Example
Set background color to red using `fg()`:
```rust
use yansi::{Paint, Color};

painted.bg(Color::Red);
```

Set background color to red using `on_red()`:
```rust
use yansi::Paint;

painted.on_red();
```
```

```APIDOC
## fn on_primary()

### Description
Returns `self` with the `bg()` set to [`Color :: Primary`].

### Method
(Implicitly called on a `Painted` object)

### Example
```rust
println!("{}", value.on_primary());
```
```

```APIDOC
## fn on_fixed(color: u8)

### Description
Returns `self` with the `bg()` set to [`Color :: Fixed`].

### Method
(Implicitly called on a `Painted` object)

### Parameters
#### Query Parameters
- **color** (u8) - Required - The fixed color value.

### Example
```rust
println!("{}", value.on_fixed(color));
```
```

```APIDOC
## fn on_rgb(r: u8, g: u8, b: u8)

### Description
Returns `self` with the `bg()` set to [`Color :: Rgb`].

### Method
(Implicitly called on a `Painted` object)

### Parameters
#### Query Parameters
- **r** (u8) - Required - The red component of the RGB color.
- **g** (u8) - Required - The green component of the RGB color.
- **b** (u8) - Required - The blue component of the RGB color.

### Example
```rust
println!("{}", value.on_rgb(r, g, b));
```
```

```APIDOC
## fn on_black()

### Description
Returns `self` with the `bg()` set to [`Color :: Black`].

### Method
(Implicitly called on a `Painted` object)

### Example
```rust
println!("{}", value.on_black());
```
```

```APIDOC
## fn on_red()

### Description
Returns `self` with the `bg()` set to [`Color :: Red`].

### Method
(Implicitly called on a `Painted` object)

### Example
```rust
println!("{}", value.on_red());
```
```

```APIDOC
## fn on_green()

### Description
Returns `self` with the `bg()` set to [`Color :: Green`].

### Method
(Implicitly called on a `Painted` object)

### Example
```rust
println!("{}", value.on_green());
```
```

```APIDOC
## fn on_yellow()

### Description
Returns `self` with the `bg()` set to [`Color :: Yellow`].

### Method
(Implicitly called on a `Painted` object)

### Example
```rust
println!("{}", value.on_yellow());
```
```

```APIDOC
## fn on_blue()

### Description
Returns `self` with the `bg()` set to [`Color :: Blue`].

### Method
(Implicitly called on a `Painted` object)

### Example
```rust
println!("{}", value.on_blue());
```
```

```APIDOC
## fn on_magenta()

### Description
Returns `self` with the `bg()` set to [`Color :: Magenta`].

### Method
(Implicitly called on a `Painted` object)

### Example
```rust
println!("{}", value.on_magenta());
```
```

```APIDOC
## fn on_cyan()

### Description
Returns `self` with the `bg()` set to [`Color :: Cyan`].

### Method
(Implicitly called on a `Painted` object)

### Example
```rust
println!("{}", value.on_cyan());
```
```

```APIDOC
## fn on_white()

### Description
Returns `self` with the `bg()` set to [`Color :: White`].

### Method
(Implicitly called on a `Painted` object)

### Example
```rust
println!("{}", value.on_white());
```
```

```APIDOC
## fn on_bright_black()

### Description
Returns `self` with the `bg()` set to [`Color :: BrightBlack`].

### Method
(Implicitly called on a `Painted` object)

### Example
```rust
println!("{}", value.on_bright_black());
```
```

```APIDOC
## fn on_bright_red()

### Description
Returns `self` with the `bg()` set to [`Color :: BrightRed`].

### Method
(Implicitly called on a `Painted` object)

### Example
```rust
println!("{}", value.on_bright_red());
```
```

```APIDOC
## fn on_bright_green()

### Description
Returns `self` with the `bg()` set to [`Color :: BrightGreen`].

### Method
(Implicitly called on a `Painted` object)

### Example
```rust
println!("{}", value.on_bright_green());
```
```

```APIDOC
## fn on_bright_yellow()

### Description
Returns `self` with the `bg()` set to [`Color :: BrightYellow`].

### Method
(Implicitly called on a `Painted` object)

### Example
```rust
println!("{}", value.on_bright_yellow());
```
```

```APIDOC
## fn on_bright_blue()

### Description
Returns `self` with the `bg()` set to [`Color :: BrightBlue`].

### Method
(Implicitly called on a `Painted` object)

### Example
```rust
println!("{}", value.on_bright_blue());
```
```

```APIDOC
## fn on_bright_magenta()

### Description
Returns `self` with the `bg()` set to [`Color :: BrightMagenta`].

### Method
(Implicitly called on a `Painted` object)

### Example
```rust
println!("{}", value.on_bright_magenta());
```
```

```APIDOC
## fn on_bright_cyan()

### Description
Returns `self` with the `bg()` set to [`Color :: BrightCyan`].

### Method
(Implicitly called on a `Painted` object)

### Example
```rust
println!("{}", value.on_bright_cyan());
```
```

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

### Enable Wrapping using wrap()

Source: https://docs.rs/deadnix/1.3.1/deadnix/struct.Binding.html

Enables the wrap quirk for the text. This is a shorthand for `quirk(Quirk::Wrap)`.

```rust
println!("{}", value.wrap());
```

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

### Clone to Uninit (Nightly)

Source: https://docs.rs/deadnix/1.3.1/deadnix/struct.Binding.html

Nightly-only experimental API to perform copy-assignment from the Binding to an uninitialized memory location.

```rust
unsafe fn clone_to_uninit(&self, dest: *mut u8)
```

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

### Attribute Styling Methods

Source: https://docs.rs/deadnix/1.3.1/deadnix/struct.DeadCode.html

Methods for applying text attributes like bold, underline, and more.

```APIDOC
## attr(value: Attribute)

### Description
Enables the styling `Attribute` `value`. This method should be used rarely. Instead, prefer to use attribute-specific builder methods like `bold()` and `underline()`, which have the same functionality but are pithier.

### Method
`attr(value: Attribute)`

### Parameters
#### Path Parameters
- **value** (Attribute) - Required - The attribute to enable.

### Example
Make text bold using `attr()`:
```rust
use yansi::{Paint, Attribute};

painted.attr(Attribute::Bold);
```

Make text bold using using `bold()`.
```rust
use yansi::Paint;

painted.bold();
```
```

```APIDOC
## bold()

### Description
Returns `self` with the `attr()` set to [`Attribute :: Bold`].

### Method
`bold()`

### Example
```rust
println!("{}", value.bold());
```
```

```APIDOC
## dim()

### Description
Returns `self` with the `attr()` set to [`Attribute :: Dim`].

### Method
`dim()`

### Example
```rust
println!("{}", value.dim());
```
```

```APIDOC
## italic()

### Description
Returns `self` with the `attr()` set to [`Attribute :: Italic`].

### Method
`italic()`

### Example
```rust
println!("{}", value.italic());
```
```

```APIDOC
## underline()

### Description
Returns `self` with the `attr()` set to [`Attribute :: Underline`].

### Method
`underline()`

### Example
```rust
println!("{}", value.underline());
```
```

```APIDOC
## blink()

### Description
Returns `self` with the `attr()` set to [`Attribute :: Blink`].

### Method
`blink()`

### Example
```rust
println!("{}", value.blink());
```
```

```APIDOC
## rapid_blink()

### Description
Returns `self` with the `attr()` set to [`Attribute :: RapidBlink`].

### Method
`rapid_blink()`

### Example
```rust
println!("{}", value.rapid_blink());
```
```

```APIDOC
## invert()

### Description
Returns `self` with the `attr()` set to [`Attribute :: Invert`].

### Method
`invert()`

### Example
```rust
println!("{}", value.invert());
```
```

```APIDOC
## conceal()

### Description
Returns `self` with the `attr()` set to [`Attribute :: Conceal`].

### Method
`conceal()`

### Example
```rust
println!("{}", value.conceal());
```
```

```APIDOC
## strike()

### Description
Returns `self` with the `attr()` set to [`Attribute :: Strike`].

### Method
`strike()`

### Example
```rust
println!("{}", value.strike());
```
```

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

### Apply Bold Attribute using attr()

Source: https://docs.rs/deadnix/1.3.1/deadnix/struct.Binding.html

Demonstrates how to enable the bold attribute using the generic `attr()` method. Prefer specific methods like `bold()` when available.

```rust
use yansi::{Paint, Attribute};

painted.attr(Attribute::Bold);
```

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

### TryFrom Implementation

Source: https://docs.rs/deadnix/1.3.1/deadnix/struct.Settings.html

This section details the `TryFrom` trait implementation for the Settings struct. It allows for fallible conversion from one type `U` into `T` (where `T` is likely Settings or a related type).

```APIDOC
## TryFrom<U> for T

### Description
Provides a mechanism to attempt conversion from type `U` into type `T`.

#### Associated Types
- `type Error = Infallible`: The type returned in the event of a conversion error. `Infallible` indicates that this conversion is infallible under normal circumstances.

#### Methods
- `fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>`: Performs the conversion from `value` of type `U` into `T`. Returns a `Result` which is either the converted value `T` or an error.
```

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

### print

Source: https://docs.rs/deadnix/1.3.1/deadnix/report/fn.print.html

Builds a report of dead code and prints it to standard output. It assumes that the provided results are already sorted by their occurrence in the file.

```APIDOC
## Function print

### Description
Build a report and print it to stdout
assumes results to be sorted by occurrence in file

### Signature
```rust
pub fn print(file: String, content: &str, results: &[DeadCode])
```

### Parameters
* `file` (String) - The path to the file being analyzed.
* `content` (&str) - The content of the file.
* `results` (&[DeadCode]) - A slice of `DeadCode` structs representing the detected dead code, assumed to be sorted.
```

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

### From Conversion for Binding

Source: https://docs.rs/deadnix/1.3.1/deadnix/struct.Binding.html

Converts a value into a Binding.

```rust
fn from(t: T) -> T
```

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

### Clear Styling using clear() (Deprecated)

Source: https://docs.rs/deadnix/1.3.1/deadnix/struct.Binding.html

Deprecated method to clear styling. Use `resetting()` instead. This method previously applied the `Clear` quirk.

```rust
println!("{}", value.clear());
```

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

### Attribute Methods

Source: https://docs.rs/deadnix/1.3.1/deadnix/enum.Scope.html

Methods for applying text attributes like bold, underline, etc.

```APIDOC
## attr(value: Attribute)

### Description
Enables the styling `Attribute` `value`. This method should be used rarely. Instead, prefer to use attribute-specific builder methods like `bold()` and `underline()`, which have the same functionality but are pithier.

### Method
`attr(value: Attribute)`

### Parameters
#### Path Parameters
- **value** (Attribute) - Required - The attribute to apply.

### Response
#### Success Response (Painted<&T>)
Returns a `Painted` reference with the specified attribute applied.

### Request Example
```rust
use yansi::{Paint, Attribute};

painted.attr(Attribute::Bold);
```
```

```APIDOC
## bold()

### Description
Returns `self` with the `attr()` set to [`Attribute :: Bold`].

### Method
`bold()`

### Response
#### Success Response (Painted<&T>)
Returns a `Painted` reference with bold attribute applied.

### Request Example
```rust
println!("{}", value.bold());
```
```

```APIDOC
## dim()

### Description
Returns `self` with the `attr()` set to [`Attribute :: Dim`].

### Method
`dim()`

### Response
#### Success Response (Painted<&T>)
Returns a `Painted` reference with dim attribute applied.

### Request Example
```rust
println!("{}", value.dim());
```
```

```APIDOC
## italic()

### Description
Returns `self` with the `attr()` set to [`Attribute :: Italic`].

### Method
`italic()`

### Response
#### Success Response (Painted<&T>)
Returns a `Painted` reference with italic attribute applied.

### Request Example
```rust
println!("{}", value.italic());
```
```

```APIDOC
## underline()

### Description
Returns `self` with the `attr()` set to [`Attribute :: Underline`].

### Method
`underline()`

### Response
#### Success Response (Painted<&T>)
Returns a `Painted` reference with underline attribute applied.

### Request Example
```rust
println!("{}", value.underline());
```
```

```APIDOC
## blink()

### Description
Returns `self` with the `attr()` set to [`Attribute :: Blink`].

### Method
`blink()`

### Response
#### Success Response (Painted<&T>)
Returns a `Painted` reference with blink attribute applied.

### Request Example
```rust
println!("{}", value.blink());
```
```

```APIDOC
## rapid_blink()

### Description
Returns `self` with the `attr()` set to [`Attribute :: RapidBlink`].

### Method
`rapid_blink()`

### Response
#### Success Response (Painted<&T>)
Returns a `Painted` reference with rapid blink attribute applied.

### Request Example
```rust
println!("{}", value.rapid_blink());
```
```

```APIDOC
## invert()

### Description
Returns `self` with the `attr()` set to [`Attribute :: Invert`].

### Method
`invert()`

### Response
#### Success Response (Painted<&T>)
Returns a `Painted` reference with invert attribute applied.

### Request Example
```rust
println!("{}", value.invert());
```
```

```APIDOC
## conceal()

### Description
Returns `self` with the `attr()` set to [`Attribute :: Conceal`].

### Method
`conceal()`

### Response
#### Success Response (Painted<&T>)
Returns a `Painted` reference with conceal attribute applied.

### Request Example
```rust
println!("{}", value.conceal());
```
```

```APIDOC
## strike()

### Description
Returns `self` with the `attr()` set to [`Attribute :: Strike`].

### Method
`strike()`

### Response
#### Success Response (Painted<&T>)
Returns a `Painted` reference with strike attribute applied.

### Request Example
```rust
println!("{}", value.strike());
```
```

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

### Set Foreground Color using white()

Source: https://docs.rs/deadnix/1.3.1/deadnix/struct.Binding.html

Sets the foreground color to white using the `white()` shorthand method.

```rust
use yansi::Paint;

painted.white();
```

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

### on_bright_white

Source: https://docs.rs/deadnix/1.3.1/deadnix/struct.Settings.html

Returns `self` with the `bg()` set to [`Color :: BrightWhite`].

```APIDOC
## fn on_bright_white(&self) -> Painted<&T>

Returns `self` with the `bg()` set to [`Color :: BrightWhite`].

##### §Example
```
println!("{}", value.on_bright_white());
```
```

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

### TryInto

Source: https://docs.rs/deadnix/1.3.1/deadnix/struct.DeadCode.html

Allows attempting to convert a value into another type, returning a `Result` for error handling.

```APIDOC
## try_into

### Description
Performs the conversion from type `T` into type `U`.

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

### Associated Type
`type Error = <U as TryFrom<T>>::Error` - The type returned in the event of a conversion error.
```

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

### TryInto Implementation

Source: https://docs.rs/deadnix/1.3.1/deadnix/struct.Settings.html

This section details the `TryInto` trait implementation for the Settings struct. It allows for fallible conversion from `T` (likely Settings or a related type) into another type `U`.

```APIDOC
## TryInto<U> for T

### Description
Provides a mechanism to attempt conversion from type `T` into type `U`.

#### Associated Types
- `type Error = <U as TryFrom<T>>::Error`: The type returned in the event of a conversion error. This error type is determined by the `TryFrom` implementation for `U` attempting to convert from `T`.

#### Methods
- `fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>`: Performs the conversion from `self` (type `T`) into `U`. Returns a `Result` which is either the converted value `U` or an error.
```

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

### Foreground Color Methods

Source: https://docs.rs/deadnix/1.3.1/deadnix/struct.Settings.html

Methods to set the foreground color of the text.

```APIDOC
## fn bright_black()

### Description
Returns `self` with the `fg()` set to [`Color :: BrightBlack`].

### Method
(Implicitly called on a `Painted` object)

### Example
```rust
println!("{}", value.bright_black());
```
```

```APIDOC
## fn bright_red()

### Description
Returns `self` with the `fg()` set to [`Color :: BrightRed`].

### Method
(Implicitly called on a `Painted` object)

### Example
```rust
println!("{}", value.bright_red());
```
```

```APIDOC
## fn bright_green()

### Description
Returns `self` with the `fg()` set to [`Color :: BrightGreen`].

### Method
(Implicitly called on a `Painted` object)

### Example
```rust
println!("{}", value.bright_green());
```
```

```APIDOC
## fn bright_yellow()

### Description
Returns `self` with the `fg()` set to [`Color :: BrightYellow`].

### Method
(Implicitly called on a `Painted` object)

### Example
```rust
println!("{}", value.bright_yellow());
```
```

```APIDOC
## fn bright_blue()

### Description
Returns `self` with the `fg()` set to [`Color :: BrightBlue`].

### Method
(Implicitly called on a `Painted` object)

### Example
```rust
println!("{}", value.bright_blue());
```
```

```APIDOC
## fn bright_magenta()

### Description
Returns `self` with the `fg()` set to [`Color :: BrightMagenta`].

### Method
(Implicitly called on a `Painted` object)

### Example
```rust
println!("{}", value.bright_magenta());
```
```

```APIDOC
## fn bright_cyan()

### Description
Returns `self` with the `fg()` set to [`Color :: BrightCyan`].

### Method
(Implicitly called on a `Painted` object)

### Example
```rust
println!("{}", value.bright_cyan());
```
```

```APIDOC
## fn bright_white()

### Description
Returns `self` with the `fg()` set to [`Color :: BrightWhite`].

### Method
(Implicitly called on a `Painted` object)

### Example
```rust
println!("{}", value.bright_white());
```
```
Tokens:
Raw