josa 0.1.0

Korean language josa selector
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

# Josa
> Idiomatic [josa](https://en.wikipedia.org/wiki/Korean_postpositions) selector.

![crates.io version][version] ![crates.io license][license] ![crates.io download][download]

Josa is a [Rust] library to select appropriate josas for korean language.

## Overview
### Method
Josa is an [extension trait] implemented for [`String`] type.
Its API works just like [`push_str`] method on [`String`].

```rust
use josa::JosaExt;
use josa::Josa::{EunNeun, IGa};

let mut user = "유진".to_owned();
let mut mackerel = "고등어".to_owned();

user.push_josa(EunNeun);
mackerel.push_josa(IGa);

let sentence = format!("{} {} 먹고싶다", user, mackerel);

assert_eq!(sentence, "유진은 고등어가 먹고싶다");
```

> :warning: Like [`push_str`] does, `push_josa` expects [`String`], not [`str`], as its argument.

### `+`, `+=` Operator
You can use `+`, `+=` operator to append josa.

```rust
use josa::Josa::{EunNeun, IGa};

let user = "유진".to_owned();
let mackerel = "고등어".to_owned();

let sentence = format!("{} {} 먹고싶다", user + EunNeun, mackerel + IGa);

assert_eq!(sentence, "유진은 고등어가 먹고싶다");
```

## Usage
Add `josa` as a dependency in your `Cargo.toml`.

```toml
[dependencies]
josa = "0.1.0"
```

then import [`JosaExt`](trait.JosaExt.html) trait in your code:

```rust
use josa::JosaExt;
```

Now you can use methods on [`String`].
```rust
use josa::JosaExt;
// 🔥 here..
```

## Documentation
See [docs.rs][documentation]

## Roadmap
### `select` method
Sometimes you don't want to mutate your String. For that case, we will provide pure function `select` which returns appropriate josa for given noun.

```rust
fn select(noun: &str, josa: Josa) -> &str
```

### `select` macro
As soon as [hygiene 2.0 (#54727)][hygiene] arrives stable, we will add support for following macro:

```rust
select!("{}{은} {}{가} 먹고싶다", user, mackerel);
```

which is more clear compared to current syntax:

### Hangul enum variants
As soon as [non-ASCII identifiers (#55467)][ident] arrives stable, we will change the names of josas to Hangul:

```rust
format!("{} {} 먹고싶다", user + 은는, mackerel + 이가);
```

## License
Distributed under the MIT license.


[version]: https://img.shields.io/crates/v/josa
[license]: https://img.shields.io/crates/l/josa
[download]: https://img.shields.io/crates/d/josa

[Rust]: https://rust-lang.org
[extension trait]: https://github.com/rust-lang/rfcs/blob/master/text/0445-extension-trait-conventions.md
[`String`]: https://doc.rust-lang.org/std/string/struct.String.html
[`str`]: https://doc.rust-lang.org/std/primitive.str.html
[`push_str`]: https://doc.rust-lang.org/std/string/struct.String.html#method.push_str

[documentation]: https://docs.rs/josa

[hygiene]: https://github.com/rust-lang/rust/issues/54727
[ident]: https://github.com/rust-lang/rust/issues/55467