line-column 0.3.0

Simple calculate lines and columns of str index
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

Simple calculate lines and columns of str index

Use LF (0x0A) to split newline, also compatible with CRLF (0x0D 0x0A)

Newline char line number is current line

For `index` and `char_index`:

- When index exceeds the string length, return string length
- When `column` exceeds the newline char, return the index of the newline char
- When `column` by zero, return previous char index

**NOTE**:
This crate is lightweight and simple calculations.
For high-performance and frequent calculations, please use line-index crate.

# Examples

**Byte index to line number**:

```rust
use line_column::line_column;

assert_eq!(line_column("", 0),       (1, 1));
assert_eq!(line_column("a", 0),      (1, 1));
assert_eq!(line_column("a", 1),      (1, 2));
assert_eq!(line_column("ab", 1),     (1, 2));
assert_eq!(line_column("a\n", 1),    (1, 2));
assert_eq!(line_column("a\n", 2),    (2, 1));
assert_eq!(line_column("a\nb", 2),   (2, 1));
assert_eq!(line_column("a\r\nb", 2), (1, 3));
assert_eq!(line_column("a\r\nb", 3), (2, 1));
```

**Character index to line number**:

```rust
use line_column::char_line_column;

assert_eq!(char_line_column("", 0),         (1, 1));
assert_eq!(char_line_column("a", 0),        (1, 1));
assert_eq!(char_line_column("a", 1),        (1, 2));
assert_eq!(char_line_column("ab", 1),       (1, 2));
assert_eq!(char_line_column("😀\n", 1),     (1, 2));
assert_eq!(char_line_column("😀\n", 2),     (2, 1));
assert_eq!(char_line_column("😀\n❓", 2),   (2, 1));
assert_eq!(char_line_column("😀\n❓", 2),   (2, 1));
```

**Line number to byte index**:

```rust
use line_column::index;

assert_eq!(index("", 1, 1),             0);
assert_eq!(index("a", 1, 1),            0);
assert_eq!(index("a", 1, 2),            1);
assert_eq!(index("a\n", 1, 2),          1);
assert_eq!(index("a\n", 2, 1),          2);
assert_eq!(index("a\nx", 2, 2),         3);
assert_eq!(index("你好\n世界", 1, 2),   3); // byte index
assert_eq!(index("你好\n世界", 1, 3),   6);
assert_eq!(index("你好\n世界", 2, 1),   7);
```

**Line number to character index**:

```rust
use line_column::char_index;

assert_eq!(char_index("", 1, 1),            0);
assert_eq!(char_index("a", 1, 1),           0);
assert_eq!(char_index("你好\n世界", 1, 2),  1);
assert_eq!(char_index("你好\n世界", 1, 3),  2);
assert_eq!(char_index("你好\n世界", 2, 1),  3);
```

**The end of string is considered a character**:

```rust
use line_column::*;

assert_eq!(index("", 1, 1),             0);
assert_eq!(index("a", 1, 2),            1);
assert_eq!(char_index("", 1, 1),        0);
assert_eq!(char_index("a", 1, 2),       1);
assert_eq!(line_column("", 0),          (1, 1));
assert_eq!(line_column("a", 1),         (1, 2));
assert_eq!(char_line_column("", 0),     (1, 1));
assert_eq!(char_line_column("a", 1),    (1, 2));
```