anders429 / more_ranges Goto Github PK

All of the Index and IndexMut implementations are not visible in docs generated on nightly.

This is a known issue, and it looks like a solution is in the works. 0.2.0's release will be blocked until this is fixed, as I don't want incomplete docs to be published.

It seems that supporting Iterating and Indexing on stable is tricky at the moment, due std::iter::Step and std::slice::SliceIndex having experimental APIs. For Step, I've considered using the step crate to accomplish the same purpose. The only issue is it forces users to implement step::Step if they want to iterate over a custom steppable range.

An alternative is to make iterating and indexing both available, in the same manner as they are implemented for the standard library range types, on nightly channels only. It seems that [autocfg](https://crates.io/crates/autocfg does not currently offer probing channels yet, although it may come in the future. rustc_version is another crate which can probe channels.

Another possibility is to lock iterating and indexing behind a nightly feature, allowing users to opt-in using cargo features.

This is the checklist of things that need to happen before the 0.2.0 release.

• Implement Iterator.
• Implement DoubleEndedIterator.
• Implement FusedIterator.
• Implement ExactSizeIterator. These must be dependent on the target's pointer width.
• Implement TrustedLen.
• Implement Index for [T], Vec<T>, &str, and String. Also implement Index for CStr using RangeFromExclusive.
• Implement Serialize and
  Deserialize from serde.
• autocfg is working towards some form of nightly feature probing. This needs to be available to make the above features usable, since some of them require nightly, but we don't want to restrict the crate to nightly.
• Set up documentation using doc_item to make it more clear what the requirements are for certain parts of the crate.
• rustdoc issue with foreign implementations not being shown in documentation needs to be resolved (see #2). This only needs to be available in nightly, since that is what docs.rs uses. We need this to be fixed before release, or else half of the documentation will be missing. There is a PR to fix it, but it seems to be blocked currently.