Swift Foundation

https://github.com/swiftlang/swift-foundation
Admin
Swift Foundation provides a shared implementation of key Foundation APIs for all Swift platforms,...
Tokens:421,540
Snippets:3,237
Trust Score:9.4
License:Apache-2.0
Update:2 days ago
Show doc for...
Tokens:
Raw
### Swift script using Process: check changed files and announce

Source: https://github.com/swiftlang/swift-foundation/blob/main/Proposals/0007-swift-subprocess.md

A Swift script that replicates the shell example using Foundation's Process API. It demonstrates the verbosity of Process, including explicit pipe setup, executable URL resolution, and manual output reading.

```swift
#!/usr/bin/swift

import Foundation

let gitProcess = Process()
let gitProcessPipe = Pipe()                                         // <- 0
gitProcess.currentDirectoryURL = URL(fileURLWithPath: ".")
gitProcess.executableURL = URL(fileURLWithPath: "/usr/bin/git")     // <- 1
gitProcess.arguments = [
    "diff",
    "--name-only"
]
gitProcess.standardOutput = gitProcessPipe
try gitProcess.run()
let processOutput = gitProcessPipe
    .fileHandleForReading.readDataToEndOfFile()                     // <- 2
gitProcess.waitUntilExit()                                          // <- 3
var changedFiles = String(data: processOutput, encoding: .utf8)!
if changedFiles.isEmpty {
    changedFiles = "No changed files"
} else {
    changedFiles = changedFiles.split(separator: "\n").joined(separator: ", ")
    changedFiles = "These files have changed: \(changedFiles)"
}

let sayProcess = Process()
sayProcess.currentDirectoryURL = URL(fileURLWithPath: ".")
sayProcess.executableURL = URL(fileURLWithPath: "/usr/bin/say")
sayProcess.arguments = [
    changedFiles
]
try sayProcess.run()
```

--------------------------------

### Run benchmarks with swift package benchmark

Source: https://github.com/swiftlang/swift-foundation/blob/main/Foundation_Build_Process.md

Run benchmarks from the Benchmarks subfolder using the package-benchmark plugin. Requires jemalloc to be installed (brew install jemalloc on macOS, sudo apt-get install -y libjemalloc-dev on Ubuntu).

```shell
swift package benchmark
```

--------------------------------

### Simple run() examples with .name, arguments, and input

Source: https://github.com/swiftlang/swift-foundation/blob/main/Proposals/0007-swift-subprocess.md

These examples show the basic usage of run() for simple subprocess execution. The first runs 'ls' and prints the standard output. The second launches VSCode with an argument and checks the termination status. The third runs 'cat' with input data and captures output as a string.

```swift
// Simple ls with no standard input
let ls = try await run(.name("ls"))
print("Items in current directory: \(ls.standardOutput!)")

// Launch VSCode with arguments
let code = try await run(
    .name("code"),
    arguments: ["/some/directory"]
)
print("Code launched successfully: \(code.terminationStatus.isSuccess)")

// Launch `cat` with sequence written to standardInput
let inputData = Array("Hello SwiftFoundation".utf8)
let cat = try await run(
    .name("cat"),
    input: .array(inputData),
    output: .string
)
print("Cat result: \(cat.standardOutput!)")
```

--------------------------------

### Examples of using Subprocess input methods

Source: https://github.com/swiftlang/swift-foundation/blob/main/Proposals/0007-swift-subprocess.md

Shows three ways to provide input to a subprocess: default .none, a file descriptor with closeAfterSpawningProcess, and an async sequence via .sequence. Each example uses the run function with different input sources.

```swift
// By default `InputMethod` is set to `.none`
let ls = try await run(.name("ls"))

// Alternatively, developers could pass in a file descriptor
let fd: FileDescriptor = ...
let cat = try await run(
    .name("cat"),
    input: .fileDescriptor(
        fd,
        closeAfterSpawningProcess: true
    )
)

// Pass in a async sequence directly
let sequence: AsyncSequence<Data> = ...
let exe = try await run(.path("/some/executable"), input: .sequence(sequence))
```

--------------------------------

### Process Piping with FileDescriptor.pipe()

Source: https://github.com/swiftlang/swift-foundation/blob/main/Proposals/0007-swift-subprocess.md

Shows the current recommended way to pipe output from one process to another using FileDescriptor.pipe(). This setup is considered overly complex compared to a simple shell pipe. The example runs 'ls' and pipes its output to 'grep swift', collecting the final standard output.

```swift
let pipe = try FileDescriptor.pipe()

async let ls = try await run(
    .name("ls"),
    output: .writeTo(pipe.writeEnd, closeAfterSpawningProcess: true)
)

async let grep = try await run(
    .name("grep"),
    arguments: ["swift"],
    input: .readFrom(pipe.readEnd, closeAfterSpawningProcess: true),
    output: .collectString()
)

let result = await grep.standardOutput
```

--------------------------------

### Arguments usage examples

Source: https://github.com/swiftlang/swift-foundation/blob/main/Proposals/0007-swift-subprocess.md

Shows how to pass arguments as an array and how to override the executable path using the executablePathOverride initializer.

```swift
// In most cases, simply pass in an array
let result = try await run(
    .path("/some/executable"),
    arguments: ["arg1", "arg2"]
)

// Override the executable path
let result2 = try await run(
    .path("/some/executable"),
    arguments: .init(
        executablePathOverride: "/new/executable/path",
        remainingValues: ["arg1", "arg2"]
    )
)
```

--------------------------------

### Example of using the OutputRawSpan initializer

Source: https://github.com/swiftlang/swift-foundation/blob/main/Proposals/0041-uuid-versions.md

Shows how to create a UUID using the init(initializingWith:) closure. The closure must write exactly 16 bytes; otherwise it traps. The example uses append calls but leaves the actual byte values as placeholders.

```swift
let uuid = UUID { output in
    // Note: It is up to the custom implementation here to create a valid UUID.
    output.append(...)
    output.append(...)
}
```

--------------------------------

### URI template examples

Source: https://github.com/swiftlang/swift-foundation/blob/main/Proposals/0020-uri-templating.md

Three example URI templates showing different expansion patterns: a simple path variable, a variable with a prefix modifier, and a query string expansion.

```text
http://example.com/~{username}/
http://example.com/dictionary/{term:1}/{term}
http://example.com/search{?q,lang}
```

--------------------------------

### for await in usage examples

Source: https://github.com/swiftlang/swift-foundation/blob/main/Proposals/0011-concurrency-safe-notifications.md

Shows how to iterate over messages using the familiar for await in syntax with the messages methods. The examples demonstrate observing by subject and identifier, and by message type.

