Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Storage async await #8289

Merged
merged 18 commits into from
Jul 23, 2021
Merged

Storage async await #8289

Changes from 1 commit
Commits
Show all changes
18 commits
Select commit Hold shift + click to select a range
11d52f7
Storage async await WIP
paulb777 Jun 22, 2021
6dbdd0f
Style and available
paulb777 Jun 22, 2021
cff5439
Fix build for Xcode 12.5
paulb777 Jun 25, 2021
fe4475c
style
paulb777 Jun 25, 2021
b5fea43
Use continuations
paulb777 Jun 25, 2021
7950d7e
style
paulb777 Jun 25, 2021
2ce439e
more tests
paulb777 Jun 27, 2021
fe66e51
more tests
paulb777 Jul 1, 2021
49775c0
Add writeAwait
paulb777 Jul 10, 2021
e863361
Resume with
paulb777 Jul 12, 2021
967e8ae
APIs with Async not Await
paulb777 Jul 13, 2021
8284cf5
typo
paulb777 Jul 13, 2021
33de2d7
Docs for new APIs
paulb777 Jul 14, 2021
7467a8c
style
paulb777 Jul 14, 2021
1d19bd1
Xcode 13 Beta 3 update
paulb777 Jul 15, 2021
25d0386
Only Task
paulb777 Jul 15, 2021
c47f35f
Update Changelog
paulb777 Jul 20, 2021
f8acfda
Address review feedback
paulb777 Jul 23, 2021
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
Prev Previous commit
Next Next commit
Docs for new APIs
  • Loading branch information
@paulb777
paulb777 committed Jul 23, 2021
commit 33de2d793a9511f0ab5a4c9c7b32584b064c09ef
30 changes: 29 additions & 1 deletion FirebaseStorageSwift/Sources/AsyncAwait.swift
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,14 @@ import FirebaseStorage
#if swift(>=5.5)
@available(iOS 15, *)
public extension StorageReference {
/// Asynchronously downloads the object at the StorageReference to a Data object in memory.
/// A Data object of the provided max size will be allocated, so ensure that the device has enough free
/// memory to complete the download. For downloading large files, write may be a better option.
paulb777 marked this conversation as resolved.
Show resolved Hide resolved
///
/// - Parameters:
/// - size: The maximum size in bytes to download. If the download exceeds this size
paulb777 marked this conversation as resolved.
Show resolved Hide resolved
/// the task will be cancelled and an error will be thrown.
/// - Returns: Data object.
func data(maxSize: Int64) async throws -> Data {
typealias DataContinuation = CheckedContinuation<Data, Error>
return try await withCheckedThrowingContinuation { (continuation: DataContinuation) in
Expand All @@ -26,7 +34,15 @@ import FirebaseStorage
}
}
}

/// Asynchronously uploads data to the currently specified StorageReference.
/// This is not recommended for large files, and one should instead upload a file from disk.
/// in the Firebase Console if desired.
paulb777 marked this conversation as resolved.
Show resolved Hide resolved
///
/// - Parameters:
/// - uploadData: The Data to upload.
/// - metadata: Optional StorageMetadata containing additional information (MIME type, etc.)
/// about the object being uploaded.
/// - Returns: StorageMetadata containing additional information about the object being uploaded.
func putDataAsync(_ uploadData: Data,
metadata: StorageMetadata? = nil) async throws -> StorageMetadata {
typealias MetadataContinuation = CheckedContinuation<StorageMetadata, Error>
Expand All @@ -38,6 +54,13 @@ import FirebaseStorage
}
}

/// Asynchronously uploads a file to the currently specified StorageReference.
///
/// - Parameters:
/// - url: A URL representing the system file path of the object to be uploaded.
/// - metadata: Optional StorageMetadata containing additional information (MIME type, etc.)
/// about the object being uploaded.
/// - Returns: StorageMetadata containing additional information about the object being uploaded.
func putFileAsync(from url: URL,
metadata: StorageMetadata? = nil) async throws -> StorageMetadata {
typealias MetadataContinuation = CheckedContinuation<StorageMetadata, Error>
Expand All @@ -49,6 +72,11 @@ import FirebaseStorage
}
}

/// Asynchronously downloads the object at the current path to a specified system filepath.
///
/// - Parameters:
/// - fileUrl: A URL representing the system file path of the object to be uploaded.
/// - Returns: URL pointing to the file path of the downloaded file.
func writeAsync(toFile fileURL: URL) async throws -> URL {
typealias URLContinuation = CheckedContinuation<URL, Error>
return try await withCheckedThrowingContinuation { (continuation: URLContinuation) in
Expand Down