/*
* Copyright (c) 2023 Vaughn Nugent
*
* Library: VNLib
* Package: VNLib.Plugins.Extensions.Loading
* File: LoggingExtensions.cs
*
* LoggingExtensions.cs is part of VNLib.Plugins.Extensions.Loading which is part of the larger
* VNLib collection of libraries and utilities.
*
* VNLib.Plugins.Extensions.Loading is free software: you can redistribute it and/or modify
* it under the terms of the GNU Affero General Public License as
* published by the Free Software Foundation, either version 3 of the
* License, or (at your option) any later version.
*
* VNLib.Plugins.Extensions.Loading is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU Affero General Public License for more details.
*
* You should have received a copy of the GNU Affero General Public License
* along with this program. If not, see https://www.gnu.org/licenses/.
*/
using System;
using VNLib.Utils.Logging;
namespace VNLib.Plugins.Extensions.Loading
{
///
/// Provides advanced QOL features for event logging
///
public static class LoggingExtensions
{
///
/// Creates a new that scopes all log messages to the specified name
/// when writing messages
///
///
/// The name of the scope to print log values to
/// The scoped log provider instance
public static ILogProvider CreateScope(this ILogProvider log, string scopeName)
{
return new ScopeLogProvider(log, scopeName);
}
private sealed record class ScopeLogProvider(ILogProvider Log, string ScopeName) : ILogProvider
{
///
public void Flush() => Log.Flush();
///
public object GetLogProvider() => Log.GetLogProvider();
///
public bool IsEnabled(LogLevel level) => Log.IsEnabled(level);
///
public void Write(LogLevel level, string value)
{
Log.Write(level, $"[{ScopeName}]: {value}");
}
///
public void Write(LogLevel level, Exception exception, string value = "")
{
Log.Write(level, exception, $"[{ScopeName}]: {value}");
}
///
public void Write(LogLevel level, string value, params object?[] args)
{
Log.Write(level, $"[{ScopeName}]: {value}", args);
}
///
public void Write(LogLevel level, string value, params ValueType[] args)
{
Log.Write(level, $"[{ScopeName}]: {value}", args);
}
}
}
}