```swift
for await message in center.messages(of: anObject, for: .anAsyncMessage) {
    // ...
}

for await message in center.messages(for: AnAsyncMessage.self) {
    // ...
}

// etc.
```

--------------------------------

### Environment usage examples

Source: https://github.com/swiftlang/swift-foundation/blob/main/Proposals/0007-swift-subprocess.md

Shows how to override the PATH environment variable using .inherit.updating() and how to set custom environment variables with .custom().

```swift
// Override the `PATH` environment value from launching process
let result = try await run(
    .path("/some/executable"),
    environment: .inherit.updating(
        ["PATH" : "/some/new/path"]
    )
)

// Use custom values
let result2 = try await run(
    .path("/at"),
    environment: .custom([
        "PATH" : "/some/path"
        "HOME" : "/Users/Charles"
    ])
)
```

--------------------------------

### Motivating example: creating a configured calendar

Source: https://github.com/swiftlang/swift-foundation/blob/main/Proposals/0040-calendar-timezone-initializer.md

Shows how to create a Calendar with a specific identifier, time zone, locale, and first weekday using the fluent configuration API.

```swift
let calendar = Calendar(
    .identifier(.gregorian)
    .timeZone(TimeZone(identifier: "Australia/Sydney"))
    .locale(Locale(identifier: "en_AU"))
    .firstWeekday(2)
)
```

--------------------------------

### Unified initialization and extension examples

Source: https://github.com/swiftlang/swift-foundation/blob/main/Proposals/0040-calendar-timezone-initializer.md

Demonstrates creating calendars with predefined configurations, extending Calendar.Configuration with custom static properties and methods, and using the fluent API with string-based time zone and locale.

```swift
let current = Calendar(.current)
let autoupdatingCurrent = Calendar(.autoupdatingCurrent)
let gregorian = Calendar(.identifier(.gregorian))

extension Calendar.Configuration {
    static var sydneyAustralia: Self {
        Self.identifier(.gregorian)
            .locale(Locale(identifier: "en_AU"))
            .timeZone(TimeZone(identifier: "Australia/Sydney"))
    }
}

let sydney = Calendar(.sydneyAustralia)

extension Calendar.Configuration {
    /// Conveniently construct time zone objects from an IANA identifier.
    static func timeZone(_ identifier: String) -> Self {
        self.timeZone(TimeZone(identifier: identifier))
    }
    /// … one for Locale by identifier …
}

let calendar = Calendar(
    .identifier(.gregorian)
    .timeZone("Australia/Sydney")
    .locale("en_AU")
    .firstWeekday(2)
)
```

--------------------------------

### Configuring preSpawnProcessConfigurator on Windows

Source: https://github.com/swiftlang/swift-foundation/blob/main/Proposals/0007-swift-subprocess.md

Shows how to set the preSpawnProcessConfigurator closure to modify creation flags and startup info before process creation. The example sets CREATE_NEW_CONSOLE and adjusts the window position and size.

```swift
var platformOptions: PlatformOptions = .default
// Set Group ID for process
platformOptions.preSpawnProcessConfigurator = { flag, startupInfo in
    // Set CREATE_NEW_CONSOLE for flag
    flag |= DWORD(CREATE_NEW_CONSOLE)

    // Set the window position
    startupInfo.dwX = 0
    startupInfo.dwY = 0
    startupInfo.dwXSize = 100
    startupInfo.dwYSize = 100
}
```

--------------------------------

### Usage example for Locale.Region properties

Source: https://github.com/swiftlang/swift-foundation/blob/main/Proposals/0028-locale-region-category.md

Demonstrates querying continent and containingRegion for Argentina, returning ISO codes.

```swift
let argentina = Locale.Region.argentina

_ = argentina.continent // "019" (Americas)
_ = argentina.containingRegion // "005" (South America)
```

--------------------------------

### starts(with:)

Source: https://github.com/swiftlang/swift-foundation/blob/main/Sources/FoundationEssentials/FoundationEssentials.docc/Curation/Fundamentals/NumbersAndBasicValues/Data.md

Returns a Boolean indicating whether the data buffer begins with the given prefix.

```APIDOC
## starts(with:)

### Description
Returns a Boolean indicating whether the data buffer begins with the given prefix.

### Method
starts(with:)

### Parameters
- **possiblePrefix** (Sequence) - Required - The prefix to check.

### Response
Returns true if the data buffer starts with the given prefix, false otherwise.
```

--------------------------------

### Daily recurrence example

Source: https://github.com/swiftlang/swift-foundation/blob/main/Proposals/0009-calendar-recurrence-rule.md

Creates a daily recurrence rule and iterates over the next recurrence dates starting from now. The example assumes the current date is February 09, 2024, 13:43, and shows the resulting dates.

```swift
var recurrence = Calendar.RecurrenceRule(calendar: .current, frequency: .daily)
for date in recurrence.recurrences(of: .now) {
    // 2024-02-09, 13:43
    // 2024-02-10, 13:43
    // 2024-02-11, 13:43
    // 2024-02-12, 13:43
    // ...
}
```

--------------------------------

### Event model with recurrence rule

Source: https://github.com/swiftlang/swift-foundation/blob/main/Proposals/0009-calendar-recurrence-rule.md

Defines a struct for an event that includes a start date, duration, and a recurrence rule. This example is used to illustrate the duplication problem when the start time is embedded in the recurrence rule.

```swift
struct Event {
    var start: Date
    var duration: Duration
    var recurrence: Calendar.RecurrenceRule?
}
```

--------------------------------

### Static member lookup for MessageIdentifier

Source: https://github.com/swiftlang/swift-foundation/blob/main/Proposals/0011-concurrency-safe-notifications.md

This example shows how the static member lookup experience works with the MessageIdentifier protocol. It demonstrates the extension that provides the .willLaunchApplication static member, which is used in the addObserver call.

```swift
addObserver(of: workspace, for: .willLaunchApplication) { ... }

// .willLaunchApplication provided by ...
extension NotificationCenter.MessageIdentifier
    where Self == NotificationCenter.BaseMessageIdentifier<NSWorkspace.WillLaunchApplication, NSWorkspace> {
    static var willLaunchApplication: Self { .init() }
}
```

--------------------------------

### Recurrence rule API usage with start time

Source: https://github.com/swiftlang/swift-foundation/blob/main/Proposals/0009-calendar-recurrence-rule.md

Shows the proposed API for creating a recurrence rule with a start time, frequency, and count. The example iterates over the resulting dates. This is presented as an alternative that was considered but not adopted.

```swift
var recurrence = Calendar.Recurrence(calendar: .current, startingAt: .now, frequency: .monthly, count: 5)
for date in recurrence {

}
```

--------------------------------

### Usage of containingRegion(ofCategory:)

