Add some NotNullWhen attributes

lay295 · Oct 6, 2023 · 870c667 · 870c667
1 parent 904186b
commit 870c667
Show file tree

Hide file tree

Showing 2 changed files with 10 additions and 7 deletions.
diff --git a/TwitchDownloaderCore/ChatRenderer.cs b/TwitchDownloaderCore/ChatRenderer.cs
@@ -5,6 +5,7 @@
 using System.Collections.Concurrent;
 using System.Collections.Generic;
 using System.Diagnostics;
+using System.Diagnostics.CodeAnalysis;
 using System.Globalization;
 using System.IO;
 using System.Linq;
@@ -814,7 +815,7 @@ private void DrawFragmentPart(List<(SKImageInfo info, SKBitmap bitmap)> sectionI
                 DrawRegularMessage(sectionImages, emotePositionList, ref drawPos, defaultPos, bitsCount, fragmentPart, highlightWords);
             }
 
-            static bool TryGetTwitchEmote(List<TwitchEmote> twitchEmoteList, ReadOnlySpan<char> emoteName, out TwitchEmote twitchEmote)
+            static bool TryGetTwitchEmote(List<TwitchEmote> twitchEmoteList, ReadOnlySpan<char> emoteName, [NotNullWhen(true)] out TwitchEmote twitchEmote)
             {
                 // Enumerating over a span is faster than a list
                 var emoteListSpan = CollectionsMarshal.AsSpan(twitchEmoteList);
@@ -827,7 +828,7 @@ static bool TryGetTwitchEmote(List<TwitchEmote> twitchEmoteList, ReadOnlySpan<ch
                     }
                 }
 
-                twitchEmote = default;
+                twitchEmote = null;
                 return false;
             }
         }
@@ -1076,7 +1077,7 @@ private void DrawRegularMessage(List<(SKImageInfo info, SKBitmap bitmap)> sectio
                 DrawText(fragmentString, messageFont, true, sectionImages, ref drawPos, defaultPos, highlightWords);
             }
 
-            static bool TryGetCheerEmote(List<CheerEmote> cheerEmoteList, ReadOnlySpan<char> prefix, out CheerEmote cheerEmote)
+            static bool TryGetCheerEmote(List<CheerEmote> cheerEmoteList, ReadOnlySpan<char> prefix, [NotNullWhen(true)] out CheerEmote cheerEmote)
             {
                 // Enumerating over a span is faster than a list
                 var cheerEmoteListSpan = CollectionsMarshal.AsSpan(cheerEmoteList);
@@ -1089,7 +1090,7 @@ static bool TryGetCheerEmote(List<CheerEmote> cheerEmoteList, ReadOnlySpan<char>
                     }
                 }
 
-                cheerEmote = default;
+                cheerEmote = null;
                 return false;
             }
         }
@@ -1125,7 +1126,7 @@ private void DrawFirstPartyEmote(List<(SKImageInfo info, SKBitmap bitmap)> secti
                 DrawText(fragment.text, messageFont, true, sectionImages, ref drawPos, defaultPos, highlightWords);
             }
 
-            static bool TryGetTwitchEmote(List<TwitchEmote> twitchEmoteList, ReadOnlySpan<char> emoteId, out TwitchEmote twitchEmote)
+            static bool TryGetTwitchEmote(List<TwitchEmote> twitchEmoteList, ReadOnlySpan<char> emoteId, [NotNullWhen(true)] out TwitchEmote twitchEmote)
             {
                 // Enumerating over a span is faster than a list
                 var emoteListSpan = CollectionsMarshal.AsSpan(twitchEmoteList);
@@ -1138,7 +1139,7 @@ static bool TryGetTwitchEmote(List<TwitchEmote> twitchEmoteList, ReadOnlySpan<ch
                     }
                 }
 
-                twitchEmote = default;
+                twitchEmote = null;
                 return false;
             }
         }

diff --git a/TwitchDownloaderWPF/Services/ThumbnailService.cs b/TwitchDownloaderWPF/Services/ThumbnailService.cs
@@ -1,4 +1,5 @@
 using System;
+using System.Diagnostics.CodeAnalysis;
 using System.Windows.Media.Imaging;
 
 namespace TwitchDownloaderWPF.Services
@@ -7,6 +8,7 @@ public static class ThumbnailService
     {
         public const string THUMBNAIL_MISSING_URL = @"https://vod-secure.twitch.tv/_404/404_processing_320x180.png";
 
+        /// <exception cref="ArgumentNullException">The <paramref name="thumbUrl"/> was <see langword="null"/></exception>
         public static BitmapImage GetThumb(string thumbUrl, BitmapCacheOption cacheOption = BitmapCacheOption.OnLoad)
         {
             ArgumentNullException.ThrowIfNull(thumbUrl);
@@ -25,7 +27,7 @@ public static BitmapImage GetThumb(string thumbUrl, BitmapCacheOption cacheOptio
             return img;
         }
 
-        public static bool TryGetThumb(string thumbUrl, out BitmapImage thumbnail)
+        public static bool TryGetThumb(string thumbUrl, [NotNullWhen(true)] out BitmapImage thumbnail)
         {
             if (string.IsNullOrWhiteSpace(thumbUrl))
             {