# PyInRs
_A Rust type library that is as easy to use as Python built-in types._
### 1. Attribute
- Name: PyInRs.
- Language: Rust, requires version rustc >= `1.75.0`.
- Goal: Write a Rust type library that is as easy to use as Python built-in types.
- Module: List, Set, Dict, Int, Str, Tuple, Deque, Fraction
- Style: Follow Rust's official recommended style.
- Test: Using [rstest](https://github.com/la10736/rstest) for unit testing and ensure that all tests passed.
- Security: There is no `unsafe` code block.
- Document: Using `cargo doc --open` to open documents.
- Run: Using `cargo run` to build and run all tests.
### 2. Feature
- Simple: Stay simple, stay young. While ensuring usability and robustness, try to be concise and easy to maintain and read.
- Friendly: Provides many convenient functions. For example, `Str` class provides replace, split, find and other operations like Python's str, and `List` class and `Str` class both support negative subscript like Python.
- Robust: There are corresponding checks for the addition, deletion, modification, and inspection of containers. Checking will have an impact on performance, but this library is not pursuing performance, but simplicity, usability, and robustness.
- Elegance: With my careful design, it can be used as conveniently as Python's built-in types. Very Pythonic.
### 3. Usage
To use it, add the following lines to your `Cargo.toml` file:
```toml
[dependencies]
pyinrs = "0"
```
There are a total of 8 classes (in plan), refer to the 8 commonly used classes in Python:
| `List<T>` | `list` | √ |
| `Set<T>` | `set` | √ |
| `Dict<K, V>` | `dict` | |
| `Int` | `int` | |
| `Str` | `str` | √ |
| `Tuple<Ts...>` | `tuple` | |
| `Deque<T>` | `collections.deque` | √ |
| `Fraction` | `fractions.Fraction` | √ |
Some simple examples:
```rust
use pyinrs::*;
// List index, supports negative subscript
List::from([1, 2, 3, 4, 5])[-1] // 5
// List uniquify
List::from([1, 2, 3, 1, 2, 3, 1, 2, 3]).uniquify() // [1, 2, 3]
// Adding elements to Set
Set::from([1, 2, 3, 4]).add(5) // {1, 2, 3, 4, 5}
// Intersection of Sets, supports intersection, union, difference, and symmetric difference
Set::from([1, 2, 3, 4, 5]) & Set::from([1, 3, 5, 7, 9]) // {1, 3, 5}
// Str split
Str::from("one, two, three").split(", ") // ["one", "two", "three"]
// Str join
Str::from(".").join(["192", "168", "0", "1"].into()) // "192.168.0.1"
// Deque push back, supports both back and front push, pop, and element reference
Deque::from([1, 2, 3, 4]).push_back(5) // <1, 2, 3, 4, 5>
// Deque shifts to right (or left), very vivid!
Deque::from([1, 2, 3, 4, 5]) >>= 1 // <5, 1, 2, 3, 4>
// Fraction addition
Fraction::from((1, 2)) + Fraction::from((1, 3)) // 5/6
// Fraction modulo
Fraction::from((1, 2)) % Fraction::from((1, 3)) // 1/6
```