Source: https://github.com/swiftlang/swift-foundation/blob/main/Proposals/0028-locale-region-category.md

Example usage of the containingRegion(ofCategory:) method, showing how to get the continent and subcontinent for Argentina.

```swift
// The continent containing Argentina, equivalent to `argentina.continent`
_ = argentina.containingRegion(ofCategory: .continent) // "019" (Americas)

// The sub-continent containing Argentina, equivalent to `argentina.subcontinent`
_ = argentina.containingRegion(ofCategory: .subcontinent) // "005" (South America)
```

--------------------------------

### Usage example of Locale.Region.Category

Source: https://github.com/swiftlang/swift-foundation/blob/main/Proposals/0028-locale-region-category.md

Shows how to use the new API to get regions of specific categories, including category, subcontinent, and subRegions(ofCategory:).

```swift
let argentina = Locale.Region.argentina
_ = argentina.category // .territory
_ = argentina.subcontinent // "005" (South America)

let americas = Locale.Region("019")
_ = americas.category // .continent
_ = americas.subRegions(ofCategory: .subcontinent) // All subcontinents in Americas: ["005", "013", "021", "029"] (South America, Central America, Northern America, Caribbean)
_ = americas.subRegions(ofCategory: .territory) // All territories in Americas

_ = Locale.Region.isoRegions(ofCategory: .continent) // All continents: ["002", "009", "019", "142", "150"] (Africa, Oceania, Americas, Asia, Europe)
```

--------------------------------

### Examples of using different outputs

Source: https://github.com/swiftlang/swift-foundation/blob/main/Proposals/0007-swift-subprocess.md

Shows how to use the `run` function with different output types: `.string` for collecting output as String, `.data(limit:)` for Data with a custom limit, and `.fileDescriptor` for writing to a specific file descriptor.

```swift
let ls = try await run(.name("ls"), output: .string)
// The output has been collected as `String`, up to 128kb limit
print("ls output: \(ls.standardOutout!)")

// Increase the default buffer limit to 256kb and collect output as Data
let curl = try await run(
    .name("curl"),
    output: .data(limit: 256 * 1024)
)
print("curl output: \(curl.standardOutput.count)")


// Write to a specific file descriptor
let fd: FileDescriptor = try .open(...)
let result = try await run(
    .path("/some/script"),
    output: .fileDescriptor(fd, closeAfterSpawningProcess: true)
)
```

--------------------------------

### Enumerate next date with nextDate(after:matching:matchingPolicy:repeatedTimePolicy:direction:)

Source: https://github.com/swiftlang/swift-foundation/blob/main/Proposals/0017-expanded-calendar-support.md

This function enumerates the next date after a given date that matches the specified components, respecting the matching policy and repeated time policy. The behavior depends on whether the start date is a leap day and the value of components.isRepeatedDay. For example, if start is on a leap day and components.isRepeatedDay is true, it returns the next leap day with the same day/month/year; if false, it returns the next non-leap day with the same numbers.

```swift
public func nextDate(after date: Date, matching components: DateComponents, matchingPolicy: MatchingPolicy, repeatedTimePolicy: RepeatedTimePolicy = .first, direction: SearchDirection = .forward) -> Date? {
    var result: Date?
    enumerateDates(startingAfter: date, matching: components, matchingPolicy: matchingPolicy, repeatedTimePolicy: repeatedTimePolicy, direction: direction) { date, exactMatch, stop in
        result = date
        stop = true
    }
    return result
}
```

--------------------------------

### start

Source: https://github.com/swiftlang/swift-foundation/blob/main/Sources/FoundationEssentials/FoundationEssentials.docc/Curation/Fundamentals/DatesAndTimes/DateInterval.md

The start date of the date interval. This property provides access to the starting point of the interval.

```APIDOC
## start

### Description
The start date of the date interval. This property provides access to the starting point of the interval.

### Property
`start: Date`

### Return Value
The start date of the interval.
```

--------------------------------

### init(start:end:)

Source: https://github.com/swiftlang/swift-foundation/blob/main/Sources/FoundationEssentials/FoundationEssentials.docc/Curation/Fundamentals/DatesAndTimes/DateInterval.md

Creates a date interval with a specified start and end date. This initializer is used to define a date interval based on a start and end point.

```APIDOC
## init(start:end:)

### Description
Creates a date interval with a specified start and end date. This initializer is used to define a date interval based on a start and end point.

### Method
Initializer

### Signature
`init(start:end:)`

### Parameters
- **start** (Date) - Required - The start date of the interval.
- **end** (Date) - Required - The end date of the interval.

### Return Value
A new DateInterval instance.
```

--------------------------------

### init(_:)

Source: https://github.com/swiftlang/swift-foundation/blob/main/Sources/FoundationEssentials/FoundationEssentials.docc/Curation/Fundamentals/FiltersAndSorting/PredicateBindings.md

Creates a new PredicateBindings instance with the given initial bindings.

```APIDOC
## init(_:)

### Description
Creates a new PredicateBindings instance with the given initial bindings.

### Method
Initializer

### Parameters
- **bindings** (Dictionary) - Required - The initial bindings to set.

### Return Value
A new PredicateBindings instance.
```

--------------------------------

### init(start:duration:)

Source: https://github.com/swiftlang/swift-foundation/blob/main/Sources/FoundationEssentials/FoundationEssentials.docc/Curation/Fundamentals/DatesAndTimes/DateInterval.md

Creates a date interval with a specified start date and duration. This initializer is used to define a date interval based on a starting point and a length of time.

```APIDOC
## init(start:duration:)

### Description
Creates a date interval with a specified start date and duration. This initializer is used to define a date interval based on a starting point and a length of time.

### Method
Initializer

### Signature
`init(start:duration:)`

### Parameters
- **start** (Date) - Required - The start date of the interval.
- **duration** (TimeInterval) - Required - The duration of the interval.

### Return Value
A new DateInterval instance.
```

--------------------------------

### dateInterval(of:start:interval:for:)

Source: https://github.com/swiftlang/swift-foundation/blob/main/Sources/FoundationEssentials/FoundationEssentials.docc/Curation/Fundamentals/DatesAndTimes/Calendar.md

Returns the start and interval for a component of a date.

```APIDOC
## dateInterval(of:start:interval:for:)

### Description
Returns the start and interval for a component of a date.

### Method
Function

### Parameters
- **component** (Calendar.Component) - Required - The component to get the interval for.
- **start** (UnsafeMutablePointer<Date>?) - Required - A pointer to store the start date.
- **interval** (UnsafeMutablePointer<TimeInterval>?) - Required - A pointer to store the interval.
- **date** (Date) - Required - The date to evaluate.

### Return Value
A Boolean indicating whether the interval was found.
```

