/// <inheritdoc cref="Format(LogEvent,TextWriter,IFormatProvider)"/>
public static string Format(
[NotNull] LogEvent @event,
[CanBeNull] IFormatProvider formatProvider = null)
{
if (@event == null)
{
throw new ArgumentNullException(nameof(@event));
}
if (@event.MessageTemplate == null)
{
return(string.Empty);
}
if (!TemplateTokenizer.CanContainNamedTokens(@event.MessageTemplate))
{
return(@event.MessageTemplate);
}
var builder = StringBuilderCache.Acquire(@event.MessageTemplate.Length * 2);
var writer = new StringWriter(builder);
FormatInternal(@event, writer, formatProvider);
StringBuilderCache.Release(builder);
return(builder.ToString());
}
/// <summary>
/// <para>Renders given <paramref name="event"/>'s message using its <see cref="LogEvent.MessageTemplate"/> and <see cref="LogEvent.Properties"/>.</para>
/// <para>Performs substitution of property placeholders present in message template.</para>
/// <para>Uses template syntax defined for <see cref="OutputTemplate"/> (with one key difference outlined below).</para>
/// <para>Unlike to <see cref="LogEventFormatter"/>, there are no special predefined properties during message formatting. Only event properties are used.</para>
/// <para>Example message template: <c>'Hello, {User}! You have {UnreadCount:D5} messages to read.'</c></para>
/// </summary>
public static void Format(
[NotNull] LogEvent @event,
[NotNull] TextWriter writer,
[CanBeNull] IFormatProvider formatProvider = null)
{
if (@event == null)
{
throw new ArgumentNullException(nameof(@event));
}
if (writer == null)
{
throw new ArgumentNullException(nameof(writer));
}
if (@event.MessageTemplate == null)
{
return;
}
if (!TemplateTokenizer.CanContainNamedTokens(@event.MessageTemplate))
{
if (@event.MessageTemplate.Length > 0)
{
writer.Write(@event.MessageTemplate);
}
}
else
{
FormatInternal(@event, writer, formatProvider);
}
}
public static void Format(
[NotNull] LogEvent @event,
[NotNull] TextWriter writer,
[CanBeNull] object value,
[CanBeNull] string format = null,
[CanBeNull] IFormatProvider formatProvider = null)
{
if (@event == null)
{
throw new ArgumentNullException(nameof(@event));
}
if (writer == null)
{
throw new ArgumentNullException(nameof(writer));
}
if (value is OperationContextValue contextValue)
{
value = contextValue.ToString();
}
if (value is not string template || !TemplateTokenizer.CanContainNamedTokens(template))
{
PropertyValueFormatter.Format(writer, value, format, formatProvider);
return;
}
var tokens = TemplatesCache.ObtainTokens(template);
PaddingFormatHelper.TryParseFormat(format, out var insertLeadingSpace, out var insertTrailingSpace);
if (insertLeadingSpace)
{
writer.WriteSpace();
}
foreach (var token in tokens)
{
token.Render(@event, writer, formatProvider);
}
if (insertTrailingSpace)
{
writer.WriteSpace();
}
}