Add ResultPointer.

CesiumGS · Oct 29, 2024 · d43edce · d43edce
1 parent 49f1d63
commit d43edce
Show file tree

Hide file tree

Showing 7 changed files with 29 additions and 28 deletions.
diff --git a/Cesium3DTilesSelection/src/TileContentLoadInfo.cpp b/Cesium3DTilesSelection/src/TileContentLoadInfo.cpp
@@ -9,7 +9,7 @@ TileContentLoadInfo::TileContentLoadInfo(
     const std::shared_ptr<IPrepareRendererResources>&
         pPrepareRendererResources_,
     const std::shared_ptr<spdlog::logger>& pLogger_,
-    const CesiumUtility::IntrusivePointer<TilesetSharedAssetSystem>
+    const CesiumUtility::IntrusivePointer<TilesetSharedAssetSystem>&
         pSharedAssetSystem_,
     const TilesetContentOptions& contentOptions_,
     const Tile& tile)

diff --git a/Cesium3DTilesSelection/src/TileContentLoadInfo.h b/Cesium3DTilesSelection/src/TileContentLoadInfo.h
@@ -25,7 +25,7 @@ struct TileContentLoadInfo {
       const std::shared_ptr<IPrepareRendererResources>&
           pPrepareRendererResources,
       const std::shared_ptr<spdlog::logger>& pLogger,
-      const CesiumUtility::IntrusivePointer<TilesetSharedAssetSystem>
+      const CesiumUtility::IntrusivePointer<TilesetSharedAssetSystem>&
           pSharedAssetSystem,
       const TilesetContentOptions& contentOptions,
       const Tile& tile);

diff --git a/CesiumAsync/include/CesiumAsync/SharedAssetDepot.h b/CesiumAsync/include/CesiumAsync/SharedAssetDepot.h
@@ -47,11 +47,11 @@ class CESIUMASYNC_API SharedAssetDepot
    */
   int64_t staleAssetSizeLimit = 16 * 1024 * 1024;
 
-  using FactorySignature = CesiumAsync::Future<
-      CesiumUtility::Result<CesiumUtility::IntrusivePointer<TAssetType>>>(
-      const AsyncSystem& asyncSystem,
-      const std::shared_ptr<IAssetAccessor>& pAssetAccessor,
-      const TAssetKey& key);
+  using FactorySignature =
+      CesiumAsync::Future<CesiumUtility::ResultPointer<TAssetType>>(
+          const AsyncSystem& asyncSystem,
+          const std::shared_ptr<IAssetAccessor>& pAssetAccessor,
+          const TAssetKey& key);
 
   SharedAssetDepot(std::function<FactorySignature> factory)
       : _factory(std::move(factory)) {}
@@ -78,9 +78,7 @@ class CESIUMASYNC_API SharedAssetDepot
    * @param assetKey The key uniquely identifying the asset to get or create.
    * @return A shared future that resolves when the asset is ready or fails.
    */
-  SharedFuture<
-      CesiumUtility::Result<CesiumUtility::IntrusivePointer<TAssetType>>>
-  getOrCreate(
+  SharedFuture<CesiumUtility::ResultPointer<TAssetType>> getOrCreate(
       const AsyncSystem& asyncSystem,
       const std::shared_ptr<IAssetAccessor>& pAssetAccessor,
       const TAssetKey& assetKey) {
@@ -154,9 +152,8 @@ class CESIUMASYNC_API SharedAssetDepot
                   return pEntry->toResult();
                 });
 
-    SharedFuture<
-        CesiumUtility::Result<CesiumUtility::IntrusivePointer<TAssetType>>>
-        sharedFuture = std::move(future).share();
+    SharedFuture<CesiumUtility::ResultPointer<TAssetType>> sharedFuture =
+        std::move(future).share();
 
     pEntry->maybePendingAsset = sharedFuture;
 
@@ -315,8 +312,7 @@ class CESIUMASYNC_API SharedAssetDepot
      * future that will resolve when the asset load is complete. This field will
      * be empty if the asset finished loading, including if it failed to load.
      */
-    std::optional<SharedFuture<
-        CesiumUtility::Result<CesiumUtility::IntrusivePointer<TAssetType>>>>
+    std::optional<SharedFuture<CesiumUtility::ResultPointer<TAssetType>>>
         maybePendingAsset;
 
     /**
@@ -340,15 +336,13 @@ class CESIUMASYNC_API SharedAssetDepot
      */
     CesiumUtility::DoublyLinkedListPointers<AssetEntry> deletionListPointers;
 