--------------------------------

### init()

Source: https://github.com/swiftlang/swift-foundation/blob/main/Sources/FoundationEssentials/FoundationEssentials.docc/Curation/Fundamentals/Collections/IndexPath.md

Creates an empty index path.

```APIDOC
## init()

### Description
Creates an empty index path.

### Method
Initializer

### Parameters
None

### Return Value
An empty IndexPath instance.
```

--------------------------------

### init(from:)

Source: https://github.com/swiftlang/swift-foundation/blob/main/Sources/FoundationEssentials/FoundationEssentials.docc/Curation/FilesAndDataPersistence/ArchivesAndSerialization/CodableConfiguration.md

Creates a codable configuration by decoding from a decoder.

```APIDOC
## init(from:)

### Description
Creates a codable configuration by decoding from a decoder.

### Method
Initializer

### Parameters
- **decoder** (Decoder) - Required - The decoder to read data from.

### Response
Returns a new CodableConfiguration instance.
```

--------------------------------

### recurrences(of:in:) - PartialRangeFrom<Date>

Source: https://github.com/swiftlang/swift-foundation/blob/main/Sources/FoundationEssentials/FoundationEssentials.docc/Curation/Fundamentals/DatesAndTimes/Calendar/RecurrenceRule.md

Returns a sequence of dates that match the recurrence rule, starting from a given start date and within a partial range that starts from a specified date. This method is used to generate recurrence dates.

```APIDOC
## recurrences(of:in:) - PartialRangeFrom<Date>

### Description
Returns a sequence of dates that match the recurrence rule, starting from a given start date and within a partial range that starts from a specified date. This method is used to generate recurrence dates.

### Method
Instance Method

### Parameters
- **start** (Date) - Required - The start date for the recurrences.
- **range** (PartialRangeFrom<Date>) - Required - The range within which to generate recurrences, starting from the specified date.

### Request Example
```swift
let dates = rule.recurrences(of: startDate, in: startDate...)
```

### Response
#### Success Response
- **sequence** (some Sendable & Sequence<Date>) - A sequence of dates that match the recurrence rule.

#### Response Example
```swift
let dates = rule.recurrences(of: startDate, in: startDate...)
```
```

--------------------------------

### dateIntervalOfWeekend(containing:start:interval:)

Source: https://github.com/swiftlang/swift-foundation/blob/main/Sources/FoundationEssentials/FoundationEssentials.docc/Curation/Fundamentals/DatesAndTimes/Calendar.md

Returns the start and interval of the weekend containing a date.

```APIDOC
## dateIntervalOfWeekend(containing:start:interval:)

### Description
Returns the start and interval of the weekend containing a date.

### Method
Function

### Parameters
- **date** (Date) - Required - The date to check.
- **start** (UnsafeMutablePointer<Date>?) - Required - A pointer to store the start date.
- **interval** (UnsafeMutablePointer<TimeInterval>?) - Required - A pointer to store the interval.

### Return Value
A Boolean indicating whether the date is in a weekend.
```

--------------------------------

### init()

Source: https://github.com/swiftlang/swift-foundation/blob/main/Sources/FoundationEssentials/FoundationEssentials.docc/Curation/AppSupport/Notifications/NotificationCenter.md

Creates a custom notification center instance.

```APIDOC
## init()

### Description
Creates a custom notification center instance.

### Declaration
`init()`
```

--------------------------------

### nextWeekend(startingAfter:start:interval:direction:)

Source: https://github.com/swiftlang/swift-foundation/blob/main/Sources/FoundationEssentials/FoundationEssentials.docc/Curation/Fundamentals/DatesAndTimes/Calendar.md

Returns the start and interval of the next weekend after a date.

```APIDOC
## nextWeekend(startingAfter:start:interval:direction:)

### Description
Returns the start and interval of the next weekend after a date.

### Method
Function

### Parameters
- **date** (Date) - Required - The date to start after.
- **start** (UnsafeMutablePointer<Date>?) - Required - A pointer to store the start date.
- **interval** (UnsafeMutablePointer<TimeInterval>?) - Required - A pointer to store the interval.
- **direction** (Calendar.SearchDirection) - Required - The search direction.

### Return Value
A Boolean indicating whether a weekend was found.
```

--------------------------------

### init()

Source: https://github.com/swiftlang/swift-foundation/blob/main/Sources/FoundationEssentials/FoundationEssentials.docc/Curation/AppSupport/TaskManagement/OperatingSystemVersion.md

Creates an operating system version with default values. Use this initializer to create an empty or default OperatingSystemVersion instance.

```APIDOC
## init()

### Description
Creates an operating system version with default values. Use this initializer to create an empty or default OperatingSystemVersion instance.

### Method
Initializer

### Signature
`init()`

### Parameters
None

### Return Value
An OperatingSystemVersion instance with default values.

```

--------------------------------

### Operator overload example with &&

Source: https://github.com/swiftlang/swift-foundation/blob/main/Proposals/0036-initializers-join-predicates.md

Example of using && operator to combine predicates, but noted as problematic due to global operator overloads.

```swift
fooPredicate && barPredicate
```

--------------------------------

### Backward search example with PartialRangeFrom

Source: https://github.com/swiftlang/swift-foundation/blob/main/Proposals/0001-calendar-improvements.md

An example of a potential API using PartialRangeFrom that was considered but rejected due to confusion with backward direction.

```swift
let dates = calendar.dates(in: start..., matching: components, direction: .backward) // Starts at start but goes 'backwards', even though range is 'From' start
```

--------------------------------

### Invoke toolchain build with build-script preset

Source: https://github.com/swiftlang/swift-foundation/blob/main/Foundation_Build_Process.md

Use this command on Linux from the Swift repo to build a full toolchain. It installs each component into the directory specified by install_destdir and packages that directory into a .tar.gz file at installable_package. This is the command used to build the nightly Swift toolchain.

```shell
utils/build-script --preset buildbot_linux,no_test install_destdir=<path to some installation folder> installable_package=<path to some .tar.gz file>
```

--------------------------------

### start(totalCount:)

Source: https://github.com/swiftlang/swift-foundation/blob/main/Sources/FoundationEssentials/FoundationEssentials.docc/Curation/AppSupport/TaskManagement/Subprogress.md

Starts a new subprogress with the specified total count. This method is used to create and manage a progress instance for tracking tasks.

```APIDOC
## start(totalCount:)

### Description
Starts a new subprogress with the specified total count. This method is used to create and manage a progress instance for tracking tasks.

### Method
start

### Parameters
#### Parameters
- **totalCount** (Int) - Required - The total number of units of work to be performed.

### Return Value
A new Subprogress instance.

```

--------------------------------

