|
| 1 | +// Copyright 2021 Google LLC |
| 2 | +// |
| 3 | +// Licensed under the Apache License, Version 2.0 (the "License"); |
| 4 | +// you may not use this file except in compliance with the License. |
| 5 | +// You may obtain a copy of the License at |
| 6 | +// |
| 7 | +// http://www.apache.org/licenses/LICENSE-2.0 |
| 8 | +// |
| 9 | +// Unless required by applicable law or agreed to in writing, software |
| 10 | +// distributed under the License is distributed on an "AS IS" BASIS, |
| 11 | +// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. |
| 12 | +// See the License for the specific language governing permissions and |
| 13 | +// limitations under the License. |
| 14 | + |
| 15 | +import FirebaseStorage |
| 16 | + |
| 17 | +#if swift(>=5.5) |
| 18 | + @available(iOS 15, *) |
| 19 | + public extension StorageReference { |
| 20 | + /// Asynchronously downloads the object at the StorageReference to a Data object in memory. |
| 21 | + /// A Data object of the provided max size will be allocated, so ensure that the device has |
| 22 | + /// enough free memory to complete the download. For downloading large files, the `write` |
| 23 | + /// API may be a better option. |
| 24 | + /// |
| 25 | + /// - Parameters: |
| 26 | + /// - size: The maximum size in bytes to download. If the download exceeds this size, |
| 27 | + /// the task will be cancelled and an error will be thrown. |
| 28 | + /// - Returns: Data object. |
| 29 | + func data(maxSize: Int64) async throws -> Data { |
| 30 | + typealias DataContinuation = CheckedContinuation<Data, Error> |
| 31 | + return try await withCheckedThrowingContinuation { (continuation: DataContinuation) in |
| 32 | + // TODO: Use task to handle progress and cancellation. |
| 33 | + _ = self.getData(maxSize: maxSize) { result in |
| 34 | + continuation.resume(with: result) |
| 35 | + } |
| 36 | + } |
| 37 | + } |
| 38 | + |
| 39 | + /// Asynchronously uploads data to the currently specified StorageReference. |
| 40 | + /// This is not recommended for large files, and one should instead upload a file from disk |
| 41 | + /// from the Firebase Console. |
| 42 | + /// |
| 43 | + /// - Parameters: |
| 44 | + /// - uploadData: The Data to upload. |
| 45 | + /// - metadata: Optional StorageMetadata containing additional information (MIME type, etc.) |
| 46 | + /// about the object being uploaded. |
| 47 | + /// - Returns: StorageMetadata with additional information about the object being uploaded. |
| 48 | + func putDataAsync(_ uploadData: Data, |
| 49 | + metadata: StorageMetadata? = nil) async throws -> StorageMetadata { |
| 50 | + typealias MetadataContinuation = CheckedContinuation<StorageMetadata, Error> |
| 51 | + return try await withCheckedThrowingContinuation { (continuation: MetadataContinuation) in |
| 52 | + // TODO: Use task to handle progress and cancellation. |
| 53 | + _ = self.putData(uploadData, metadata: metadata) { result in |
| 54 | + continuation.resume(with: result) |
| 55 | + } |
| 56 | + } |
| 57 | + } |
| 58 | + |
| 59 | + /// Asynchronously uploads a file to the currently specified StorageReference. |
| 60 | + /// |
| 61 | + /// - Parameters: |
| 62 | + /// - url: A URL representing the system file path of the object to be uploaded. |
| 63 | + /// - metadata: Optional StorageMetadata containing additional information (MIME type, etc.) |
| 64 | + /// about the object being uploaded. |
| 65 | + /// - Returns: StorageMetadata with additional information about the object being uploaded. |
| 66 | + func putFileAsync(from url: URL, |
| 67 | + metadata: StorageMetadata? = nil) async throws -> StorageMetadata { |
| 68 | + typealias MetadataContinuation = CheckedContinuation<StorageMetadata, Error> |
| 69 | + return try await withCheckedThrowingContinuation { (continuation: MetadataContinuation) in |
| 70 | + // TODO: Use task to handle progress and cancellation. |
| 71 | + _ = self.putFile(from: url, metadata: metadata) { result in |
| 72 | + continuation.resume(with: result) |
| 73 | + } |
| 74 | + } |
| 75 | + } |
| 76 | + |
| 77 | + /// Asynchronously downloads the object at the current path to a specified system filepath. |
| 78 | + /// |
| 79 | + /// - Parameters: |
| 80 | + /// - fileUrl: A URL representing the system file path of the object to be uploaded. |
| 81 | + /// - Returns: URL pointing to the file path of the downloaded file. |
| 82 | + func writeAsync(toFile fileURL: URL) async throws -> URL { |
| 83 | + typealias URLContinuation = CheckedContinuation<URL, Error> |
| 84 | + return try await withCheckedThrowingContinuation { (continuation: URLContinuation) in |
| 85 | + // TODO: Use task to handle progress and cancellation. |
| 86 | + _ = self.write(toFile: fileURL) { result in |
| 87 | + continuation.resume(with: result) |
| 88 | + } |
| 89 | + } |
| 90 | + } |
| 91 | + } |
| 92 | +#endif |
0 commit comments