Box Drawing

https://docs.rs/box_drawing/0.1.2/
Admin
Box Drawing is a Rust crate that provides various modules for drawing different types of box...
Tokens:10,403
Snippets:31
Trust Score:9.7
Update:1 year ago
Show doc for...
Tokens:
Raw
### Box Drawing Crate Structure and Light Borders Example

Source: https://docs.rs/box_drawing/0.1.2/src/box_drawing/lib

This snippet outlines the structure of the box_drawing crate, including its modules for different border types. It also provides an example demonstrating the usage of light borders, specifically the DOWN_RIGHT, HORIZONTAL, and DOWN_LEFT characters to construct a top-left corner.

```Rust
1#[cfg(test)]
2mod tests;
3
4/// This module contains light borders
5/// #Example
6/// ```
7/// use box_drawing::light;
8/// let expected = "┌─┐";
9/// let actual = format!("{}{}{}", light::DOWN_RIGHT, light::HORIZONTAL, light::DOWN_LEFT);
10/// assert_eq!(expected, actual);
11/// ```
12pub mod light;
13
14/// This module contains heavy (bold) borders
15pub mod heavy;
16
17/// This module contains doubled borders
18pub mod double;
19
20/// Contains rounded corners
21pub mod arc;

```

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

### Rustdoc Keyboard Shortcuts

Source: https://docs.rs/box_drawing/0.1.2/help

This section details the keyboard shortcuts available in Rustdoc for navigating the documentation, focusing the search bar, and interacting with search results.

```Rustdoc
`?`
    Show this help dialog

`S` / `/`
    Focus the search field

`↑`
    Move up in search results

`↓`
    Move down in search results

`←` / `→`
    Switch result tab (when results focused)

`⏎`
    Go to active search result

`+`
    Expand all sections

`-`
    Collapse all sections

`_`
    Collapse all sections, including impl blocks
