spanley 1.1.0

This is my generic string span, his name is Spanley.
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
121
122
123
124
125
126
127
128
129
130
131
132
133

# Spanley

This is a generic string span library,
it is meant for use with tokenizing
applications or the likes.

Serde support and API changes
are coming soon.

Please do look into string interners
before deciding to use this crate
to make sure this actually fits your
use case.
String interning features may also
get added on later to this project, but that
is a much later spot on the roadmap.

# Example

## Input

```rust
use spanley::Span;

let message = "\
  This is my generic string span, his name is Spanley.\n\
  Say hi Spanley!\
";

let spanley = Span::new(message, 57, 11).unwrap();

println!("{}", spanley);
```

## Output

```text
hi Spanley!
```

# Features


# `location`

Adds the `SpanLocation` struct,
accessible through `spanley::SpanLocation`
or simply by calling one of the related
methods from `spanley::Span` directly.

`SpanLocation` gets the line and offset,
for possible logging applications.

## Example

### Input

```rust
use spanley::Span;

let message = "\
  This is my generic string span, his name is Spanley.\n\
  Say hi Spanley!\
";

let spanley = Span::new(message, 57, 11).unwrap();
let location = spanley.get_start_location();

println!("{}", location);
```

### Output

```text
1:4
```


# `location-column`

This can only be compiled in conjecture with
the `location` feature flag set to `true`.

Adds two relatively large extra dependencies,
[`unicode-width`] and
[`unicode-segmentation`]

This adds additional fields on the
`SpanLocation` struct;
`column_offset` and
`column_cjk_offset`,
which are calculated by the
[`unicode-width`] crate and the
[`unicode-segmentation`]
crate.

`column_offset` is then used instead
of `char_offset` in the [`Display`]
implementation for `SpanLocation`.

## Example

### Input

```rust
use spanley::Span;

let source = "👩‍👩‍👦‍👦👩‍👩‍👦‍👦👩‍👩‍👦‍👦";

// Additional context:
//
// '👩‍👩‍👦‍👦' spans 7 characters behind
// the scenes and 2 columns on a TUI.
// Hence, inputs divisible by 7 and
// Outputs divisible by 2.

let spanley = Span::new(source, 14, 7).unwrap();
let location = spanley.get_start_location();

println!("{}", location.column_offset());
println!("{}", location);
```

### Output

```text
4
0:4
```

[`unicode-width`]: https://crates.io/crates/unicode-width
[`unicode-segmentation`]: https://crates.io/crates/unicode-segmentation
[`display`]: https://doc.rust-lang.org/std/fmt/trait.Display.html