### Correctly using Subprogress with ProgressManager

Source: https://github.com/swiftlang/swift-foundation/blob/main/Proposals/0023-progress-manager.md

Shows how to pass a Subprogress to a function and start a child ProgressManager with start(totalCount:). The manager reports progress via complete(count:).

```swift
func correctlyUsingSubprogress() async {
    let overall = ProgressManager(totalCount: 2)
    await subTask(subprogress: overall.subprogress(assigningCount: 1))
}

func subTask(subprogress: consuming Subprogress? = nil) async {
    let count = 10
    let manager = subprogress?.start(totalCount: count) // returns an instance of ProgressManager that can be used to report progress of subtask
    for _ in 1...count {
        manager?.complete(count: 1) // reports progress as usual
    }
}
```

--------------------------------

### init(_:)-(UInt64)

Source: https://github.com/swiftlang/swift-foundation/blob/main/Sources/FoundationEssentials/FoundationEssentials.docc/Curation/Fundamentals/NumbersAndBasicValues/Decimal.md

Creates a decimal from a UInt64 value.

```APIDOC
## init(_:)-(UInt64)

### Description
Creates a decimal from a UInt64 value.

### Method
Initializer

### Signature
`init(_ value: UInt64)`

### Parameters
- **value** (UInt64) - Required - The UInt64 value to convert.

```

--------------------------------

### init()

Source: https://github.com/swiftlang/swift-foundation/blob/main/Sources/FoundationEssentials/FoundationEssentials.docc/Curation/Fundamentals/NumbersAndBasicValues/Data.md

Creates an empty Data instance.

```APIDOC
## init()

### Description
Creates an empty Data instance.

### Method
Initializer

### Endpoint
`init()`

### Parameters
None

### Request Example
```swift
let data = Data()
```

### Response
#### Success Response
- **data** (Data) - An empty Data instance.

#### Response Example
```swift
Data()
```
```

--------------------------------

### Limit weekly recurrence to Fridays

Source: https://github.com/swiftlang/swift-foundation/blob/main/Proposals/0009-calendar-recurrence-rule.md

Limits a weekly recurrence to only Fridays, returning one date per week. The start date is not included, and the hour/minute from the start date are preserved.

```swift
var recurrence = Calendar.RecurrenceRule(calendar: .current, frequency: .weekly)
recurrence.weekdays = [.every(.friday)]
for date in recurrence.recurrences(of: .now) {
    // 2024-02-09, 13:43
    // 2024-02-16, 13:43
    // 2024-02-19, 13:43
    // 2024-02-23, 13:43
    // 2025-02-07, 13:43
    // ...
}
```

--------------------------------

### init(_:)-(UInt)

Source: https://github.com/swiftlang/swift-foundation/blob/main/Sources/FoundationEssentials/FoundationEssentials.docc/Curation/Fundamentals/NumbersAndBasicValues/Decimal.md

Creates a decimal from a UInt value.

```APIDOC
## init(_:)-(UInt)

### Description
Creates a decimal from a UInt value.

### Method
Initializer

### Signature
`init(_ value: UInt)`

### Parameters
- **value** (UInt) - Required - The UInt value to convert.

```

--------------------------------

### init(from:)

Source: https://github.com/swiftlang/swift-foundation/blob/main/Sources/FoundationEssentials/FoundationEssentials.docc/Curation/Fundamentals/DatesAndTimes/Locale/NumberingSystem-swift.struct.md

Creates a numbering system instance by decoding from a decoder.

```APIDOC
## init(from:)

### Description
Creates a numbering system instance by decoding from a decoder.

### Method
Initializer

### Parameters
- **decoder** (Decoder) - Required - The decoder to read data from.

### Response
Returns a new `Locale.NumberingSystem` instance.
```

--------------------------------

### Strawman String Encoding Protocol Example

Source: https://github.com/swiftlang/swift-foundation/blob/main/Proposals/0033-String-Encoding-Names.md

Illustrates a possible protocol and conforming types for string encoding names and implementations, as a future direction. The example is a strawman and not part of the proposed API.

```swift
public protocol StrawmanStringEncodingProtocol {
  static func encoding(for name: String) -> Self?
  var name: String? { get }
  var encoder: (any StringToByteStreamEncoder)? { get }
  var decoder: (any ByteStreamToUnicodeScalarsDecoder)? { get }
}

public struct IANACharset: StrawmanStringEncodingProtocol {
  public static let utf8: IANACharset = ...
  public static let shiftJIS: IANACharset = ...
  :
  :
}

public struct WHATWGEncoding: StrawmanStringEncodingProtocol {
  public static let utf8: WHATWGEncoding = ...
  public static let eucJP: WHATWGEncoding = ...
  :
  :
}
```

--------------------------------

### init()

Source: https://github.com/swiftlang/swift-foundation/blob/main/Sources/FoundationEssentials/FoundationEssentials.docc/Curation/Fundamentals/NumbersAndBasicValues/Decimal.md

Creates an empty decimal.

```APIDOC
## init()

### Description
Creates an empty decimal.

### Method
Initializer

### Signature
`init()`

```

--------------------------------

### init(_:)-(UInt32)

Source: https://github.com/swiftlang/swift-foundation/blob/main/Sources/FoundationEssentials/FoundationEssentials.docc/Curation/Fundamentals/NumbersAndBasicValues/Decimal.md

Creates a decimal from a UInt32 value.

```APIDOC
## init(_:)-(UInt32)

### Description
Creates a decimal from a UInt32 value.

### Method
Initializer

### Signature
`init(_ value: UInt32)`

### Parameters
- **value** (UInt32) - Required - The UInt32 value to convert.

```

--------------------------------

### Whole match alternative example

Source: https://github.com/swiftlang/swift-foundation/blob/main/Proposals/0004-predicate-regex-support.md

Example of using `wholeMatch` to check for a full match, returning a `Regex.Match?` and comparing against nil. This approach was considered but not adopted due to discoverability and the non-Codable/Sendable nature of `Regex.Match`.

```swift
let predicate = #Predicate<Address> {
	$0.zipcode.wholeMatch(/\d{5}(-\d{4})?/) != nil
}
```

--------------------------------

### recurrences(of:in:) - ClosedRange<Date>

Source: https://github.com/swiftlang/swift-foundation/blob/main/Sources/FoundationEssentials/FoundationEssentials.docc/Curation/Fundamentals/DatesAndTimes/Calendar/RecurrenceRule.md

Returns a sequence of dates that match the recurrence rule, starting from a given start date and within a closed range that includes both endpoints. This method is used to generate recurrence dates.

