Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/wanzenbug/xch
Create a small CLI programm to swap file contests atomically
https://github.com/wanzenbug/xch
cli filesystem utility
Last synced: 9 days ago
JSON representation
Create a small CLI programm to swap file contests atomically
- Host: GitHub
- URL: https://github.com/wanzenbug/xch
- Owner: WanzenBug
- License: mit
- Created: 2017-09-02T12:44:17.000Z (about 7 years ago)
- Default Branch: master
- Last Pushed: 2019-10-18T19:58:40.000Z (about 5 years ago)
- Last Synced: 2024-09-17T13:22:41.500Z (2 months ago)
- Topics: cli, filesystem, utility
- Language: Rust
- Size: 42 KB
- Stars: 5
- Watchers: 3
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
# xch
A Rust library and CLI program to exchange the content of paths. If possible, this try
to change contents atomically.
Current release: 1.1.0
***Note**: Currently only supports atomic exchange on Windows or on Linux using nightly rust*
## CLI
The program `xch` can be used to e**XCH**ange the content of two paths.
### Install
`cargo install xch`
### Usage
```
USAGE:
xch [FLAGS]
FLAGS:
-h, --help Prints help information
-n, --non-atomic Use non atomic exchange if atomic is not available
-V, --version Prints version information
ARGS:
One path to exchange
The other path to exchange
```
After the program call, `first/path` will point to the previous content of `second/path` and vice versa.
This not only works for files but also for directories or one file and a directory.
By default all changes are made atomically, you can never observe one change without the other (e.g.
if `first/path` points to the old content of `second/path`, `second/path` also points to the
old content of `first/path`). This only works on Windows and Linux.
On other platforms such as any BSD or MacOS, you always need to specify
`--non-atomic` to get results.
| platform | atomic xch | non-atomic xch |
|----------|--------------------|--------------------|
| windows | :heavy_check_mark: | :heavy_check_mark: |
| linux | :heavy_check_mark: | :heavy_check_mark: |
| others | :x: | :heavy_check_mark: |
## Crate
The functionality is also available as a crate. Add `xch = "1.1.0"` to your `Cargo.toml`.
Then you need to import the crate to your code
```Rust
use libxch;
```
Then you can start exchanging the content of files
```Rust
if let Err(e) = libxch::xch("file1", "path/to/file2") {
// Error handling here
}
```
This is is the equivalent of running `xch` in default mode, i.e. it only works on Windows and Linux.
use `libxch::xch_non_atomic("file1", "path/to/file2")` to get a portable, but non-atomic exchange.
[Documentation](https://docs.rs/xch)
## License
Licensed under [MIT license](./LICENSE)
## Future
Here are some missing features that will hopefully be added in the future:
- MacOS atomic exchange using the `ExchangeData` syscall.
- Better error messages
- More options.
#### Please feel free to open an issue if you have a specific request