```

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

### Rust: Use Light Border Characters

Source: https://docs.rs/box_drawing/0.1.2/box_drawing/light/index

Demonstrates how to use light border characters from the box_drawing crate to construct a simple box. It shows the import statement and an assertion to verify the correct characters are used.

```Rust
use box_drawing::light;
let expected = "┌─┐";
let actual = format!("{}{}{}", light::DOWN_RIGHT, light::HORIZONTAL, light::DOWN_LEFT);
assert_eq!(expected, actual);
```

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

### Rustdoc Search Tricks

Source: https://docs.rs/box_drawing/0.1.2/help

This section outlines advanced search functionalities in Rustdoc, allowing users to filter searches by item kind, type signature, exact names, slices/arrays, and paths.

```Rustdoc
Prefix searches with a type followed by a colon (e.g., `fn:`) to restrict the search to a given item kind.
Accepted kinds are: `fn`, `mod`, `struct`, `enum`, `trait`, `type`, `macro`, and `const`.
Search functions by type signature (e.g., `vec -> usize` or `-> vec` or `String, enum:Cow -> bool`)
You can look for items with an exact name by putting double quotes around your request: `"string"`
Look for functions that accept or return slices and arrays by writing square brackets (e.g., `-> [u8]` or `[] -> Option`)
Look for items inside another one by searching for a path: `vec::Vec`
```

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

### Box Drawing - Light Borders

Source: https://docs.rs/box_drawing/0.1.2/index

Provides functionality for creating light borders using box drawing characters. This module is part of the box_drawing crate.

```Rust
# Example
// This is a placeholder for actual code examples that would demonstrate the usage of the light module.
```

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

### Box Drawing - Light Borders

Source: https://docs.rs/box_drawing/0.1.2/box_drawing

Provides functionality for creating light borders using box drawing characters. This module is part of the box_drawing crate.

```Rust
# Example
// This is a placeholder for actual code examples that would demonstrate the usage of the light module.
```

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

### Box Drawing - Light Borders

Source: https://docs.rs/box_drawing/0.1.2/box_drawing/index

Provides functionality for creating light borders using box drawing characters. This module is part of the box_drawing crate.

```Rust
# Example
// This is a placeholder for actual code examples that would demonstrate the usage of the light module.
```

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

### Box Drawing Constants - Light Line

Source: https://docs.rs/box_drawing/0.1.2/box_drawing/all

Lists constants for light-line box drawing characters, providing basic line segments and corner pieces.

```Rust
const DOWN_HORIZONTAL: &str;
const DOWN_LEFT: &str;
const DOWN_RIGHT: &str;
const HORIZONTAL: &str;
const UP_HORIZONTAL: &str;
const UP_LEFT: &str;
const UP_RIGHT: &str;
const VERTICAL: &str;
const VERTICAL_HORIZONTAL: &str;
const VERTICAL_LEFT: &str;
const VERTICAL_RIGHT: &str;
```

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

### Box Drawing - Heavy Borders

Source: https://docs.rs/box_drawing/0.1.2/index

Provides functionality for creating heavy (bold) borders using box drawing characters. This module is part of the box_drawing crate.

```Rust
# Example
// This is a placeholder for actual code examples that would demonstrate the usage of the heavy module.
```

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

### Box Drawing - Heavy Borders

Source: https://docs.rs/box_drawing/0.1.2/box_drawing/index

Provides functionality for creating heavy (bold) borders using box drawing characters. This module is part of the box_drawing crate.

```Rust
# Example
// This is a placeholder for actual code examples that would demonstrate the usage of the heavy module.
```

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

### Box Drawing - Heavy Borders

Source: https://docs.rs/box_drawing/0.1.2/box_drawing

Provides functionality for creating heavy (bold) borders using box drawing characters. This module is part of the box_drawing crate.

```Rust
# Example
// This is a placeholder for actual code examples that would demonstrate the usage of the heavy module.
```

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

### Box Drawing - Double Borders

Source: https://docs.rs/box_drawing/0.1.2/index

Provides functionality for creating double borders using box drawing characters. This module is part of the box_drawing crate.

```Rust
# Example
// This is a placeholder for actual code examples that would demonstrate the usage of the double module.
```

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

### Box Drawing - Double Borders

Source: https://docs.rs/box_drawing/0.1.2/box_drawing

Provides functionality for creating double borders using box drawing characters. This module is part of the box_drawing crate.

```Rust
# Example
// This is a placeholder for actual code examples that would demonstrate the usage of the double module.
```

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

### Box Drawing - Rounded Corners

Source: https://docs.rs/box_drawing/0.1.2/index

Provides functionality for creating rounded corners using box drawing characters. This module is part of the box_drawing crate.

```Rust
# Example
// This is a placeholder for actual code examples that would demonstrate the usage of the arc module.
```

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

### Box Drawing - Double Borders

Source: https://docs.rs/box_drawing/0.1.2/box_drawing/index

Provides functionality for creating double borders using box drawing characters. This module is part of the box_drawing crate.

```Rust
# Example
// This is a placeholder for actual code examples that would demonstrate the usage of the double module.
```

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

### Define Box Drawing Characters in Rust

Source: https://docs.rs/box_drawing/0.1.2/src/box_drawing/light

This snippet defines constants for common box-drawing characters used in terminal UIs. These characters are essential for creating borders and layouts.

```Rust
pub const HORIZONTAL: &str = "─";
pub const VERTICAL: &str = "│";
pub const DOWN_RIGHT: &str = "┌";
pub const DOWN_LEFT: &str = "┐";
pub const UP_RIGHT: &str = "└";
pub const UP_LEFT: &str = "┘";
pub const VERTICAL_RIGHT: &str = "├";
pub const VERTICAL_LEFT: &str = "┤";
pub const DOWN_HORIZONTAL: &str = "┬";
pub const UP_HORIZONTAL: &str = "┴";
pub const VERTICAL_HORIZONTAL: &str = "┼";
```

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

### Box Drawing - Rounded Corners

Source: https://docs.rs/box_drawing/0.1.2/box_drawing

Provides functionality for creating rounded corners using box drawing characters. This module is part of the box_drawing crate.

```Rust
# Example
// This is a placeholder for actual code examples that would demonstrate the usage of the arc module.
```

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

### Box Drawing Constants (Rust)

Source: https://docs.rs/box_drawing/0.1.2/box_drawing/heavy/index

This snippet lists the constants available in the 'heavy' module for drawing bold borders. These constants represent different line segments and corners used in box-drawing characters.

```Rust
const DOWN_HORIZONTAL: char;
const DOWN_LEFT: char;
const DOWN_RIGHT: char;
const HORIZONTAL: char;
const UP_HORIZONTAL: char;
const UP_LEFT: char;
const UP_RIGHT: char;
const VERTICAL: char;
const VERTICAL_HORIZONTAL: char;
const VERTICAL_LEFT: char;
const VERTICAL_RIGHT: char;
```

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

### Box Drawing - Rounded Corners

Source: https://docs.rs/box_drawing/0.1.2/box_drawing/index

Provides functionality for creating rounded corners using box drawing characters. This module is part of the box_drawing crate.

```Rust
# Example
// This is a placeholder for actual code examples that would demonstrate the usage of the arc module.
```

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

### Box Drawing Constants - Double Line

Source: https://docs.rs/box_drawing/0.1.2/box_drawing/all

Lists constants for double-line box drawing characters, covering horizontal, vertical, and corner combinations.

```Rust
const DOWN_HORIZONTAL: &str;
const DOWN_LEFT: &str;
const DOWN_RIGHT: &str;
const HORIZONTAL: &str;
const UP_HORIZONTAL: &str;
const UP_LEFT: &str;
const UP_RIGHT: &str;
const VERTICAL: &str;
const VERTICAL_HORIZONTAL: &str;
const VERTICAL_LEFT: &str;
const VERTICAL_RIGHT: &str;
```

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

### Box Drawing Constants - Heavy Line

Source: https://docs.rs/box_drawing/0.1.2/box_drawing/all

Lists constants for heavy-line box drawing characters, including various line segments and corners.

```Rust
const DOWN_HORIZONTAL: &str;
const DOWN_LEFT: &str;
const DOWN_RIGHT: &str;
const HORIZONTAL: &str;
const UP_HORIZONTAL: &str;
const UP_LEFT: &str;
const UP_RIGHT: &str;
const VERTICAL: &str;
const VERTICAL_HORIZONTAL: &str;
const VERTICAL_LEFT: &str;
const VERTICAL_RIGHT: &str;
```

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

### Box Drawing Constants - Arc

Source: https://docs.rs/box_drawing/0.1.2/box_drawing/all

Lists constants for arc-style box drawing characters, including directions like UP_LEFT, UP_RIGHT, DOWN_LEFT, and DOWN_RIGHT.

```Rust
const DOWN_LEFT: &str;
const DOWN_RIGHT: &str;
const UP_LEFT: &str;
const UP_RIGHT: &str;
```

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

### Box Drawing Constants (Rust)

Source: https://docs.rs/box_drawing/0.1.2/box_drawing/arc/index

Provides constants for drawing rounded corners in box-drawing characters. These are fundamental for creating graphical interfaces or text-based art.

```Rust
const DOWN_LEFT: &str;
const DOWN_RIGHT: &str;
const UP_LEFT: &str;
const UP_RIGHT: &str;
```

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

### Define Box Drawing Characters in Rust

Source: https://docs.rs/box_drawing/0.1.2/src/box_drawing/heavy

This snippet defines constants for common box-drawing characters used in terminal interfaces. These constants are implemented in Rust and can be directly used in projects requiring text-based graphical elements.

```Rust
pub const HORIZONTAL: &str = "━";
pub const VERTICAL: &str = "┃";
pub const DOWN_RIGHT: &str = "┏";
pub const DOWN_LEFT: &str = "┓";
pub const UP_RIGHT: &str = "┗";
pub const UP_LEFT: &str = "┛";
pub const VERTICAL_RIGHT: &str = "┣";
pub const VERTICAL_LEFT: &str = "┫";
pub const DOWN_HORIZONTAL: &str = "┳";
pub const UP_HORIZONTAL: &str = "┻";
pub const VERTICAL_HORIZONTAL: &str = "╋";
```

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

### Box Drawing Constant VERTICAL_RIGHT

Source: https://docs.rs/box_drawing/0.1.2/box_drawing/light/constant

Defines the constant VERTICAL_RIGHT for the box_drawing crate, representing the character '├' used in light-style box drawing.

```Rust
pub const VERTICAL_RIGHT: &str = "├";
```

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

### Define Box Drawing Constants in Rust

Source: https://docs.rs/box_drawing/0.1.2/src/box_drawing/arc

This snippet defines constants for common box-drawing characters used in terminal interfaces. These constants are part of the box_drawing crate and are typically used for creating visual borders and layouts.

```Rust
pub const DOWN_RIGHT: &str = "╭";
pub const DOWN_LEFT: &str = "╮";
pub const UP_LEFT: &str = "╯";
pub const UP_RIGHT: &str = "╰";
```

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

### Box Drawing Constants (Rust)

Source: https://docs.rs/box_drawing/0.1.2/box_drawing/double/index

This snippet lists constants provided by the 'double' module for creating doubled borders. These constants represent various combinations of horizontal and vertical lines, useful for drawing tables and interfaces in terminal applications.

```Rust
pub const DOWN_HORIZONTAL: &str = "╓";
pub const DOWN_LEFT: &str = "╙";
pub const DOWN_RIGHT: &str = "╖";
pub const HORIZONTAL: &str = "─";
pub const UP_HORIZONTAL: &str = "╙";
pub const UP_LEFT: &str = "╙";
pub const UP_RIGHT: &str = "╖";
pub const VERTICAL: &str = "│";
pub const VERTICAL_HORIZONTAL: &str = "╫";
pub const VERTICAL_LEFT: &str = "╢";
pub const VERTICAL_RIGHT: &str = "╟";
```

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

### Rust Box Drawing Characters

Source: https://docs.rs/box_drawing/0.1.2/src/box_drawing/double

Defines constants for common box-drawing characters used in terminal UIs. These include horizontal, vertical, corner, and junction characters.

```Rust
pub const HORIZONTAL: &str = "═";
pub const VERTICAL: &str = "║";
pub const DOWN_RIGHT: &str = "╔";
pub const DOWN_LEFT: &str = "╗";
pub const UP_RIGHT: &str = "╚";
pub const UP_LEFT: &str = "╝";
pub const VERTICAL_RIGHT: &str = "╠";
pub const VERTICAL_LEFT: &str = "╣";
pub const DOWN_HORIZONTAL: &str = "╦";
pub const UP_HORIZONTAL: &str = "╩";
pub const VERTICAL_HORIZONTAL: &str = "╬";
```

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

### Rust Box Drawing Constant VERTICAL_LEFT

Source: https://docs.rs/box_drawing/0.1.2/box_drawing/double/constant

Defines the constant VERTICAL_LEFT for box drawing, representing a character with a vertical line on the left and a horizontal line extending to the right. This is part of the 'double' module in the box_drawing crate.

```Rust
pub const VERTICAL_LEFT: &str = "╣";
```

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

### Define UP_RIGHT Constant in Rust

Source: https://docs.rs/box_drawing/0.1.2/box_drawing/arc/constant

This snippet defines the UP_RIGHT constant for the box_drawing crate, which represents the character used for the top-right corner of a box drawing.

```Rust
pub const UP_RIGHT: &str = "╰";
```

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

### Define VERTICAL_RIGHT Constant in box_drawing::heavy

Source: https://docs.rs/box_drawing/0.1.2/box_drawing/heavy/constant

Defines the VERTICAL_RIGHT constant, which represents a character used for drawing box elements. This constant is part of the 'heavy' module within the box_drawing crate.

```Rust
pub const VERTICAL_RIGHT: &str = "┣";
```
Tokens:
Raw