```APIDOC
## recurrences(of:in:) - ClosedRange<Date>

### Description
Returns a sequence of dates that match the recurrence rule, starting from a given start date and within a closed range that includes both endpoints. This method is used to generate recurrence dates.

### Method
Instance Method

### Parameters
- **start** (Date) - Required - The start date for the recurrences.
- **range** (ClosedRange<Date>) - Required - The range within which to generate recurrences, including both endpoints.

### Request Example
```swift
let dates = rule.recurrences(of: startDate, in: startDate...endDate)
```

### Response
#### Success Response
- **sequence** (some Sendable & Sequence<Date>) - A sequence of dates that match the recurrence rule.

#### Response Example
```swift
let dates = rule.recurrences(of: startDate, in: startDate...endDate)
```
```

--------------------------------

### init(from:)

Source: https://github.com/swiftlang/swift-foundation/blob/main/Sources/FoundationEssentials/FoundationEssentials.docc/Curation/AppSupport/TaskManagement/OperatingSystemVersion.md

Creates an operating system version by decoding from a decoder. Use this initializer to decode an OperatingSystemVersion from a serialized format.

```APIDOC
## init(from:)

### Description
Creates an operating system version by decoding from a decoder. Use this initializer to decode an OperatingSystemVersion from a serialized format.

### Method
Initializer

### Signature
`init(from decoder: Decoder)`

### Parameters
- **decoder** (Decoder) - Required - The decoder to read data from.

### Return Value
An OperatingSystemVersion instance decoded from the provided decoder.

```

--------------------------------

### init()

Source: https://github.com/swiftlang/swift-foundation/blob/main/Sources/FoundationEssentials/FoundationEssentials.docc/Curation/FilesAndDataPersistence/FileManager.md

Initializes a new FileManager instance.

```APIDOC
## init()

### Description
Initializes a new FileManager instance.

### Method
init

### Endpoint
FileManager.init()

### Parameters
None

### Request Example
None

### Response
#### Success Response
- **FileManager** - A new FileManager instance.

#### Response Example
None
```

--------------------------------

### recurrences(of:in:) - PartialRangeUpTo<Date>

Source: https://github.com/swiftlang/swift-foundation/blob/main/Sources/FoundationEssentials/FoundationEssentials.docc/Curation/Fundamentals/DatesAndTimes/Calendar/RecurrenceRule.md

Returns a sequence of dates that match the recurrence rule, starting from a given start date and within a partial range that goes up to but not including a specified date. This method is used to generate recurrence dates.

```APIDOC
## recurrences(of:in:) - PartialRangeUpTo<Date>

### Description
Returns a sequence of dates that match the recurrence rule, starting from a given start date and within a partial range that goes up to but not including a specified date. This method is used to generate recurrence dates.

### Method
Instance Method

### Parameters
- **start** (Date) - Required - The start date for the recurrences.
- **range** (PartialRangeUpTo<Date>) - Required - The range within which to generate recurrences, up to but not including the specified date.

### Request Example
```swift
let dates = rule.recurrences(of: startDate, in: ..<endDate)
```

### Response
#### Success Response
- **sequence** (some Sendable & Sequence<Date>) - A sequence of dates that match the recurrence rule.

#### Response Example
```swift
let dates = rule.recurrences(of: startDate, in: ..<endDate)
```
```

--------------------------------

### init(contentsOfFile:encoding:)

Source: https://github.com/swiftlang/swift-foundation/blob/main/Sources/FoundationEssentials/FoundationEssentials.docc/Curation/Extensions-Swift/String.md

Initializes a string from the contents of a file at the specified path using the given encoding.

```APIDOC
## init(contentsOfFile:encoding:)

### Description
Initializes a string from the contents of a file at the specified path using the given encoding.

### Method
Initializer

### Parameters
- **contentsOfFile** (String) - Required - The path to the file to read.
- **encoding** (Encoding) - Required - The encoding to use for the conversion.

### Response
Returns a String instance, or throws an error if the file cannot be read.
```

--------------------------------

### init()

Source: https://github.com/swiftlang/swift-foundation/blob/main/Sources/FoundationEssentials/FoundationEssentials.docc/Curation/FilesAndDataPersistence/ArchivesAndSerialization/PropertyListDecoder.md

Creates a new property list decoder.

```APIDOC
## init()

### Description
Creates a new property list decoder.

### Method
Initializer

### Syntax
```swift
init()
```
```

--------------------------------

### Subprogress struct definition with start(totalCount:) method

Source: https://github.com/swiftlang/swift-foundation/blob/main/Proposals/0023-progress-manager.md

Defines the Subprogress struct, a ~Copyable type returned from subprogress(assigningCount:). The start(totalCount:) method consumes the Subprogress and returns a child ProgressManager. If a Subprogress is never consumed, the parent automatically completes by the assigned count.

```swift
/// Subprogress is used to establish parent-child relationship between two instances of `ProgressManager`.
///
/// Subprogress is returned from a call to `subprogress(assigningCount:)` by a parent ProgressManager.
/// A child ProgressManager is then returned by calling `start(totalCount:)` on a Subprogress.
/// If a `Subprogress` is created but never consumed to create a child `ProgressManager`, the parent `ProgressManager` will 
/// automatically complete by the `count` that was assigned to the unusued `Subprogress`. 
@available(FoundationPreview 6.4, *)
public struct Subprogress: ~Copyable, Sendable {

    /// Instantiates a ProgressManager which is a child to the parent ProgressManager from which the Subprogress is created.
    /// 
    /// - Parameter totalCount: Total count of returned child `ProgressManager` instance.
    /// - Returns: A `ProgressManager` instance.
    public consuming func start(totalCount: Int?) -> ProgressManager
}
```

--------------------------------

### init(from:)

Source: https://github.com/swiftlang/swift-foundation/blob/main/Sources/FoundationEssentials/FoundationEssentials.docc/Curation/Fundamentals/NumbersAndBasicValues/Decimal.md

Creates a decimal by decoding from a decoder.

```APIDOC
## init(from:)

### Description
Creates a decimal by decoding from a decoder.

### Method
Initializer

### Signature
`init(from decoder: Decoder) throws`

### Parameters
- **decoder** (Decoder) - Required - The decoder to read data from.

### Throws
An error if decoding fails.

```

--------------------------------

### startOfDay(for:)

Source: https://github.com/swiftlang/swift-foundation/blob/main/Sources/FoundationEssentials/FoundationEssentials.docc/Curation/Fundamentals/DatesAndTimes/Calendar.md

Returns the start of the day for a given date.

```APIDOC
## startOfDay(for:)

### Description
Returns the start of the day for a given date.

### Method
Function

### Parameters
- **date** (Date) - Required - The date to get the start of day for.

### Return Value
The start of the day.
```

--------------------------------

### init(_:)-(UInt8)

