docs and rename

NLog · May 21, 2019 · fcb1f8a · fcb1f8a
1 parent f65a0ae
commit fcb1f8a
Show file tree

Hide file tree

Showing 3 changed files with 8 additions and 3 deletions.
diff --git a/src/NLog/Internal/CollectionExtensions.cs b/src/NLog/Internal/CollectionExtensions.cs
@@ -39,7 +39,12 @@ namespace NLog.Internal
 {
     internal static class CollectionExtensions
     {
-        public static IList<TItem> FilterList<TItem,TState>([NotNull] this IList<TItem> items, TState state, Func<TItem, TState, bool> filter)
+        /// <summary>
+        /// Memory optimized filtering
+        /// </summary>
+        /// <remarks>Passing state too avoid delegate capture and memory-allocations.</remarks>
+        [NotNull]
+        public static IList<TItem> Filter<TItem, TState>([NotNull] this IList<TItem> items, TState state, Func<TItem, TState, bool> filter)
         {
             var hasIgnoredLogEvents = false;
             IList<TItem> filterLogEvents = null;

diff --git a/src/NLog/Targets/Wrappers/FilteringTargetWrapper.cs b/src/NLog/Targets/Wrappers/FilteringTargetWrapper.cs
@@ -138,7 +138,7 @@ protected override void Write(AsyncLogEventInfo logEvent)
         /// <inheritdoc/>
         protected override void Write(IList<AsyncLogEventInfo> logEvents)
         {
-            var filterLogEvents = logEvents.FilterList(Filter, ShouldLogEvent);
+            var filterLogEvents = logEvents.Filter(Filter, ShouldLogEvent);
             WrappedTarget.WriteAsyncLogEvents(filterLogEvents);
         }
 

diff --git a/src/NLog/Targets/Wrappers/PostFilteringTargetWrapper.cs b/src/NLog/Targets/Wrappers/PostFilteringTargetWrapper.cs
@@ -165,7 +165,7 @@ protected override void Write(IList<AsyncLogEventInfo> logEvents)
             else
             {
                 InternalLogger.Trace("PostFilteringWrapper(Name={0}): Filter to apply: {1}", Name, resultFilter);
-                var resultBuffer = logEvents.FilterList(resultFilter, ApplyFilter);
+                var resultBuffer = logEvents.Filter(resultFilter, ApplyFilter);
                 InternalLogger.Trace("PostFilteringWrapper(Name={0}): After filtering: {1} events.", Name, resultBuffer.Count);
                 if (resultBuffer.Count > 0)
                 {