Skip to content

Commit 03163a1

Browse files
committed
feat: bump versions
1 parent f075f42 commit 03163a1

File tree

6 files changed

+24
-18
lines changed

6 files changed

+24
-18
lines changed

CHANGELOG.md

+8
Original file line numberDiff line numberDiff line change
@@ -86,5 +86,13 @@
8686
- **BREAKING** Added Python-esque support for `:` as a delimiter.
8787
- :new: Add support for case-sensitive maps with automatic handling under the hood.
8888
- :hammer: Fixed buggy setters which went uncaught, to preserve case-insensitive nature.
89+
- 2.0.1
90+
- Add first-class support for setting, loading and reading defaults
91+
- New available struct `IniDefault` for fast templating
92+
- 2.1.0
93+
- 😯 **BREAKING** Parse keys with higher priority, both brackets `[` and `]` can be part of values now.
94+
- ℹ Only affects current behaviour **iff** your section headers had comments in front of them like, `comment[HEADER]`, you can fix it by adding the comment after the header like `[HEADER]#comment` or otherwise.
95+
- 🚀 `load()` and `write()` work with `Path`-like arguments now.
96+
- 📜 Add docs for new struct
8997

9098
Older changelogs are preserved here, current changelog is present in [README.md](README.md).

LICENSE-LGPL

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
Copyright (c) 2023 QEDK
1+
Copyright (c) 2024 QEDK
22

33
GNU LESSER GENERAL PUBLIC LICENSE
44
Version 3, 29 June 2007

LICENSE-MIT

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
MIT License
22

3-
Copyright (c) 2023 QEDK
3+
Copyright (c) 2024 QEDK
44

55
Permission is hereby granted, free of charge, to any
66
person obtaining a copy of this software and associated

README.md

+11-15
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
# configparser
2-
[![Build Status](https://github.com/QEDK/configparser-rs/actions/workflows/rust.yaml/badge.svg)](https://github.com/QEDK/configparser-rs/actions/workflows/rust.yaml) [![Crates.io](https://img.shields.io/crates/l/configparser?color=black)](LICENSE-MIT) [![Crates.io](https://img.shields.io/crates/v/configparser?color=black)](https://crates.io/crates/configparser) [![Released API docs](https://docs.rs/configparser/badge.svg)](https://docs.rs/configparser) [![Maintenance](https://img.shields.io/maintenance/yes/2023)](https://github.com/QEDK/configparser-rs)
2+
[![Build Status](https://github.com/QEDK/configparser-rs/actions/workflows/rust.yaml/badge.svg)](https://github.com/QEDK/configparser-rs/actions/workflows/rust.yaml) [![Crates.io](https://img.shields.io/crates/l/configparser?color=black)](LICENSE-MIT) [![Crates.io](https://img.shields.io/crates/v/configparser?color=black)](https://crates.io/crates/configparser) [![Released API docs](https://docs.rs/configparser/badge.svg)](https://docs.rs/configparser) [![Maintenance](https://img.shields.io/maintenance/yes/2024)](https://github.com/QEDK/configparser-rs)
33

44
This crate provides the `Ini` struct which implements a basic configuration language which provides a structure similar to what’s found in Windows' `ini` files. You can use this to write Rust programs which can be customized by end users easily.
55

@@ -29,7 +29,7 @@ strings as well as files.
2929
You can install this easily via `cargo` by including it in your `Cargo.toml` file like:
3030
```TOML
3131
[dependencies]
32-
configparser = "3.0.3"
32+
configparser = "3.0.4"
3333
```
3434

3535
## ➕ Supported datatypes
@@ -176,16 +176,16 @@ The `Ini` struct offers great support for type conversion and type setting safel
176176
You can activate it by adding it as a feature like this:
177177
```TOML
178178
[dependencies]
179-
configparser = { version = "3.0.2", features = ["indexmap"] }
179+
configparser = { version = "3.0.4", features = ["indexmap"] }
180180
```
181181

182-
- *async-std*: Activating the `async-std` feature adds asynchronous functions for reading from (`load_async()`) and
183-
writing to (`write_async()`) files using [async-std](https://crates.io/crates/async-std).
182+
- *tokio*: Activating the `tokio` feature adds asynchronous functions for reading from (`load_async()`) and
183+
writing to (`write_async()`) files using [tokio](https://crates.io/crates/tokio).
184184

185185
You can activate it by adding it as a feature like this:
186186
```TOML
187187
[dependencies]
188-
configparser = { version = "3.0.2", features = ["async-std"] }
188+
configparser = { version = "3.0.4", features = ["tokio"] }
189189
```
190190

191191
## 📜 License
@@ -206,14 +206,6 @@ additional terms or conditions.
206206
## 🆕 Changelog
207207

208208
Old changelogs are in [CHANGELOG.md](CHANGELOG.md).
209-
- 2.0.1
210-
- Add first-class support for setting, loading and reading defaults
211-
- New available struct `IniDefault` for fast templating
212-
- 2.1.0
213-
- 😯 **BREAKING** Parse keys with higher priority, both brackets `[` and `]` can be part of values now.
214-
- ℹ Only affects current behaviour **iff** your section headers had comments in front of them like, `comment[HEADER]`, you can fix it by adding the comment after the header like `[HEADER]#comment` or otherwise.
215-
- 🚀 `load()` and `write()` work with `Path`-like arguments now.
216-
- 📜 Add docs for new struct
217209
- 3.0.0
218210
- 😅 **BREAKING** `IniDefault` is now a non-exhaustive struct, this will make future upgrades easier and non-breaking in nature. This change might also have a few implications in updating your existing codebase, please read the [official docs](https://doc.rust-lang.org/reference/attributes/type_system.html#the-non_exhaustive-attribute) for more guidance.
219211
- `IniDefault` is now internally used for generating defaults, reducing crate size.
@@ -226,10 +218,14 @@ Old changelogs are in [CHANGELOG.md](CHANGELOG.md).
226218
- Adds support for multi-line key-value pairs.
227219
- Adds `async-std` feature for asynchronous file operations.
228220
- Some performance optimizations.
229-
- 3.0.3 (**STABLE**)
221+
- 3.0.3
230222
- Add default empty line on empty strings.
231223
- Feature to append to existing `Ini` objects.
232224
- Minor lint fixes.
225+
- 3.0.4 (**STABLE**)
226+
- Adds pretty printing functionality
227+
- Replaces `async-std` with `tokio` as the available async runtime
228+
- *The `async-std` feature will be deprecated in a future release*
233229

234230
### 🔜 Future plans
235231

src/ini.rs

+2
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,8 @@ use indexmap::IndexMap as Map;
55
#[cfg(not(feature = "indexmap"))]
66
use std::collections::HashMap as Map;
77

8+
#[deprecated(since = "3.0.4",
9+
note="async-std runtime has been replaced with tokio")]
810
#[cfg(feature = "async-std")]
911
#[cfg(feature = "tokio")]
1012
use tokio::fs as async_fs;

tests/test.rs

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
use configparser::ini::{Ini};
1+
use configparser::ini::{Ini, WriteOptions};
22
use std::error::Error;
33

44
#[test]

0 commit comments

Comments
 (0)