qfile 2.0.0

Crate for accessing a file by path, case insensitive. Automatic detection, create a path with a new file or open an existing file
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
134
135
136
137
138
139


[![Crate](https://img.shields.io/crates/v/qfile?color=green)](https://crates.io/crates/qfile)
[![Docs](https://img.shields.io/docsrs/qfile)](https://docs.rs/qfile/latest/qfile/)

 # Qfile

 Crate for accessing a file by path, case insensitive. Automatic detection, create a path with a new file or open an existing file.

 # Examples
```rust
    // add_path() - constructor for adding a file path. 
    // the real file path: `./FOLDER/folder/File.txt`
    let mut file = QFilePath::add_path("./folder/folder/file.txt");
    // after using auto_write() or read() methods, and if Ok(),
    // we get/save the correct path after the first method call, 
    // which will be used as a cache when used again.
    file.auto_write("text_1").unwrap();
    // we get the saved path from the cache
    file.auto_write("text_2").unwrap();
    assert_eq!(file.read().unwrap(), "text_1text_2");
  
```

```rust
    use qfile::*;
    use std::io::BufReader;
    use std::io::Read;
    // The file already exists
    // The real file path: "./My_First_Folder/New_File.txt"
    // File content: Hello World
    let file = QFilePath::add_path("my_first_Folder/new_file.txt").get_file(Permissions::RW).unwrap();
    let mut buffer = Vec::new();
    // Read file into vector.
    BufReader::new(file).read_to_end(&mut buffer).unwrap();
    // Show result
    assert_eq!(
        buffer,
        vec![72, 101, 108, 108, 111, 32, 87, 111, 114, 108, 100]
    )
```

---

# Paths syntax

### Linux 
  
  > `folder/folder/file.txt`\
  > `./folder/folder/file.txt`

```rust
    let path1 = "File.txt";
    let path2 = "./File.txt";
    let path3 = "../../File.txt";
    let path4 = String::from("Folder/Folder/File.txt");
```

### Windows 
  
  > `folder\\folder\\file.txt`\
  > `.\\folder\\folder\\file.txt`\
  > `D:\\folder\\folder\\file.txt`

```rust
    let path1 = "File.txt";
    let path2 = ".\\File.txt";
    let path3 = "..\\..\\File.txt";
    let path4 = "D:\\Folder\\file.txt";
    let path5 = r"D:\Folder\file.txt";
    let path6 = String::from("D:\\Folder\\file.txt");
```

# Auto Mode

Creates or opens if a file exists (case insensitive)

### Example
```rust
    let mut file = QFilePath::add_path("./file.txt");
    file.auto_write("ok").unwrap();
    //=========
    //*code*
    //=========
    file.auto_write("ok").unwrap();
    assert_eq(file.read().unwrap(),"okok");
    
```

---

 ### Linux & Windows

 - If the path exists, we work with the file


 |                            |                              |
 | -------------------------- | ---------------------------- |
 | **The path we specified**: | `folder1/FolDER2/file.TXT`   |
 | **Real path** :            | `./Folder1/Folder2/file.txt` |
 | **Result** :               | `./Folder1/Folder2/file.txt` |

 - If the file/path is not found, creates a new path with the file (*if initial path exists*)

 |                            |                                |
 | -------------------------- | ------------------------------ |
 | **The path we specified**: | `./folder/folder_new/file.txt` |
 | **Real path** :            | `./folder`                     |
 | **Result** :               | `./folder/folder_new/file.txt` |
 
 - But if the initial path is different case of letters and a new file/folder is specified in the path, then a new path is created with the file

 ### Linux :

 |                            |                                                         |
 | -------------------------- | ------------------------------------------------------- |
 | **The path we specified**: | `./FOLDER/Folder_new/file.txt`                          |
 | **Real path** :            | `./folder`                                              |
 | **Result** :               | `./FOLDER/Folder_new/file.txt` - (**new created path**) |
 |                            | `./folder` - (**original path**)                        |

 ### Windows :

 |                            |                                                  |
 | -------------------------- | ------------------------------------------------ |
 | **The path we specified**: | `./FOLDER/Folder_new/file.txt`                   |
 | **Real path** :            | `./folder`                                       |
 | **Result** :               | `./folder/Folder_new/file.txt` - (**real path**) |

 ### Different behavior 

 > * The Windows file system treats file and directory names as **case insensitive**. `file.txt` and `FILE.txt` will be treated as equivalent files (Although the path is case insensitive in windows, you can return a case-sensitive path with : `get_path_str()` or `get_path_buf()`).
 > * The Linux file system treats file and directory names as **case-sensitive**. `file.txt` and `FILE.txt` will be treated as different files.

 ---

 # Changelog
 [List](https://github.com/m62624/qfile/blob/main/CHANGELOG.md)
 # License
 [MIT](https://choosealicense.com/licenses/mit/)