File: ResultAdditions.swift

package info (click to toggle)
swiftlang 6.1.3-1
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid
  • size: 2,791,532 kB
  • sloc: cpp: 9,901,743; ansic: 2,201,431; asm: 1,091,827; python: 308,252; objc: 82,166; f90: 80,126; lisp: 38,358; pascal: 25,559; sh: 20,429; ml: 5,058; perl: 4,745; makefile: 4,484; awk: 3,535; javascript: 3,018; xml: 918; fortran: 664; cs: 573; ruby: 396
file content (57 lines) | stat: -rw-r--r-- 2,274 bytes parent folder | download
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
//
// This source file is part of the Swift.org open source project
//
// Copyright (c) 2023 Apple Inc. and the Swift project authors
// Licensed under Apache License v2.0 with Runtime Library Exception
//
// See https://swift.org/LICENSE.txt for license information
// See https://swift.org/CONTRIBUTORS.txt for Swift project authors
//

extension Result {
  /// Handle this instance as if it were returned from a call to `#expect()`.
  ///
  /// - Warning: This function is used to implement the `#expect()` and
  ///   `#require()` macros. Do not call it directly.
  @inlinable public func __expected() where Success == Void {}

  /// Handle this instance as if it were returned from a call to `#require()`.
  ///
  /// - Warning: This function is used to implement the `#expect()` and
  ///   `#require()` macros. Do not call it directly.
  @inlinable public func __required() throws -> Success {
    try get()
  }
}

// MARK: - Optional success values

extension Result {
  /// Handle this instance as if it were returned from a call to `#expect()`.
  ///
  /// - Warning: This function is used to implement the `#expect()` and
  ///   `#require()` macros. Do not call it directly.
  @discardableResult @inlinable public func __expected<T>() -> Success where Success == T? {
    try? get()
  }

  /// Handle this instance as if it were returned from a call to `#require()`.
  ///
  /// This overload of `__require()` assumes that the result cannot actually be
  /// `nil` on success. The optionality is part of our ABI contract for the
  /// `__check()` function family so that we can support uninhabited types and
  /// "soft" failures.
  ///
  /// If the value really is `nil` (e.g. we're dealing with `Never`), the
  /// testing library throws an error representing an issue of kind
  /// ``Issue/Kind-swift.enum/apiMisused``.
  ///
  /// - Warning: This function is used to implement the `#expect()` and
  ///   `#require()` macros. Do not call it directly.
  @discardableResult public func __required<T>() throws -> T where Success == T? {
    guard let result = try get() else {
      throw APIMisuseError(description: "Could not unwrap 'nil' value of type Optional<\(T.self)>. Consider using #expect() instead of #require() here.")
    }
    return result
  }
}