colprint 0.0.0

A lightweight macro for neatly printing data in aligned columns with automatic width calculation and customisable separators.
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120

# colprint

[![Crates.io](https://img.shields.io/crates/v/colprint.svg)](https://crates.io/crates/colprint)
[![Docs.rs](https://docs.rs/colprint/badge.svg)](https://docs.rs/colprint)
[![MIT License](https://img.shields.io/badge/license-MIT-blue.svg)](https://github.com/FreddyWordingham/colprint/blob/main/LICENSE)

A lightweight Rust library for neatly printing data in aligned columns with automatic width calculation and customizable separators.

## Features

- **Simple API**: Format complex data with an intuitive macro syntax
- **Automatic Width Calculation**: Columns automatically adjust to content size
- **Custom Column Widths**: Manually specify column widths when needed
- **Flexible Formatting**: Support for `Display`, `Debug`, and `PrettyDebug` formatters
- **Custom Separators**: Define any text as column separators
- **Multi-line Support**: Properly handles content with line breaks
- **Unicode Compatible**: Works correctly with multi-byte characters

## Installation

Add this to your `Cargo.toml`:

```toml
[dependencies]
colprint = "0.0.0"
```

## Usage

### Basic Usage

```rust
use colprint::colprint;

fn main() {
    let name = "Alice";
    let age = 30;

    // Basic display formatting
    colprint!("{} | {}", name, age);
}
```

```txt
Alice | 30
```

### Display vs Debug Formatting

The `colprint!` macro is most useful when printing complex (multi-line) data structures:

```rust
use colprint::colprint;

#[derive(Debug)]
struct Person {
    name: String,
    age: u32,
    country: String,
    job: String,
    hobby: String,
}

impl std::fmt::Display for Person {
    fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
        write!(
            f,
            "Name: {}\nAge: {}\nCountry: {}\nJob {}\nHobby {}",
            self.name, self.age, self.country, self.job, self.hobby
        )
    }
}

fn main() {
    let bob = Person {
        name: "Bob".to_string(),
        age: 25,
        country: "Canada".to_string(),
        job: "Data Scientist".to_string(),
        hobby: "Photography".to_string(),
    };
    let jessica = Person {
        name: "Jessica".to_string(),
        age: 28,
        country: "USA".to_string(),
        job: "Software Engineer".to_string(),
        hobby: "Hiking".to_string(),
    };

    colprint!("{}\t{}", bob, jessica);
}
```

```txt
Name: Bob         	Name: Jessica
Age: 25           	Age: 28
Country: Canada   	Country: USA
Job Data Scientist	Job Software Engineer
Hobby Photography 	Hobby Hiking
```

Also supports debug formatting:

```rust
    colprint!("{:#?}\t{:#?}", bob, jessica);
```

```txt
Person {                  	Person {
    name: "Bob",          	    name: "Jessica",
    age: 25,              	    age: 28,
    country: "Canada",    	    country: "USA",
    job: "Data Scientist",	    job: "Software Engineer",
    hobby: "Photography", 	    hobby: "Hiking",
}                         	}
```

## License

This project is licensed under the MIT License - see the LICENSE file for details.