https://github.com/limitcool/mod
https://github.com/limitcool/mod
Last synced: about 2 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/limitcool/mod
- Owner: limitcool
- Created: 2024-06-10T15:59:03.000Z (12 months ago)
- Default Branch: main
- Last Pushed: 2024-06-11T14:12:12.000Z (12 months ago)
- Last Synced: 2025-03-28T07:16:43.898Z (about 2 months ago)
- Language: Rust
- Size: 5.86 KB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README-en.md
Awesome Lists containing this project
README
# mod
English| [简体中文](README.md)
[](https://crates.io/crates/mod)
[](https://docs.rs/mod)
## Introduction
`mod` is a Rust project that provides two simple and useful utility functions for converting between `Option` and `Result` types. The project includes two main functions:
1. `option_to_result`: Converts an `Option` to a `Result`.
2. `result_to_option`: Converts a `Result` to an `Option`.
## Installation
You can add this project to your Rust project by running the following command:
```sh
cargo add mod
```
## Usage
First, ensure that you include the `mod` crate in your project:
```rust
use r#mod::{option_to_result, result_to_option};
```
### Function Descriptions
#### `option_to_result`
Converts an `Option` to a `Result`. If the `Option` is `Some`, it returns the value wrapped in `Ok`; if it is `None`, it returns the specified error.
```rust
pub fn option_to_result(option: Option, err: E) -> Result
where
E: Clone,
{
match option {
Some(value) => Ok(value),
None => Err(err),
}
}
```
**Example**:
```rust
let some_value = Some(42);
let none_value: Option = None;
let error = "Error";
assert_eq!(option_to_result(some_value, error.to_string()), Ok(42));
assert_eq!(option_to_result(none_value, error.to_string()), Err("Error".to_string()));
```
#### `result_to_option`
Converts a `Result` to an `Option`. If the `Result` is `Ok`, it returns the value wrapped in `Some`; if it is `Err`, it returns `None`.
```rust
pub fn result_to_option(result: Result) -> Option
where
E: Clone,
{
match result {
Ok(value) => Some(value),
Err(_) => None,
}
}
```
**Example**:
```rust
let ok_result = Ok::(42);
let err_result = Err::("Error");
assert_eq!(result_to_option(ok_result), Some(42));
assert_eq!(result_to_option(err_result), None);
```
## Testing
This project includes some unit tests to verify the correctness of the functionality. You can run the tests by executing the following command:
```sh
cargo test
```
The test cases are located in the `tests` module and cover the `option_to_result` and `result_to_option` functions:
```rust
#[cfg(test)]
mod tests {
use super::*;
#[test]
fn test_option_to_result() {
let some_value = Some(42);
let none_value: Option = None;
let error = "Error";
assert_eq!(option_to_result(some_value, error.to_string()), Ok(42));
assert_eq!(option_to_result(none_value, error.to_string()), Err("Error".to_string()));
}
#[test]
fn test_result_to_option() {
let ok_result = Ok::(42);
let err_result = Err::("Error");
assert_eq!(result_to_option(ok_result), Some(42));
assert_eq!(result_to_option(err_result), None);
}
}
```
## License
This project is licensed under the GPL license. See the LICENSE file for details.
## Contribution
Contributions are welcome! Please submit issues or pull requests.
---
Thank you for using `mod`! If you have any questions or suggestions, feel free to contact us.