Merge pull request #16 from IvanMurzak/feature/future

Feature/future

Author: IvanMurzak

.vscode/settings.json

@@ -1,4 +1,4 @@
-{
+{
     "files.exclude":
     {
         "**/.DS_Store":true,
@@ -51,5 +51,9 @@
         "ProjectSettings/":true,
         "temp/":true,
         "Temp/":true
-    }
+    },
+    "dotnet.preferCSharpExtension": true,
+    "cSpell.words": [
+        "ARGB"
+    ]
 }

.vscode/tasks.json

@@ -0,0 +1,41 @@
+{
+    "version": "2.0.0",
+    "tasks": [
+        {
+            "label": "build",
+            "command": "dotnet",
+            "type": "process",
+            "args": [
+                "build",
+                "${workspaceFolder}/Unity-ImageLoader.sln",
+                "/property:GenerateFullPaths=true",
+                "/consoleloggerparameters:NoSummary;ForceNoAlign"
+            ],
+            "problemMatcher": "$msCompile"
+        },
+        {
+            "label": "publish",
+            "command": "dotnet",
+            "type": "process",
+            "args": [
+                "publish",
+                "${workspaceFolder}/Unity-ImageLoader.sln",
+                "/property:GenerateFullPaths=true",
+                "/consoleloggerparameters:NoSummary;ForceNoAlign"
+            ],
+            "problemMatcher": "$msCompile"
+        },
+        {
+            "label": "watch",
+            "command": "dotnet",
+            "type": "process",
+            "args": [
+                "watch",
+                "run",
+                "--project",
+                "${workspaceFolder}/Unity-ImageLoader.sln"
+            ],
+            "problemMatcher": "$msCompile"
+        }
+    ]
+}

Assets/Samples/SampleAwaitAndForget.cs

@@ -0,0 +1,23 @@
+using Extensions.Unity.ImageLoader;
+using UnityEngine;
+using UnityEngine.UI;
+
+public class SampleAwaitAndForget : MonoBehaviour
+{
+    [SerializeField] string imageURL;
+    [SerializeField] Image image;
+
+    async void Start()
+    {
+        // Load image and wait
+        await ImageLoader.LoadSprite(imageURL);
+
+        // Load image, set image and wait
+        await ImageLoader.LoadSprite(imageURL).ThenSet(image);
+
+        // Let's skip waiting for completion.
+        // To do that we can simply remove 'await' from the start.
+        // To avoid compilation warning need to add '.Forget()'.
+        ImageLoader.LoadSprite(imageURL).ThenSet(image).Forget();
+    }
+}

Assets/Samples/SampleAwaitAndForget.cs.meta

@@ -1,7 +1,7 @@
 using Extensions.Unity.ImageLoader;
 using UnityEngine;
 
-static class CacheSample
+static class SampleCache
 {
     static string url = "";
     static Sprite sprite;

Assets/Samples/CacheSample.cs renamed to Assets/Samples/SampleCache.cs

@@ -0,0 +1,70 @@
+using Extensions.Unity.ImageLoader;
+using System.Threading;
+using UnityEngine;
+using UnityEngine.UI;
+
+public class SampleCancellation : MonoBehaviour
+{
+    [SerializeField] string imageURL;
+    [SerializeField] Image image;
+
+    void Start()
+    {
+        ImageLoader.LoadSprite(imageURL) // load sprite
+            .ThenSet(image) // if success set sprite into image
+            .CancelOnDestroy(this) // cancel OnDestroy event of current gameObject
+            .Forget();
+
+        ImageLoader.LoadSprite(imageURL) // load sprite
+            .ThenSet(image) // if success set sprite into image
+            .Failed(exception => Debug.LogException(exception)) // if fail print exception
+            .CancelOnDestroy(this) // cancel OnDestroy event of current gameObject
+            .Forget();
+
+        ImageLoader.LoadSprite(imageURL) // load sprite
+            .ThenSet(image) // if success set sprite into image
+            .Then(sprite => image.gameObject.SetActive(true)) // if success activate gameObject
+            .Failed(exception => image.gameObject.SetActive(false)) // if fail deactivate gameObject
+            .Cancelled(() => Debug.Log("ImageLoading cancelled")) // if cancelled
+            .CancelOnDisable(this) // cancel OnDisable event of current gameObject
+            .Forget();
+    }
+
+    void SimpleCancellation()
+    {
+        var future = ImageLoader.LoadSprite(imageURL).ThenSet(image);
+        future.Cancel();
+    }
+
+    void CancellationTokenSample1()
+    {
+        var cancellationTokenSource = new CancellationTokenSource();
+
+        // loading with attached cancellation token
+        ImageLoader.LoadSprite(imageURL, cancellationToken: cancellationTokenSource.Token)
+            .ThenSet(image)
+            .Forget();
+
+        cancellationTokenSource.Cancel(); // canceling
+    }
+
+    void CancellationTokenSample2()
+    {
+        var cancellationTokenSource = new CancellationTokenSource();
+
+        ImageLoader.LoadSprite(imageURL)
+            .ThenSet(image)
+            .Register(cancellationTokenSource.Token) // registering cancellation token
+            .Forget();
+
+        cancellationTokenSource.Cancel(); // canceling
+    }
+
+    void DisposeSample()
+    {
+        using (var future = ImageLoader.LoadSprite(imageURL).ThenSet(image))
+        {
+            // future would be canceled and disposed outside of the brackets
+        }
+    }
+}

Assets/Samples/CacheSample.cs.meta renamed to Assets/Samples/SampleCache.cs.meta

@@ -0,0 +1,23 @@
+using Extensions.Unity.ImageLoader;
+using UnityEngine;
+using UnityEngine.UI;
+
+public class SampleErrorHandle : MonoBehaviour
+{
+    [SerializeField] string imageURL;
+    [SerializeField] Image image;
+
+    void Start()
+    {
+        ImageLoader.LoadSprite(imageURL) // load sprite
+            .ThenSet(image) // if success set sprite into image
+            .Failed(exception => Debug.LogException(exception)) // if fail print exception
+            .Forget();
+
+        ImageLoader.LoadSprite(imageURL) // load sprite
+            .ThenSet(image) // if success set sprite into image
+            .Then(sprite => image.gameObject.SetActive(true)) // if success activate gameObject
+            .Failed(exception => image.gameObject.SetActive(false)) // if fail deactivate gameObject
+            .Forget();
+    }
+}