Source: https://github.com/swiftlang/swift-foundation/blob/main/Sources/FoundationEssentials/FoundationEssentials.docc/Curation/Fundamentals/NumbersAndBasicValues/Decimal.md

Creates a decimal from a UInt8 value.

```APIDOC
## init(_:)-(UInt8)

### Description
Creates a decimal from a UInt8 value.

### Method
Initializer

### Signature
`init(_ value: UInt8)`

### Parameters
- **value** (UInt8) - Required - The UInt8 value to convert.

```

--------------------------------

### Call-site with subRegions(of:)

Source: https://github.com/swiftlang/swift-foundation/blob/main/Proposals/0028-locale-region-category.md

Example call-site showing the less fluent reading of the alternative label.

```swift
let continent = Locale.Region(<some continentCode>)
let territories = continent.subRegions(of: .territory)
```

--------------------------------

### init(_:)-(Int64)

Source: https://github.com/swiftlang/swift-foundation/blob/main/Sources/FoundationEssentials/FoundationEssentials.docc/Curation/Fundamentals/NumbersAndBasicValues/Decimal.md

Creates a decimal from an Int64 value.

```APIDOC
## init(_:)-(Int64)

### Description
Creates a decimal from an Int64 value.

### Method
Initializer

### Signature
`init(_ value: Int64)`

### Parameters
- **value** (Int64) - Required - The Int64 value to convert.

```

--------------------------------

### init(_:)

Source: https://github.com/swiftlang/swift-foundation/blob/main/Sources/FoundationEssentials/FoundationEssentials.docc/Curation/Fundamentals/DatesAndTimes/Locale/MeasurementSystem-swift.struct.md

Creates a measurement system instance from a given value. Use this initializer to instantiate a measurement system with a specific identifier.

```APIDOC
## init(_:)

### Description
Creates a measurement system instance from a given value.

### Declaration
`init(_ value: SomeType)`

### Parameters
- **value** - The value to initialize the measurement system from.

### Discussion
Use this initializer to create a measurement system instance. The exact type of the parameter is not specified in the source.
```

--------------------------------

### Simplified usage with partial range

Source: https://github.com/swiftlang/swift-foundation/blob/main/Proposals/0032-calendar-recurrence-rule-partial-range.md

The above example becomes simpler using the new partial range overload.

```swift
for date in recurrence.recurrences(of: birthday, in: rangeStart...) {
    // All occurrences of `birthday` after 2000
}
```

--------------------------------

### init(from:)

Source: https://github.com/swiftlang/swift-foundation/blob/main/Sources/FoundationEssentials/FoundationEssentials.docc/Curation/Fundamentals/DatesAndTimes/Date/HTTPFormatStyle.md

Creates an HTTP format style by decoding from a decoder.

```APIDOC
## init(from:)

### Description
Creates an HTTP format style by decoding from a decoder.

### Method
Initializer

### Signature
`init(from decoder: Decoder) throws`

### Parameters
- **decoder** (Decoder) - Required - The decoder to read data from.

### Throws
An error if decoding fails.

### Example
```swift
let style = try Date.HTTPFormatStyle(from: decoder)
```
```

--------------------------------

### init(_:)-(UInt16)

Source: https://github.com/swiftlang/swift-foundation/blob/main/Sources/FoundationEssentials/FoundationEssentials.docc/Curation/Fundamentals/NumbersAndBasicValues/Decimal.md

Creates a decimal from a UInt16 value.

```APIDOC
## init(_:)-(UInt16)

### Description
Creates a decimal from a UInt16 value.

### Method
Initializer

### Signature
`init(_ value: UInt16)`

### Parameters
- **value** (UInt16) - Required - The UInt16 value to convert.

```

--------------------------------

### subscript(dynamicMember:) -> Double

Source: https://github.com/swiftlang/swift-foundation/blob/main/Proposals/0023-progress-manager.md

Gets or sets custom double properties where both value and summary types are Double.

```APIDOC
## subscript(dynamicMember:) -> Double

### Description
Gets or sets custom double properties. Provides read-write access to custom progress properties where both the value and summary types are `Double`. If the property has not been set, the getter returns the property's default value.

### Method
subscript(dynamicMember:)

### Parameters
- **key** (KeyPath<ProgressManager.Properties, P.Type>) - Required - A key path to the custom double property type.

### Return Value
Double

```

--------------------------------

### init()

Source: https://github.com/swiftlang/swift-foundation/blob/main/Sources/FoundationEssentials/FoundationEssentials.docc/Curation/FilesAndDataPersistence/ArchivesAndSerialization/PropertyListEncoder.md

Creates a new property list encoder.

```APIDOC
## init()

### Description
Creates a new property list encoder.

### Method
Initializer

### Endpoint
N/A (SDK method)

### Parameters
None

### Request Example
N/A

### Response
#### Success Response
- **Returns** (PropertyListEncoder) - A new encoder instance.

#### Response Example
N/A
```

--------------------------------

### subscript(dynamicMember:) -> Duration

Source: https://github.com/swiftlang/swift-foundation/blob/main/Proposals/0023-progress-manager.md

Gets or sets custom duration properties where both value and summary types are Duration.

```APIDOC
## subscript(dynamicMember:) -> Duration

### Description
Gets or sets custom duration properties. Provides read-write access to custom progress properties where both the value and summary types are `Duration`. If the property has not been set, the getter returns the property's default value.

### Method
subscript(dynamicMember:)

### Parameters
- **key** (KeyPath<ProgressManager.Properties, P.Type>) - Required - A key path to the custom duration property type.

### Return Value
Duration

```

--------------------------------

### subscript(dynamicMember:) -> Int

Source: https://github.com/swiftlang/swift-foundation/blob/main/Proposals/0023-progress-manager.md

Gets or sets custom integer properties where both value and summary types are Int.

```APIDOC
## subscript(dynamicMember:) -> Int

### Description
Gets or sets custom integer properties. Provides read-write access to custom progress properties where both the value and summary types are `Int`. If the property has not been set, the getter returns the property's default value.

### Method
subscript(dynamicMember:)

### Parameters
- **key** (KeyPath<ProgressManager.Properties, P.Type>) - Required - A key path to the custom integer property type.

### Return Value
Int

```

--------------------------------

### Closure-based run() with output decoding and standard input writing

Source: https://github.com/swiftlang/swift-foundation/blob/main/Proposals/0007-swift-subprocess.md

These examples demonstrate the closure-based run() methods. The first uses curl to call a REST API, collects the standard output chunks, and decodes them into a Codable type. The second runs an executable from a path, writes to standard input, and collects the standard output as an array of bytes.

