File: README.md

package info (click to toggle)
rust-voca-rs 1.15.2-1
  • links: PTS, VCS
  • area: main
  • in suites: sid, trixie
  • size: 2,152 kB
  • sloc: makefile: 4
file content (212 lines) | stat: -rw-r--r-- 11,042 bytes parent folder | download 
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
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
 
# voca_rs

[![Crates version](https://img.shields.io/crates/v/voca_rs.svg)](https://crates.io/crates/voca_rs)
[![dependency status](https://deps.rs/crate/voca_rs/1.15.2/status.svg)](https://deps.rs/crate/voca_rs/1.15.2)
[![Build Status](https://app.travis-ci.com/a-merezhanyi/voca_rs.svg?branch=master)](https://app.travis-ci.com/a-merezhanyi/voca_rs)
[![codecov](https://codecov.io/gh/a-merezhanyi/voca_rs/branch/master/graph/badge.svg?token=uSEi0L8ivo)](https://codecov.io/gh/a-merezhanyi/voca_rs)
[![license](https://img.shields.io/badge/license-MIT-green.svg)](LICENSE)

**Voca_rs is a Rust library for manipulating [unicode] strings.**

Voca_rs is implemented on Foreign Types, i.e. `String` and `str`. Respects Unicode.

Voca_rs is inspired by [Voca.js](https://vocajs.com/) (JavaScript), [string.py](https://docs.python.org/3.4/library/string.html) (Python), [Inflector](https://github.com/whatisinternet/inflector) (Rust), and [Grafite](https://docs.grafite.ca/utilities/helpers/) (PHP).

## TL;DR

Using functions:

```rust
use voca_rs::*;

let input_string = "LazyLoad with XMLHttpRequest and snake_case";
let string_in_words = split::words(&input_string);
// => ["Lazy", "Load", "with", "XML", "Http", "Request", "and", "snake", "case"]
let words_in_string = &string_in_words.join(" ");
// => "Lazy Load with XML Http Request and snake case"
let truncated_string = chop::prune(&words_in_string, 21, "");
// => "Lazy Load with XML..."
let sliced_string = chop::slice(&truncated_string, 5, -2);
// => "Load with XML."
let snaked_string = case::snake_case(&sliced_string);
// => "load_with_xml"
```

Using traits (all methods start from the underscore symbol):

```rust
use voca_rs::Voca;

"LazyLoad with XMLHttpRequest and snake_case"
._words()
// => ["Lazy", "Load", "with", "XML", "Http", "Request", "and", "snake", "case"]
.join(" ")
// => "Lazy Load with XML Http Request and snake case"
._prune(21, "")
// => "Lazy Load with XML..."
._slice(5, -2)
// => "Load with XML."
._snake_case();
// => "load_with_xml"
```

## Documentation

See the complete documentation at <https://docs.rs/voca_rs/>

Run tests: `cargo test`<br>
Build docs: `cargo doc` -> `./target/doc/voca_rs/index.html` <br>
Build a project: `cargo build` -> `./target/debug`

## Functions

### Case

- [camel_case](https://docs.rs/voca_rs/*/voca_rs/case/fn.camel_case.html)
- [capitalize](https://docs.rs/voca_rs/*/voca_rs/case/fn.capitalize.html)
- [decapitalize](https://docs.rs/voca_rs/*/voca_rs/case/fn.decapitalize.html)
- [kebab_case](https://docs.rs/voca_rs/*/voca_rs/case/fn.kebab_case.html)
- [lower_case](https://docs.rs/voca_rs/*/voca_rs/case/fn.lower_case.html)
- [lower_first](https://docs.rs/voca_rs/*/voca_rs/case/fn.lower_first.html)
- [pascal_case](https://docs.rs/voca_rs/*/voca_rs/case/fn.pascal_case.html)
- [shouty_kebab_case](https://docs.rs/voca_rs/*/voca_rs/case/fn.shouty_kebab_case.html)
- [shouty_snake_case](https://docs.rs/voca_rs/*/voca_rs/case/fn.shouty_snake_case.html)
- [snake_case](https://docs.rs/voca_rs/*/voca_rs/case/fn.snake_case.html)
- [swap_case](https://docs.rs/voca_rs/*/voca_rs/case/fn.swap_case.html)
- [title_case](https://docs.rs/voca_rs/*/voca_rs/case/fn.title_case.html)
- [train_case](https://docs.rs/voca_rs/*/voca_rs/case/fn.train_case.html)
- [upper_case](https://docs.rs/voca_rs/*/voca_rs/case/fn.upper_case.html)
- [upper_first](https://docs.rs/voca_rs/*/voca_rs/case/fn.upper_first.html)

### Chop

- [after](https://docs.rs/voca_rs/*/voca_rs/chop/fn.after.html)
- [after_last](https://docs.rs/voca_rs/*/voca_rs/chop/fn.after_last.html)
- [before](https://docs.rs/voca_rs/*/voca_rs/chop/fn.before.html)
- [before_last](https://docs.rs/voca_rs/*/voca_rs/chop/fn.before_last.html)
- [char_at](https://docs.rs/voca_rs/*/voca_rs/chop/fn.char_at.html)
- [code_point_at](https://docs.rs/voca_rs/*/voca_rs/chop/fn.code_point_at.html)
- [first](https://docs.rs/voca_rs/*/voca_rs/chop/fn.first.html)
- [foreign_key](https://docs.rs/voca_rs/*/voca_rs/case/fn.foreign_key.html)
- [grapheme_at](https://docs.rs/voca_rs/*/voca_rs/chop/fn.grapheme_at.html)
- [last](https://docs.rs/voca_rs/*/voca_rs/chop/fn.last.html)
- [limit_words](https://docs.rs/voca_rs/*/voca_rs/chop/fn.limit_words.html)
- [max](https://docs.rs/voca_rs/*/voca_rs/chop/fn.max.html)
- [min](https://docs.rs/voca_rs/*/voca_rs/chop/fn.min.html)
- [prune](https://docs.rs/voca_rs/*/voca_rs/chop/fn.prune.html)
- [removeprefix](https://docs.rs/voca_rs/*/voca_rs/chop/fn.removeprefix.html)
- [removesuffix](https://docs.rs/voca_rs/*/voca_rs/chop/fn.removesuffix.html)
- [slice](https://docs.rs/voca_rs/*/voca_rs/chop/fn.slice.html)
- [substr](https://docs.rs/voca_rs/*/voca_rs/chop/fn.substr.html)
- [substring](https://docs.rs/voca_rs/*/voca_rs/chop/fn.substring.html)
- [truncate](https://docs.rs/voca_rs/*/voca_rs/chop/fn.truncate.html)

### Count

- [count](https://docs.rs/voca_rs/*/voca_rs/count/fn.count.html)
- [count_graphemes](https://docs.rs/voca_rs/*/voca_rs/count/fn.count_graphemes.html)
- [count_substrings](https://docs.rs/voca_rs/*/voca_rs/count/fn.count_substrings.html)
- [count_unique_words](https://docs.rs/voca_rs/*/voca_rs/count/fn.count_unique_words.html)
- [count_where](https://docs.rs/voca_rs/*/voca_rs/count/fn.count_where.html)
- [count_words](https://docs.rs/voca_rs/*/voca_rs/count/fn.count_words.html)

### Escape

- [escape_html](https://docs.rs/voca_rs/*/voca_rs/escape/fn.escape_html.html)
- [escape_regexp](https://docs.rs/voca_rs/*/voca_rs/escape/fn.escape_regexp.html)
- [unescape_html](https://docs.rs/voca_rs/*/voca_rs/escape/fn.unescape_html.html)

### Index

- [index_all](https://docs.rs/voca_rs/*/voca_rs/index/fn.index_all.html)
- [index_of](https://docs.rs/voca_rs/*/voca_rs/index/fn.index_of.html)
- [last_index_of](https://docs.rs/voca_rs/*/voca_rs/index/fn.last_index_of.html)
- [search](https://docs.rs/voca_rs/*/voca_rs/index/fn.search.html)

### Manipulate

- [expand_spaces](https://docs.rs/voca_rs/*/voca_rs/manipulate/fn.expand_spaces.html)
- [expand_tabs](https://docs.rs/voca_rs/*/voca_rs/manipulate/fn.expand_tabs.html)
- [finish](https://docs.rs/voca_rs/*/voca_rs/manipulate/fn.finish.html)
- [insert](https://docs.rs/voca_rs/*/voca_rs/manipulate/fn.insert.html)
- [latinise](https://docs.rs/voca_rs/*/voca_rs/manipulate/fn.latinise.html)
- [pad](https://docs.rs/voca_rs/*/voca_rs/manipulate/fn.pad.html)
- [pad_left](https://docs.rs/voca_rs/*/voca_rs/manipulate/fn.pad_left.html)
- [pad_right](https://docs.rs/voca_rs/*/voca_rs/manipulate/fn.pad_right.html)
- [repeat](https://docs.rs/voca_rs/*/voca_rs/manipulate/fn.repeat.html)
- [replace](https://docs.rs/voca_rs/*/voca_rs/manipulate/fn.replace.html)
- [replace_all](https://docs.rs/voca_rs/*/voca_rs/manipulate/fn.replace_all.html)
- [reverse](https://docs.rs/voca_rs/*/voca_rs/manipulate/fn.reverse.html)
- [reverse_grapheme](https://docs.rs/voca_rs/*/voca_rs/manipulate/fn.reverse_grapheme.html)
- [slugify](https://docs.rs/voca_rs/*/voca_rs/manipulate/fn.slugify.html)
- [splice](https://docs.rs/voca_rs/*/voca_rs/manipulate/fn.splice.html)
- [start](https://docs.rs/voca_rs/*/voca_rs/manipulate/fn.start.html)
- [tr](https://docs.rs/voca_rs/*/voca_rs/manipulate/fn.tr.html)
- [trim](https://docs.rs/voca_rs/*/voca_rs/manipulate/fn.trim.html)
- [trim_left](https://docs.rs/voca_rs/*/voca_rs/manipulate/fn.trim_left.html)
- [trim_right](https://docs.rs/voca_rs/*/voca_rs/manipulate/fn.trim_right.html)
- [word_wrap](https://docs.rs/voca_rs/*/voca_rs/manipulate/fn.word_wrap.html)
- [zfill](https://docs.rs/voca_rs/*/voca_rs/manipulate/fn.zfill.html)

### Query

- [ends_with](https://docs.rs/voca_rs/*/voca_rs/query/fn.ends_with.html)
- [includes](https://docs.rs/voca_rs/*/voca_rs/query/fn.includes.html)
- [is_alpha](https://docs.rs/voca_rs/*/voca_rs/query/fn.is_alpha.html)
- [is_alphadigit](https://docs.rs/voca_rs/*/voca_rs/query/fn.is_alphadigit.html)
- [is_blank](https://docs.rs/voca_rs/*/voca_rs/query/fn.is_blank.html)
- [is_camel_case](https://docs.rs/voca_rs/*/voca_rs/query/fn.is_camel_case.html)
- [is_capitalize](https://docs.rs/voca_rs/*/voca_rs/query/fn.is_capitalize.html)
- [is_decapitalize](https://docs.rs/voca_rs/*/voca_rs/query/fn.is_decapitalize.html)
- [is_digit](https://docs.rs/voca_rs/*/voca_rs/query/fn.is_digit.html)
- [is_empty](https://docs.rs/voca_rs/*/voca_rs/query/fn.is_empty.html)
- [is_foreign_key](https://docs.rs/voca_rs/*/voca_rs/query/fn.is_foreign_key.html)
- [is_lowercase](https://docs.rs/voca_rs/*/voca_rs/query/fn.is_lowercase.html)
- [is_lower_first](https://docs.rs/voca_rs/*/voca_rs/query/fn.is_lower_first.html)
- [is_kebab_case](https://docs.rs/voca_rs/*/voca_rs/query/fn.is_kebab_case.html)
- [is_shouty_kebab_case](https://docs.rs/voca_rs/*/voca_rs/query/fn.is_shouty_kebab_case.html)
- [is_numeric](https://docs.rs/voca_rs/*/voca_rs/query/fn.is_numeric.html)
- [is_pascal_case](https://docs.rs/voca_rs/*/voca_rs/query/fn.is_pascal_case.html)
- [is_snake_case](https://docs.rs/voca_rs/*/voca_rs/query/fn.is_snake_case.html)
- [is_shouty_snake_case](https://docs.rs/voca_rs/*/voca_rs/query/fn.is_shouty_snake_case.html)
- [is_title](https://docs.rs/voca_rs/*/voca_rs/query/fn.is_title.html)
- [is_train_case](https://docs.rs/voca_rs/*/voca_rs/query/fn.is_train_case.html)
- [is_uppercase](https://docs.rs/voca_rs/*/voca_rs/query/fn.is_uppercase.html)
- [is_upper_first](https://docs.rs/voca_rs/*/voca_rs/query/fn.is_upper_first.html)
- [matches](https://docs.rs/voca_rs/*/voca_rs/query/fn.matches.html)
- [query](https://docs.rs/voca_rs/*/voca_rs/query/fn.query.html)
- [starts_with](https://docs.rs/voca_rs/*/voca_rs/query/fn.starts_with.html)

### Split

- [chars](https://docs.rs/voca_rs/*/voca_rs/split/fn.chars.html)
- [code_points](https://docs.rs/voca_rs/*/voca_rs/split/fn.code_points.html)
- [graphemes](https://docs.rs/voca_rs/*/voca_rs/split/fn.graphemes.html)
- [split](https://docs.rs/voca_rs/*/voca_rs/split/fn.split.html)
- [words](https://docs.rs/voca_rs/*/voca_rs/split/fn.words.html)

### Strip

- [strip_bom](https://docs.rs/voca_rs/*/voca_rs/strip/fn.strip_bom.html)
- [strip_tags](https://docs.rs/voca_rs/*/voca_rs/strip/fn.strip_tags.html)

### Utils

- [ASCII_LETTERS](https://docs.rs/voca_rs/*/voca_rs/utils/constant.ASCII_LETTERS.html)
- [ASCII_LOWERCASE](https://docs.rs/voca_rs/*/voca_rs/utils/constant.ASCII_LOWERCASE.html)
- [ASCII_UPPERCASE](https://docs.rs/voca_rs/*/voca_rs/utils/constant.ASCII_UPPERCASE.html)
- [DIGITS](https://docs.rs/voca_rs/*/voca_rs/utils/constant.DIGITS.html)
- [HEXDIGITS](https://docs.rs/voca_rs/*/voca_rs/utils/constant.HEXDIGITS.html)
- [OCTDIGITS](https://docs.rs/voca_rs/*/voca_rs/utils/constant.OCTDIGITS.html)
- [PUNCTUATION](https://docs.rs/voca_rs/*/voca_rs/utils/constant.PUNCTUATION.html)
- [PRINTABLE](https://docs.rs/voca_rs/*/voca_rs/utils/constant.PRINTABLE.html)
- [WHITESPACE](https://docs.rs/voca_rs/*/voca_rs/utils/constant.WHITESPACE.html)
- [VERSION](https://docs.rs/voca_rs/*/voca_rs/utils/constant.VERSION.html)

## Copyright

Coded by A. Merezhanyi

## License

Licensed under [MIT License](LICENSE.md)