This feature release supports Swift toolchain versions 6.0, 6.1 and 6.2, and it includes the following improvements:
BasicContainers
module
This new module collects ownership-aware, low-level variants of existing data structures in the core standard library. In this release, this module consists of two array variants, UniqueArray
and RigidArray
.
These new types are provided as less flexible, noncopyable alternatives to the classic Array
type. The standard Array
implements value semantics with the copy-on-write optimization; this inherently requires elements to be copyable, and it is itself copyable.
struct UniqueArray<Element>
is a noncopyable array variant that takes away Array
's copy-on-write behavior, enabling support for noncopyable elements. This type's noncopyability means mutations can always assume that the array is uniquely owned, with no shared copies (hence the name!). This means that array mutations such as mutating an element at an index can behave much more predictably, with no unexpected performance spikes due to having to copy shared storage.
struct RigidArray<Element>
goes even further, by also disabling dynamic resizing. Rigid arrays have a fixed capacity: they are initialized with room for a particular number of elements, and they never implicitly grow (nor shrink) their storage. When a rigid array's count reaches its capacity, it becomes unable to add any new items -- inserting into a full array is considered a programming error. This makes this a quite inflexible (or rigid) type indeed, as avoiding storage overflow requires careful, up front planning on the resource needs of the task at hand. In exchange, rigid arrays can have extremely predictable performance characteristics.
UniqueArray
is a great default choice when a task just needs an array type that is able store noncopyable elements. RigidArray
is best reserved for use cases that require absolute, pedantic control over memory use or latency -- such as control software running in environments with extremely limited memory, or when a certain task must always be completed in some given amount of time.
The Unique
and Rigid
prefixes applied here establish a general naming convention for low-level variants of the classic copy-on-write data structure implementations. Future releases are expected to flesh out our zoo of container types by adding Unique
and Rigid
variants of the existing Set
, Dictionary
, Deque
, Heap
and other constructs, with type names such as as RigidDictionary
and UniqueDeque
.
TrailingElementsModule
module
This new module ships a new TrailingArray
construct, a preview of a new low-level, ownership-aware variant of ManagedBuffer
. This is primarily intended as a interoperability helper for C constructs that consist of a fixed-size header directly followed by variable-size storage buffer.
ContainersPreview
module
This module is intended to contain previews of an upcoming ownership-aware container model. In this initial release, this module consists of just one construct: struct Box<T>
.
Box
is a wrapper type that forms a noncopyable, heap allocated box around an arbitrary value.
What's Changed
- Merge release/1.1 to main by @lorentey in #204
- Merge relase/1.1 to main, without taking any changes by @lorentey in #206
- [Heap] Add methods to replace minimum/maximum (redux) by @lorentey in #208
- Persistent collections updates (part 10) by @lorentey in #207
- Update CMakeLists.txt by @compnerd in #215
- Merge latest changes from release/1.1 to main by @lorentey in #220
- Merge branch release/1.1 to main by @lorentey in #231
- [SortedCollections] Disable tests with @testable imports in release builds by @lorentey in #232
- [Hashtable] Minor Documentation Fix (Typo) by @nickkohrn in #241
- Merge branch
release/1.1
tomain
by @lorentey in #248 - Update README.md by @glessard in #251
- [OrderedDictionary] Explicitly mention in documentation that keys/values are ordered by @warpling in #254
- build: support ARM64 spelling by @compnerd in #282
- Merge release/1.1 to main by @lorentey in #284
- Update release checklist by @lorentey in #323
- build: update the build rules for adjusted tree layout by @compnerd in #331
- build: support using swift-collections in larger projects by @compnerd in #330
- Merge release/1.1 to main by @lorentey in #332
- build: support building in Debug mode on Windows by @compnerd in #333
- Bugfix Incorrect Assert in BTree.removeFirst/removeLast by @LeoNavel in #349
- Fix typos by @rex4539 in #356
- Merge branch
release/1.1
tomain
by @lorentey in #358 - Merge.1.1→main by @lorentey in #361
- Add post-merge CI support by @shahmishal in #367
- Update CODEOWNERS by @lorentey in #375
- Merge release/1.1 to main by @lorentey in #386
- Merge release/1.1 to main by @lorentey in #410
- [BTree][NFC] Rephrase some comments by @lorentey in #427
- [CI] Pull Request testing support via GitHub Actions by @shahmishal in #426
- [OrderedDictionary Documentation] fix a typo by @Gyuni in #445
- Install swiftmodules with full module triple by @etcwilde in #470
- [OrderedSet] Add
OrderedSet.appending(contentsOf:)
by @pm-dev in #452 - ManagedBuffer.capacity is unavailable on OpenBSD. by @3405691582 in #456
- Align Heap._UnsafeHandle min/maxValue tie-breaking with Swift.min/max by @DakshinD in #455
- Add Heap.removeAll(where:) by @DakshinD in #454
- Merge release/1.2 to main by @lorentey in #450
- Disable
SortedCollections
module by @lorentey in #479 - Enable MemberImportVisibility and fix issues uncovered by @lorentey in #480
- fix comment for OrderedSet.appending(contentsOf:) by @ozumin in #478
- Bump requirements of nested benchmarking package by @lorentey in #481
- Fix CMake build by @etcwilde in #482
- Merge changes on
release/1.2
tomain
branch by @lorentey in #487 - Enable macOS testing on GitHub Actions by @shahmishal in #483
- Fix API documentation links in README.md by @azarovalex in #490
- Skip Xcode 16.0 and 16.1 in PR workflow by @natecook1000 in #493
- Fix OrderedSet example usage by @azarovalex in #491
- Add support for embedded Swift mode by @parkera in #494
- Include DequeModule in the Foundation toolchain build by @cthielen in #495
- Fix CMake build for
release/1.2
by @cthielen in #498 - fix minor typo in init docs for Deque.swift by @t089 in #503
- [SortedSet] Fix subtreeCount inconsistency after remove at index by @brianchang928 in #502
- Add the missing COLLECTIONS_SINGLE_MODULE when import InternalCollectionsUtils by @faimin in #501
- [SortedCollections] Fix incorrect offset calculation in BTree.findAnyIndex by @brianchang928 in #506
- [SortedCollections] Fix B-tree root reduction during element removal causing data loss by @brianchang928 in #507
- Add checks for Wasm compatibility to
pull_request.yml
by @MaxDesiatov in #509 - First round of noncopyable constructs:
Box
,RigidArray
,DynamicArray
by @lorentey in #508 - [actions] exclude Xcode 26 beta 6 by @glessard in #514
- Add "trailing elements" module with facilities for tail-allocated storage by @DougGregor in #513
- [Xcode] Add trailing elements to xcodeproj by @Azoy in #515
- Containers: Naming updates, minor tweaks by @lorentey in #516
- Add BasicContainer rename to xcodeproj by @Azoy in #517
- Prepare for tagging 1.3.0 by @lorentey in #523
- [Docs] Fix landing page of collections documentation by @Azoy in #520
- build: Install libraries in an
arch
sub-folder by @Steelskin in #505 - More release preparations for 1.3.0 by @lorentey in #524
- One last round of documentation updates by @lorentey in #525
New Contributors
- @nickkohrn made their first contribution in #241
- @warpling made their first contribution in #254
- @LeoNavel made their first contribution in #349
- @rex4539 made their first contribution in #356
- @Gyuni made their first contribution in #445
- @pm-dev made their first contribution in #452
- @DakshinD made their first contribution in #455
- @ozumin made their first contribution in #478
- @azarovalex made their first contribution in #490
- @natecook1000 made their first contribution in #493
- @parkera made their first contribution in #494
- @t089 made their first contribution in #503
- @brianchang928 made their first contribution in #502
- @faimin made their first contribution in #501
- @MaxDesiatov made their first contribution in #509
- @DougGregor made their first contribution in #513
Full Changelog: 1.2.1...1.3.0