| 1 |
efrain |
1 |
//
|
|
|
2 |
// AFIError.swift
|
|
|
3 |
//
|
|
|
4 |
// Copyright (c) 2015 Alamofire Software Foundation (http://alamofire.org/)
|
|
|
5 |
//
|
|
|
6 |
// Permission is hereby granted, free of charge, to any person obtaining a copy
|
|
|
7 |
// of this software and associated documentation files (the "Software"), to deal
|
|
|
8 |
// in the Software without restriction, including without limitation the rights
|
|
|
9 |
// to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
|
|
10 |
// copies of the Software, and to permit persons to whom the Software is
|
|
|
11 |
// furnished to do so, subject to the following conditions:
|
|
|
12 |
//
|
|
|
13 |
// The above copyright notice and this permission notice shall be included in
|
|
|
14 |
// all copies or substantial portions of the Software.
|
|
|
15 |
//
|
|
|
16 |
// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
|
|
17 |
// IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
|
|
18 |
// FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
|
|
19 |
// AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
|
|
20 |
// LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
|
|
21 |
// OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
|
|
|
22 |
// THE SOFTWARE.
|
|
|
23 |
//
|
|
|
24 |
|
|
|
25 |
import Alamofire
|
|
|
26 |
import Foundation
|
|
|
27 |
|
|
|
28 |
/// `AFIError` is the error type returned by AlamofireImage.
|
|
|
29 |
///
|
|
|
30 |
/// - requestCancelled: The request was explicitly cancelled.
|
|
|
31 |
/// - imageSerializationFailed: Response data could not be serialized into an image.
|
|
|
32 |
public enum AFIError: Error {
|
|
|
33 |
case requestCancelled
|
|
|
34 |
case imageSerializationFailed
|
|
|
35 |
case alamofireError(AFError)
|
|
|
36 |
}
|
|
|
37 |
|
|
|
38 |
// MARK: - Error Booleans
|
|
|
39 |
|
|
|
40 |
extension AFIError {
|
|
|
41 |
/// Returns `true` if the `AFIError` is a request cancellation error, `false` otherwise.
|
|
|
42 |
public var isRequestCancelledError: Bool {
|
|
|
43 |
if case .requestCancelled = self { return true }
|
|
|
44 |
return false
|
|
|
45 |
}
|
|
|
46 |
|
|
|
47 |
/// Returns `true` if the `AFIError` is an image serialization error, `false` otherwise.
|
|
|
48 |
public var isImageSerializationFailedError: Bool {
|
|
|
49 |
if case .imageSerializationFailed = self { return true }
|
|
|
50 |
return false
|
|
|
51 |
}
|
|
|
52 |
|
|
|
53 |
public var isAlamofireError: Bool {
|
|
|
54 |
if case .alamofireError = self { return true }
|
|
|
55 |
return false
|
|
|
56 |
}
|
|
|
57 |
}
|
|
|
58 |
|
|
|
59 |
// MARK: - Error Descriptions
|
|
|
60 |
|
|
|
61 |
extension AFIError: LocalizedError {
|
|
|
62 |
public var errorDescription: String? {
|
|
|
63 |
switch self {
|
|
|
64 |
case .requestCancelled:
|
|
|
65 |
return "The request was explicitly cancelled."
|
|
|
66 |
case .imageSerializationFailed:
|
|
|
67 |
return "Response data could not be serialized into an image."
|
|
|
68 |
case let .alamofireError(error):
|
|
|
69 |
return "Request failed due to an underlying Alamofire error: \(error.localizedDescription)"
|
|
|
70 |
}
|
|
|
71 |
}
|
|
|
72 |
}
|