mirror of
https://github.com/apple/swift.git
synced 2026-10-06 12:37:28 +02:00
Chris Adamson
d0d078517a
This PR updates files in the `stdlib.docc` directory to provide curation for symbols added to the standard library in release 6.4, including task cancellation shields and refs. The [stdlib documentation on docs.swift.org](https://docs.swift.org/latest/documentation/swift) uses these files to organize the online documentation into topics. This PR doesn't affect any compilable source. It's only for the use of the `docc` compiler to produce documentation, either in swift.org's CI or if someone wants to generate a local copy. rdar://181594680
45 lines
875 B
Markdown
45 lines
875 B
Markdown
# Basic Behaviors
|
|
|
|
Use your custom types in operations that depend on testing for equality or order
|
|
and as members of sets and dictionaries.
|
|
|
|
## Topics
|
|
|
|
### Equality and Ordering
|
|
|
|
Allow your custom types to be used with simple collection operations, such as `contains(_:)`,
|
|
and standard comparison operators.
|
|
|
|
- ``Swift/Equatable``
|
|
- ``Swift/Comparable``
|
|
- ``Swift/Identifiable``
|
|
|
|
### Copying
|
|
|
|
- ``Swift/Copyable``
|
|
- ``Swift/BitwiseCopyable``
|
|
- ``Swift/Escapable``
|
|
|
|
### Borrowing
|
|
|
|
- ``Swift/Ref``
|
|
- ``Swift/MutableRef``
|
|
|
|
### Sets and Dictionaries
|
|
|
|
Store your custom types in sets or use them as dictionary keys.
|
|
|
|
- ``Swift/Hashable``
|
|
- ``Swift/Hasher``
|
|
|
|
### String Representation
|
|
|
|
- ``Swift/CustomStringConvertible``
|
|
- ``Swift/LosslessStringConvertible``
|
|
- ``Swift/CustomDebugStringConvertible``
|
|
|
|
### Raw Representation
|
|
|
|
- ``Swift/CaseIterable``
|
|
- ``Swift/RawRepresentable``
|