Safe Access to Contiguous Storage (#2307)

* [draft proposal] Safe Access to Contiguous Storage

* edit placeholder proposal url

* link to pitch thread

* declare typealiases correctly

* add “first” and “last” properties

* fix inits from raw pointers

* Update proposals/nnnn-safe-shared-contiguous-storage.md

Co-authored-by: Alex Martini <[email protected]>

* add `view(as: T)`

* incorporate feedback from pitch discussion

* enclose index and iterator types in the main type

* update protocol declaration

* link to additional related pitches

* fix a stored property type

* rename type, adopt new syntax

* various updates

* add more RawSpan API, doc-comment fixes

* Added more prose, added TODOs for further clarification

* Update proposals/nnnn-safe-shared-contiguous-storage.md

* remove some trailing whitespace from code blocks

* Update

* Update

* lots of updates

* Apply suggestions from code review

Co-authored-by: Michael Ilseman <[email protected]>

* Move byte parsing helpers into a future direction

* Fill out the index appendix

* tweaks and corrections

* add missing keywords

* Apply editing suggestions from review

Co-authored-by: Karoy Lorentey <[email protected]>

* annotation adjustments, various edits

* some more edits

* move `ContiguousStorage` to future directions

The state of the compiler does not allow us to propose it at this time.

* edits about unsafe initializer usage

* remove “generally” from index-sharing note

* improve index validation functions

* omit some duplicated documentation

* add html anchors to important sections

* add link to second pitch thread

- with whitespace tweaks

* more cleanup surrounding `ContiguousStorage`

* whitespace fixes

* Change some uses of the word “view” to “span” instead

* fix misspelling

* add missing doc-comment paragraph

* change `uncheckedBounds` to `unchecked`

* fix doc-comments

* rework `load` and company

* add the `SurjectiveBitPattern` future direction

* more about `SurjectiveBitPattern`, plus an alternative

* move reference to SE-0256 to the ContiguousStorage item

* reword coroutine accessors

* remove undesirable annotations and default values

* add containment utilities

* Apply suggestions from code review

Thanks to @benrimmington's eagle eyes

Co-authored-by: Ben Rimmington <[email protected]>

* remove extension to `Character.UTF8View`

- this is redundant, since it is the same as `String.UTF8View`

* add closure-taking api, move initializers to future

* shrink byte-parsing helpers future direction

* formatting, text moved around

* rename file to include the word “span”

* improve title

* add link to preview implementation

* lots of changes

* remove UBP.withUnsafeSpan and similar

* remove another ~Escapable that cannot be promised

* add a missing blurb

* improve name of bounds-checking functions

* addition about closure-based unsafe escape-hatch functions

* remove boundsPrecondition, add boundsContain overload

- add `boundsContain(_ bounds: ClosedRange<Int>)`

* start pointer clarification

* improve coroutine explanation

* convert non-breaking spaces

* fix extensions

* [feedback] mention initializers earlier

* rename span comparison functions

* fix span comparison signatures and documentation

---------

Co-authored-by: Guillaume Lessard <[email protected]>
Co-authored-by: Alex Martini <[email protected]>
Co-authored-by: Michael Ilseman <[email protected]>
Co-authored-by: Karoy Lorentey <[email protected]>
Co-authored-by: Ben Rimmington <[email protected]>

Author: 5 people