blob: 9217a327b0208845cbcb3961d0938f958165eb04 [file] [edit]
<!DOCTYPE html>
<html>
<head>
<meta charset="utf-8">
<title>Struct LogInterpolatedStringHandler </title>
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<meta name="title" content="Struct LogInterpolatedStringHandler ">
<meta name="description" content="Core interpolated string handler that defers string construction until the log level is confirmed enabled, avoiding unnecessary string allocations when logging is disabled.">
<link rel="icon" href="../images/favicon.ico">
<link rel="stylesheet" href="../public/docfx.min.css">
<link rel="stylesheet" href="../public/main.css">
<meta name="docfx:navrel" content="../toc.html">
<meta name="docfx:tocrel" content="toc.html">
<meta name="docfx:rel" content="../">
<meta name="docfx:docurl" content="https://github.com/SeleniumHQ/selenium/new/docfix/apiSpec/new?filename=OpenQA_Selenium_Internal_Logging_LogInterpolatedStringHandler.md&amp;value=---%0Auid%3A%20OpenQA.Selenium.Internal.Logging.LogInterpolatedStringHandler%0Asummary%3A%20&#39;*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax&#39;%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A">
<meta name="loc:inThisArticle" content="In this article">
<meta name="loc:searchResultsCount" content="{count} results for &quot;{query}&quot;">
<meta name="loc:searchNoResults" content="No results for &quot;{query}&quot;">
<meta name="loc:tocFilter" content="Filter by title">
<meta name="loc:nextArticle" content="Next">
<meta name="loc:prevArticle" content="Previous">
<meta name="loc:themeLight" content="Light">
<meta name="loc:themeDark" content="Dark">
<meta name="loc:themeAuto" content="Auto">
<meta name="loc:changeTheme" content="Change theme">
<meta name="loc:copy" content="Copy">
<meta name="loc:downloadPdf" content="Download PDF">
<script type="module" src="./../public/docfx.min.js"></script>
<script>
const theme = localStorage.getItem('theme') || 'auto'
document.documentElement.setAttribute('data-bs-theme', theme === 'auto' ? (window.matchMedia('(prefers-color-scheme: dark)').matches ? 'dark' : 'light') : theme)
</script>
</head>
<body class="tex2jax_ignore" data-layout="" data-yaml-mime="ManagedReference">
<header class="bg-body border-bottom">
<nav id="autocollapse" class="navbar navbar-expand-md" role="navigation">
<div class="container-xxl flex-nowrap">
<a class="navbar-brand" href="../index.html">
<img id="logo" class="svg" src="../images/logo.svg" alt="Selenium .NET API">
Selenium .NET API
</a>
<button class="btn btn-lg d-md-none border-0" type="button" data-bs-toggle="collapse" data-bs-target="#navpanel" aria-controls="navpanel" aria-expanded="false" aria-label="Toggle navigation">
<i class="bi bi-three-dots"></i>
</button>
<div class="collapse navbar-collapse" id="navpanel">
<div id="navbar">
<form class="search" role="search" id="search">
<i class="bi bi-search"></i>
<input class="form-control" id="search-query" type="search" disabled placeholder="Search" autocomplete="off" aria-label="Search">
</form>
</div>
</div>
</div>
</nav>
</header>
<main class="container-xxl">
<div class="toc-offcanvas">
<div class="offcanvas-md offcanvas-start" tabindex="-1" id="tocOffcanvas" aria-labelledby="tocOffcanvasLabel">
<div class="offcanvas-header">
<h5 class="offcanvas-title" id="tocOffcanvasLabel">Table of Contents</h5>
<button type="button" class="btn-close" data-bs-dismiss="offcanvas" data-bs-target="#tocOffcanvas" aria-label="Close"></button>
</div>
<div class="offcanvas-body">
<nav class="toc" id="toc"></nav>
</div>
</div>
</div>
<div class="content">
<div class="actionbar">
<button class="btn btn-lg border-0 d-md-none" type="button" data-bs-toggle="offcanvas" data-bs-target="#tocOffcanvas" aria-controls="tocOffcanvas" aria-expanded="false" aria-label="Show table of contents">
<i class="bi bi-list"></i>
</button>
<nav id="breadcrumb"></nav>
</div>
<article data-uid="OpenQA.Selenium.Internal.Logging.LogInterpolatedStringHandler">
<h1 id="OpenQA_Selenium_Internal_Logging_LogInterpolatedStringHandler" data-uid="OpenQA.Selenium.Internal.Logging.LogInterpolatedStringHandler" class="text-break">
Struct LogInterpolatedStringHandler <a class="header-action link-secondary" title="View source" href="https://github.com/SeleniumHQ/selenium/blob/docfix/dotnet/src/webdriver/Internal/Logging/LogInterpolatedStringHandler.cs/#L245"><i class="bi bi-code-slash"></i></a>
</h1>
<div class="facts text-secondary">
<dl><dt>Namespace</dt><dd><a class="xref" href="OpenQA.html">OpenQA</a>.<a class="xref" href="OpenQA.Selenium.html">Selenium</a>.<a class="xref" href="OpenQA.Selenium.Internal.html">Internal</a>.<a class="xref" href="OpenQA.Selenium.Internal.Logging.html">Logging</a></dd></dl>
<dl><dt>Assembly</dt><dd>Selenium.WebDriver.dll</dd></dl>
</div>
<div class="markdown summary"><p>Core interpolated string handler that defers string construction until the log level is confirmed enabled,
avoiding unnecessary string allocations when logging is disabled.</p>
</div>
<div class="markdown conceptual"></div>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public ref struct LogInterpolatedStringHandler</code></pre>
</div>
<dl class="typelist inheritedMembers">
<dt>Inherited Members</dt>
<dd>
<div>
<a class="xref" href="https://learn.microsoft.com/dotnet/api/system.valuetype.equals">ValueType.Equals(object)</a>
</div>
<div>
<a class="xref" href="https://learn.microsoft.com/dotnet/api/system.valuetype.gethashcode">ValueType.GetHashCode()</a>
</div>
<div>
<a class="xref" href="https://learn.microsoft.com/dotnet/api/system.valuetype.tostring">ValueType.ToString()</a>
</div>
<div>
<a class="xref" href="https://learn.microsoft.com/dotnet/api/system.object.equals#system-object-equals(system-object-system-object)">object.Equals(object, object)</a>
</div>
<div>
<a class="xref" href="https://learn.microsoft.com/dotnet/api/system.object.referenceequals">object.ReferenceEquals(object, object)</a>
</div>
<div>
<a class="xref" href="https://learn.microsoft.com/dotnet/api/system.object.gettype">object.GetType()</a>
</div>
</dd></dl>
<h2 id="OpenQA_Selenium_Internal_Logging_LogInterpolatedStringHandler_remarks">Remarks</h2>
<div class="markdown level0 remarks"><p>On <code>net8.0</code> and later this delegates to <code>System.Runtime.CompilerServices.DefaultInterpolatedStringHandler</code>,
which uses pooled character buffers and <code>ISpanFormattable</code> to avoid boxing of value-type arguments.
On older target frameworks a <code>System.Text.StringBuilder</code> is used. All formatting is performed using
<a class="xref" href="https://learn.microsoft.com/dotnet/api/system.globalization.cultureinfo.invariantculture">InvariantCulture</a> so log output is culture-independent.</p>
</div>
<h2 class="section" id="constructors">Constructors
</h2>
<a id="OpenQA_Selenium_Internal_Logging_LogInterpolatedStringHandler__ctor_" data-uid="OpenQA.Selenium.Internal.Logging.LogInterpolatedStringHandler.#ctor*"></a>
<h3 id="OpenQA_Selenium_Internal_Logging_LogInterpolatedStringHandler__ctor_System_Int32_System_Int32_OpenQA_Selenium_Internal_Logging_ILogger_OpenQA_Selenium_Internal_Logging_LogEventLevel_System_Boolean__" data-uid="OpenQA.Selenium.Internal.Logging.LogInterpolatedStringHandler.#ctor(System.Int32,System.Int32,OpenQA.Selenium.Internal.Logging.ILogger,OpenQA.Selenium.Internal.Logging.LogEventLevel,System.Boolean@)">
LogInterpolatedStringHandler(int, int, ILogger, LogEventLevel, out bool)
<a class="header-action link-secondary" title="View source" href="https://github.com/SeleniumHQ/selenium/blob/docfix/dotnet/src/webdriver/Internal/Logging/LogInterpolatedStringHandler.cs/#L263"><i class="bi bi-code-slash"></i></a>
</h3>
<div class="markdown level1 summary"><p>Initializes a new instance of the <a class="xref" href="OpenQA.Selenium.Internal.Logging.LogInterpolatedStringHandler.html">LogInterpolatedStringHandler</a> struct.</p>
</div>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public LogInterpolatedStringHandler(int literalLength, int formattedCount, ILogger logger, LogEventLevel level, out bool isEnabled)</code></pre>
</div>
<h4 class="section">Parameters</h4>
<dl class="parameters">
<dt><code>literalLength</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.int32">int</a></dt>
<dd><p>The number of literal characters in the interpolated string.</p>
</dd>
<dt><code>formattedCount</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.int32">int</a></dt>
<dd><p>The number of interpolation holes in the interpolated string.</p>
</dd>
<dt><code>logger</code> <a class="xref" href="OpenQA.Selenium.Internal.Logging.ILogger.html">ILogger</a></dt>
<dd><p>The logger to check for enabled status.</p>
</dd>
<dt><code>level</code> <a class="xref" href="OpenQA.Selenium.Internal.Logging.LogEventLevel.html">LogEventLevel</a></dt>
<dd><p>The log event level to check.</p>
</dd>
<dt><code>isEnabled</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.boolean">bool</a></dt>
<dd><p>On return, indicates whether logging is enabled for this level.</p>
</dd>
</dl>
<h2 class="section" id="methods">Methods
</h2>
<a id="OpenQA_Selenium_Internal_Logging_LogInterpolatedStringHandler_AppendFormatted_" data-uid="OpenQA.Selenium.Internal.Logging.LogInterpolatedStringHandler.AppendFormatted*"></a>
<h3 id="OpenQA_Selenium_Internal_Logging_LogInterpolatedStringHandler_AppendFormatted__1___0_" data-uid="OpenQA.Selenium.Internal.Logging.LogInterpolatedStringHandler.AppendFormatted``1(``0)">
AppendFormatted&lt;T&gt;(T)
<a class="header-action link-secondary" title="View source" href="https://github.com/SeleniumHQ/selenium/blob/docfix/dotnet/src/webdriver/Internal/Logging/LogInterpolatedStringHandler.cs/#L301"><i class="bi bi-code-slash"></i></a>
</h3>
<div class="markdown level1 summary"><p>Appends a formatted value to the handler.</p>
</div>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public void AppendFormatted&lt;T&gt;(T value)</code></pre>
</div>
<h4 class="section">Parameters</h4>
<dl class="parameters">
<dt><code>value</code> <span class="xref">T</span></dt>
<dd><p>The value to format and append.</p>
</dd>
</dl>
<h4 class="section">Type Parameters</h4>
<dl class="parameters">
<dt><code>T</code></dt>
<dd><p>The type of the value to format.</p>
</dd>
</dl>
<a id="OpenQA_Selenium_Internal_Logging_LogInterpolatedStringHandler_AppendFormatted_" data-uid="OpenQA.Selenium.Internal.Logging.LogInterpolatedStringHandler.AppendFormatted*"></a>
<h3 id="OpenQA_Selenium_Internal_Logging_LogInterpolatedStringHandler_AppendFormatted__1___0_System_Int32_" data-uid="OpenQA.Selenium.Internal.Logging.LogInterpolatedStringHandler.AppendFormatted``1(``0,System.Int32)">
AppendFormatted&lt;T&gt;(T, int)
<a class="header-action link-secondary" title="View source" href="https://github.com/SeleniumHQ/selenium/blob/docfix/dotnet/src/webdriver/Internal/Logging/LogInterpolatedStringHandler.cs/#L361"><i class="bi bi-code-slash"></i></a>
</h3>
<div class="markdown level1 summary"><p>Appends a formatted value with alignment to the handler.</p>
</div>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public void AppendFormatted&lt;T&gt;(T value, int alignment)</code></pre>
</div>
<h4 class="section">Parameters</h4>
<dl class="parameters">
<dt><code>value</code> <span class="xref">T</span></dt>
<dd><p>The value to format and append.</p>
</dd>
<dt><code>alignment</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.int32">int</a></dt>
<dd><p>The alignment for the formatted value.</p>
</dd>
</dl>
<h4 class="section">Type Parameters</h4>
<dl class="parameters">
<dt><code>T</code></dt>
<dd><p>The type of the value to format.</p>
</dd>
</dl>
<a id="OpenQA_Selenium_Internal_Logging_LogInterpolatedStringHandler_AppendFormatted_" data-uid="OpenQA.Selenium.Internal.Logging.LogInterpolatedStringHandler.AppendFormatted*"></a>
<h3 id="OpenQA_Selenium_Internal_Logging_LogInterpolatedStringHandler_AppendFormatted__1___0_System_Int32_System_String_" data-uid="OpenQA.Selenium.Internal.Logging.LogInterpolatedStringHandler.AppendFormatted``1(``0,System.Int32,System.String)">
AppendFormatted&lt;T&gt;(T, int, string?)
<a class="header-action link-secondary" title="View source" href="https://github.com/SeleniumHQ/selenium/blob/docfix/dotnet/src/webdriver/Internal/Logging/LogInterpolatedStringHandler.cs/#L373"><i class="bi bi-code-slash"></i></a>
</h3>
<div class="markdown level1 summary"><p>Appends a formatted value with alignment and a format string to the handler.</p>
</div>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public void AppendFormatted&lt;T&gt;(T value, int alignment, string? format)</code></pre>
</div>
<h4 class="section">Parameters</h4>
<dl class="parameters">
<dt><code>value</code> <span class="xref">T</span></dt>
<dd><p>The value to format and append.</p>
</dd>
<dt><code>alignment</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.int32">int</a></dt>
<dd><p>The alignment for the formatted value.</p>
</dd>
<dt><code>format</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.string">string</a></dt>
<dd><p>The format string.</p>
</dd>
</dl>
<h4 class="section">Type Parameters</h4>
<dl class="parameters">
<dt><code>T</code></dt>
<dd><p>The type of the value to format.</p>
</dd>
</dl>
<a id="OpenQA_Selenium_Internal_Logging_LogInterpolatedStringHandler_AppendFormatted_" data-uid="OpenQA.Selenium.Internal.Logging.LogInterpolatedStringHandler.AppendFormatted*"></a>
<h3 id="OpenQA_Selenium_Internal_Logging_LogInterpolatedStringHandler_AppendFormatted__1___0_System_String_" data-uid="OpenQA.Selenium.Internal.Logging.LogInterpolatedStringHandler.AppendFormatted``1(``0,System.String)">
AppendFormatted&lt;T&gt;(T, string?)
<a class="header-action link-secondary" title="View source" href="https://github.com/SeleniumHQ/selenium/blob/docfix/dotnet/src/webdriver/Internal/Logging/LogInterpolatedStringHandler.cs/#L331"><i class="bi bi-code-slash"></i></a>
</h3>
<div class="markdown level1 summary"><p>Appends a formatted value with a format string to the handler.</p>
</div>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public void AppendFormatted&lt;T&gt;(T value, string? format)</code></pre>
</div>
<h4 class="section">Parameters</h4>
<dl class="parameters">
<dt><code>value</code> <span class="xref">T</span></dt>
<dd><p>The value to format and append.</p>
</dd>
<dt><code>format</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.string">string</a></dt>
<dd><p>The format string.</p>
</dd>
</dl>
<h4 class="section">Type Parameters</h4>
<dl class="parameters">
<dt><code>T</code></dt>
<dd><p>The type of the value to format.</p>
</dd>
</dl>
<a id="OpenQA_Selenium_Internal_Logging_LogInterpolatedStringHandler_AppendLiteral_" data-uid="OpenQA.Selenium.Internal.Logging.LogInterpolatedStringHandler.AppendLiteral*"></a>
<h3 id="OpenQA_Selenium_Internal_Logging_LogInterpolatedStringHandler_AppendLiteral_System_String_" data-uid="OpenQA.Selenium.Internal.Logging.LogInterpolatedStringHandler.AppendLiteral(System.String)">
AppendLiteral(string)
<a class="header-action link-secondary" title="View source" href="https://github.com/SeleniumHQ/selenium/blob/docfix/dotnet/src/webdriver/Internal/Logging/LogInterpolatedStringHandler.cs/#L284"><i class="bi bi-code-slash"></i></a>
</h3>
<div class="markdown level1 summary"><p>Appends a literal string to the handler.</p>
</div>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public void AppendLiteral(string s)</code></pre>
</div>
<h4 class="section">Parameters</h4>
<dl class="parameters">
<dt><code>s</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.string">string</a></dt>
<dd><p>The literal string to append.</p>
</dd>
</dl>
</article>
<div class="contribution d-print-none">
<a href="https://github.com/SeleniumHQ/selenium/blob/docfix/dotnet/src/webdriver/Internal/Logging/LogInterpolatedStringHandler.cs/#L245" class="edit-link">Edit this page</a>
</div>
</div>
<div class="affix">
<nav id="affix"></nav>
</div>
</main>
<div class="container-xxl search-results" id="search-results"></div>
<footer class="border-top text-secondary">
<div class="container-xxl">
<div class="flex-fill">
<span>Made with <a href="https://dotnet.github.io/docfx">docfx</a></span>
</div>
</div>
</footer>
</body>
</html>