-    CesiumUtility::Result<CesiumUtility::IntrusivePointer<TAssetType>>
-    toResult() const {
-      return CesiumUtility::Result<CesiumUtility::IntrusivePointer<TAssetType>>(
+    CesiumUtility::ResultPointer<TAssetType> toResult() const {
+      return CesiumUtility::ResultPointer<TAssetType>(
           pAsset.get(),
           errorsAndWarnings);
     }
 
-    SharedFuture<
-        CesiumUtility::Result<CesiumUtility::IntrusivePointer<TAssetType>>>
+    SharedFuture<CesiumUtility::ResultPointer<TAssetType>>
     toFuture(const AsyncSystem& asyncSystem) const {
       if (this->maybePendingAsset) {
         return *this->maybePendingAsset;

diff --git a/CesiumGltfReader/src/GltfReader.cpp b/CesiumGltfReader/src/GltfReader.cpp
@@ -535,7 +535,7 @@ void CesiumGltfReader::GltfReader::postprocessGltf(
                 const std::shared_ptr<IAssetAccessor>& pAssetAccessor,
                 const std::string& uri,
                 const std::vector<IAssetAccessor::THeader>& headers)
-            -> SharedFuture<Result<IntrusivePointer<ImageAsset>>> {
+            -> SharedFuture<ResultPointer<ImageAsset>> {
           NetworkImageAssetDescriptor assetKey{
               uri,
               headers,
@@ -554,12 +554,11 @@ void CesiumGltfReader::GltfReader::postprocessGltf(
           }
         };
 
-        SharedFuture<Result<IntrusivePointer<ImageAsset>>> future =
+        SharedFuture<ResultPointer<ImageAsset>> future =
             getAsset(asyncSystem, pAssetAccessor, uri, tHeaders);
 
         resolvedBuffers.push_back(future.thenInWorkerThread(
-            [pImage = &image](
-                const Result<IntrusivePointer<ImageAsset>>& loadedImage) {
+            [pImage = &image](const ResultPointer<ImageAsset>& loadedImage) {
               std::string imageUri = *pImage->uri;
               pImage->uri = std::nullopt;
 

diff --git a/CesiumGltfReader/src/GltfSharedAssetSystem.cpp b/CesiumGltfReader/src/GltfSharedAssetSystem.cpp
@@ -15,7 +15,7 @@ CesiumUtility::IntrusivePointer<GltfSharedAssetSystem> createDefault() {
       [](const AsyncSystem& asyncSystem,
          const std::shared_ptr<IAssetAccessor>& pAssetAccessor,
          const NetworkImageAssetDescriptor& key)
-          -> Future<Result<IntrusivePointer<ImageAsset>>> {
+          -> Future<ResultPointer<ImageAsset>> {
         return key.load(asyncSystem, pAssetAccessor);
       }));
 

diff --git a/CesiumGltfReader/src/NetworkImageAssetDescriptor.cpp b/CesiumGltfReader/src/NetworkImageAssetDescriptor.cpp
@@ -32,14 +32,14 @@ bool NetworkImageAssetDescriptor::operator==(
              this->ktx2TranscodeTargets.UASTC_RGBA;
 }
 
-Future<Result<IntrusivePointer<ImageAsset>>> NetworkImageAssetDescriptor::load(
+Future<ResultPointer<ImageAsset>> NetworkImageAssetDescriptor::load(
     const AsyncSystem& asyncSystem,
     const std::shared_ptr<IAssetAccessor>& pAssetAccessor) const {
   return this->loadBytesFromNetwork(asyncSystem, pAssetAccessor)
       .thenInWorkerThread([ktx2TranscodeTargets = this->ktx2TranscodeTargets](
                               Result<std::vector<std::byte>>&& result) {
         if (!result.value) {
-          return Result<IntrusivePointer<ImageAsset>>(result.errors);
+          return ResultPointer<ImageAsset>(result.errors);
         }
 
         ImageReaderResult imageResult =
@@ -48,7 +48,7 @@ Future<Result<IntrusivePointer<ImageAsset>>> NetworkImageAssetDescriptor::load(
         result.errors.merge(
             ErrorList{imageResult.errors, imageResult.warnings});
 
-        return Result<IntrusivePointer<ImageAsset>>(
+        return ResultPointer<ImageAsset>(
             imageResult.pImage,
             std::move(result.errors));
       });

diff --git a/CesiumUtility/include/CesiumUtility/Result.h b/CesiumUtility/include/CesiumUtility/Result.h
@@ -75,4 +75,12 @@ template <typename T> struct Result<CesiumUtility::IntrusivePointer<T>> {
   ErrorList errors;
 };
 
+/**
+ * @brief A convenient shortcut for
+ * `CesiumUtility::Result<CesiumUtility::IntrusivePointer<T>>`.
+ *
+ * @tparam T The type of object that the IntrusivePointer points to.
+ */
+template <typename T> using ResultPointer = Result<IntrusivePointer<T>>;
+
 } // namespace CesiumUtility