Skip to content

Commit eadd3ed

Browse files
committed
Update stability guarantees
1 parent 574676a commit eadd3ed

File tree

1 file changed

+13
-2
lines changed

1 file changed

+13
-2
lines changed

docs/src/overview/stability-guarantees.md

Lines changed: 13 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -8,15 +8,26 @@ In short: we are versioning our software as `MAJOR.MINOR.PATCH`. We increase the
88
* MINOR version when we introducece functionality in a backwards-compatible manner
99
* PATCH version when we make backwards-compatible bug fixes
1010

11+
We will provide migration documentation between major versions.
12+
1113
## Future expectations
1214

13-
`async-std` uses the `AsyncRead/AsyncWrite/AsyncSeek/AsyncBufRead` and the `Stream` traits from the `futures-rs` library. We expect those to be conservatively updated and in lockstep. Breaking changes in these traits will lead to a major version upgrade, for which we will provide migration documentation.
15+
`async-std` uses its own implementations of the following concepts:
16+
17+
* `Read`
18+
* `Write`
19+
* `Seek`
20+
* `BufRead`
21+
* `Stream`
22+
23+
For integration with the ecosystem, all types implementing these traits also have an implementation of the corresponding interfaces in the `futures-rs` library.
24+
Please note that our SemVer guarantees don't extend to usage of those interfaces. We expect those to be conservatively updated and in lockstep.
1425

1526
## Minimum version policy
1627

1728
The current tentative policy is that the minimum Rust version required to use this crate can be increased in minor version updates. For example, if `async-std` 1.0 requires Rust 1.37.0, then `async-std` 1.0.z for all values of z will also require Rust 1.37.0 or newer. However, `async-std` 1.y for y > 0 may require a newer minimum version of Rust.
1829

19-
In general, this crate will be conservative with respect to the minimum supported version of Rust. With `async/await` being a new feature though, we will track changes in a measured pace.
30+
In general, this crate will be conservative with respect to the minimum supported version of Rust. With `async/await` being a new feature though, we will track changes in a measured pace initially.
2031

2132
## Security fixes
2233

0 commit comments

Comments
 (0)