```swift
// Use curl to call REST API
struct MyType: Codable { ... }

let result = try await run(
    .name("curl"),
    arguments: ["/some/rest/api"]
) {
    var buffer = Data()
    for try await chunk in $0.standardOutput {
        buffer += chunk
    }
    return try JSONDecoder().decode(MyType.self, from: buffer)
}
// Result will have type `MyType`
print("Result: \(result)")

// Perform custom write and write the standard output
let result = try await run(
    .path("/some/executable")
) { subprocess, writer in
    try await writer.write("Hello World".utf8CString)
    try await writer.finish()
    return try await Array(subprocess.standardOutput)
}
```

--------------------------------

### init(string:)

Source: https://github.com/swiftlang/swift-foundation/blob/main/Sources/FoundationEssentials/FoundationEssentials.docc/Curation/Fundamentals/NumbersAndBasicValues/URL.md

Creates a URL from a string. This initializer is used to construct a URL from a string representation.

```APIDOC
## init(string:)

### Description
Creates a URL from a string.

### Method
Initializer

### Parameters
- **string** (String) - Required - The string to create the URL from.

### Return Value
A URL instance.
```

--------------------------------

### init(_:strategy:)

Source: https://github.com/swiftlang/swift-foundation/blob/main/Sources/FoundationInternationalization/FoundationInternationalization.docc/Curation/Extension-FoundationEssentials/URL.md

Creates a URL by parsing a string using the provided parse strategy.

```APIDOC
## init(_:strategy:)

### Description
Creates a URL by parsing a string using the provided parse strategy.

### Method
init(_:strategy:)

### Parameters
- **value** (String) - Required - The string to parse.
- **strategy** (ParseStrategy) - Required - The parse strategy to use.

### Return Value
A URL instance.

### Example
```swift
let url = URL("https://example.com", strategy: someStrategy)
```
```

--------------------------------

### Reducing predicates with && operator

Source: https://github.com/swiftlang/swift-foundation/blob/main/Proposals/0036-initializers-join-predicates.md

Example of reducing an array of predicates with the && operator, but noted as increasing type checker load.

```swift
let additionalPredicates = [authorPredicate, publicationDatePredicate, genrePredicate]
let result = additionalPredicates.reduce(onSalePredicate, &&)
```

--------------------------------

### init(base:prefix:)

Source: https://github.com/swiftlang/swift-foundation/blob/main/Sources/FoundationEssentials/FoundationEssentials.docc/Curation/Fundamentals/FiltersAndSorting/PredicateExpressions/SequenceStartsWith.md

Creates a sequence-starts-with expression with the given base sequence and prefix sequence.

```APIDOC
## init(base:prefix:)

### Description
Creates a sequence-starts-with expression with the given base sequence and prefix sequence.

### Declaration
```swift
init(base: Base, prefix: Prefix)
```

### Parameters
- **base** - The base sequence to check.
- **prefix** - The prefix sequence to compare against the start of the base sequence.

```

--------------------------------

### dates(byAdding:startingAt:in:wrappingComponents:)

Source: https://github.com/swiftlang/swift-foundation/blob/main/Sources/FoundationEssentials/FoundationEssentials.docc/Curation/Fundamentals/DatesAndTimes/Calendar.md

Returns a sequence of dates by adding components to a starting date.

```APIDOC
## dates(byAdding:startingAt:in:wrappingComponents:)

### Description
Returns a sequence of dates by adding components to a starting date.

### Method
Function

### Parameters
- **components** (DateComponents) - Required - The components to add.
- **start** (Date) - Required - The starting date.
- **calendar** (Calendar) - Required - The calendar to use.
- **wrappingComponents** (Bool) - Optional - Whether to wrap components.

### Return Value
A sequence of dates.
```

--------------------------------

### init(_:)

Source: https://github.com/swiftlang/swift-foundation/blob/main/Sources/FoundationEssentials/FoundationEssentials.docc/Curation/Fundamentals/DatesAndTimes/Locale/NumberingSystem-swift.struct.md

Creates a numbering system instance from a given value.

```APIDOC
## init(_:)

### Description
Creates a numbering system instance from a given value.

### Method
Initializer

### Parameters
- **value** (unspecified) - Required - The value to initialize the numbering system from.

### Response
Returns a new `Locale.NumberingSystem` instance.
```

--------------------------------

### init(_:)-(Int32)

Source: https://github.com/swiftlang/swift-foundation/blob/main/Sources/FoundationEssentials/FoundationEssentials.docc/Curation/Fundamentals/NumbersAndBasicValues/Decimal.md

Creates a decimal from an Int32 value.

```APIDOC
## init(_:)-(Int32)

### Description
Creates a decimal from an Int32 value.

### Method
Initializer

### Signature
`init(_ value: Int32)`

### Parameters
- **value** (Int32) - Required - The Int32 value to convert.

```

--------------------------------

### Declaring preferredLocales in Locale

Source: https://github.com/swiftlang/swift-foundation/blob/main/Proposals/0026-preferredLocales.md

Shows the proposed declaration of the static property `preferredLocales` on `Locale`, available starting in FoundationPreview 6.2.

```swift
public struct Locale : Hashable, Equatable, Sendable {

    /// Returns a list of the user’s preferred locales, as specified in Language & Region settings, taking into account any per-app language overrides.
    @available(FoundationPreview 6.2, *)
    public static var preferredLocales: [Locale]
}
```

--------------------------------

### Example of empty result for higher category

Source: https://github.com/swiftlang/swift-foundation/blob/main/Proposals/0028-locale-region-category.md

Shows that passing a category higher in the hierarchy than self returns an empty array.

```swift
argentina.subRegions(in: .world) // []
```

--------------------------------

### init(_:)

Source: https://github.com/swiftlang/swift-foundation/blob/main/Sources/FoundationEssentials/FoundationEssentials.docc/Curation/Fundamentals/NumbersAndBasicValues/URL/Template.md

Initializes a URL template with the given string. Use this initializer to create a template for URL generation.

```APIDOC
## init(_:)

### Description
Initializes a URL template with the given string. Use this initializer to create a template for URL generation.

### Method
Initializer

### Parameters
- **templateString** (String) - Required - The string to use as the template.

### Request Example
```swift
let template = URL.Template("https://example.com/{path}")
```

### Response
No return value.
```

--------------------------------

### debugDescription

Source: https://github.com/swiftlang/swift-foundation/blob/main/Sources/FoundationEssentials/FoundationEssentials.docc/Curation/Fundamentals/DatesAndTimes/Locale/Variant-swift.struct.md

A textual representation of the variant suitable for debugging. Use this property to get a debug description.

```APIDOC
## debugDescription

### Description
A textual representation of the variant suitable for debugging.

### Property
- **debugDescription** (String) - The debug description of the variant.
```
Tokens:
Raw