1
0
mirror of https://github.com/oliverbooth/X10D synced 2024-11-10 00:25:40 +00:00
X10D/api/X10D.Text.StringBuilderReader.html
2024-06-12 13:17:02 +00:00

821 lines
40 KiB
HTML

<!DOCTYPE html>
<!--[if IE]><![endif]-->
<html>
<head>
<meta charset="utf-8">
<meta http-equiv="X-UA-Compatible" content="IE=edge,chrome=1">
<title>Class StringBuilderReader
| X10D </title>
<meta name="viewport" content="width=device-width">
<meta name="title" content="Class StringBuilderReader
| X10D ">
<meta name="generator" content="docfx 2.56.7.0">
<link rel="shortcut icon" href="../images/favicon.png">
<link href="https://fonts.googleapis.com/css2?family=Roboto:wght@300;400;500;700&display=swap" rel="stylesheet">
<link rel="stylesheet" href="//cdnjs.cloudflare.com/ajax/libs/highlight.js/10.1.1/styles/night-owl.min.css">
<link rel="stylesheet" href="https://cdn.jsdelivr.net/npm/bootstrap-icons@1.7.2/font/bootstrap-icons.css" integrity="sha384-EvBWSlnoFgZlXJvpzS+MAUEjvN7+gcCwH+qh7GRFOGgZO0PuwOFro7qPOJnLfe7l" crossorigin="anonymous">
<link rel="stylesheet" href="../styles/config.css">
<link rel="stylesheet" href="../styles/discord.css">
<link rel="stylesheet" href="../styles/singulink.css">
<link rel="stylesheet" href="../styles/main.css">
<meta property="docfx:navrel" content="../toc.html">
<meta property="docfx:tocrel" content="toc.html">
<meta property="docfx:rel" content="../">
<meta property="docfx:newtab" content="true">
</head>
<body>
<div class="top-navbar">
<a class="burger-icon" onclick="toggleMenu()">
<svg name="Hamburger" style="vertical-align: middle;" width="34" height="34" viewbox="0 0 24 24"><path fill="currentColor" fill-rule="evenodd" clip-rule="evenodd" d="M20 6H4V9H20V6ZM4 10.999H20V13.999H4V10.999ZM4 15.999H20V18.999H4V15.999Z"></path></svg>
</a>
<a class="brand" href="../index.html">
<img src="../images/favicon.png" alt="X10D" class="logomark">
<span class="brand-title">X10D</span>
</a> </div>
<div class="body-content">
<div id="blackout" class="blackout" onclick="toggleMenu()"></div>
<nav id="sidebar" role="navigation">
<div class="sidebar">
<div>
<div class="mobile-hide">
<a class="brand" href="../index.html">
<img src="../images/favicon.png" alt="X10D" class="logomark">
<span class="brand-title">X10D</span>
</a> </div>
<div class="sidesearch">
<form id="search" role="search" class="search">
<i class="bi bi-search search-icon"></i>
<input type="text" id="search-query" placeholder="Search" autocomplete="off">
</form>
</div>
<div id="navbar">
</div>
</div> <div class="sidebar-item-separator"></div>
<div id="sidetoggle">
<div id="sidetoc"></div>
</div>
</div>
<div class="footer">
<strong>DocFX + Singulink = ♥</strong>
</div> </nav>
<main class="main-panel">
<div id="search-results" style="display: none;">
<h1 class="search-list">Search Results for <span></span></h1>
<div class="sr-items">
<p><i class="bi bi-hourglass-split index-loading"></i></p>
</div>
<ul id="pagination" data-first="First" data-prev="Previous" data-next="Next" data-last="Last"></ul>
</div>
<div role="main" class="hide-when-search">
<div class="subnav navbar navbar-default">
<div class="container hide-when-search" id="breadcrumb">
<ul class="breadcrumb">
<li></li>
</ul>
</div>
</div>
<article class="content wrap" id="_content" data-uid="X10D.Text.StringBuilderReader">
<h1 id="X10D_Text_StringBuilderReader" data-uid="X10D.Text.StringBuilderReader" class="text-break">Class StringBuilderReader
</h1>
<div class="markdown level0 summary"><p>Represents a <see cref="!:TextReader"></see> reads from a <see cref="!:StringBuilder"></see>.</p>
</div>
<div class="markdown level0 conceptual"></div>
<div class="inheritance">
<h5>Inheritance</h5>
<div class="level0"><span class="xref">System.Object</span></div>
<div class="level1"><span class="xref">StringBuilderReader</span></div>
</div>
<h6><strong>Namespace</strong>: <a class="xref" href="X10D.Text.html">X10D.Text</a></h6>
<h6><strong>Assembly</strong>: X10D.dll</h6>
<h5 id="X10D_Text_StringBuilderReader_syntax">Syntax</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public class StringBuilderReader : TextReader</code></pre>
</div>
<h3 id="constructors">Constructors
</h3>
<span class="small pull-right mobile-hide">
<span class="divider">|</span>
<a href="https://github.com/oliverbooth/X10D/new/main/apiSpec/new?filename=X10D_Text_StringBuilderReader__ctor_StringBuilder_.md&amp;value=---%0Auid%3A%20X10D.Text.StringBuilderReader.%23ctor(StringBuilder)%0Asummary%3A%20'*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax'%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A">Improve this Doc</a>
</span>
<span class="small pull-right mobile-hide">
<a href="https://github.com/oliverbooth/X10D/blob/main/X10D/src/Text/StringBuilderReader.cs/#L22">View Source</a>
</span>
<a id="X10D_Text_StringBuilderReader__ctor_" data-uid="X10D.Text.StringBuilderReader.#ctor*"></a>
<h4 id="X10D_Text_StringBuilderReader__ctor_StringBuilder_" data-uid="X10D.Text.StringBuilderReader.#ctor(StringBuilder)">StringBuilderReader(StringBuilder)</h4>
<div class="markdown level1 summary"><p>Initializes a new instance of the <a class="xref" href="X10D.Text.StringBuilderReader.html">StringBuilderReader</a> class.</p>
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public StringBuilderReader(StringBuilder stringBuilder)</code></pre>
</div>
<h5 class="parameters">Parameters</h5>
<table class="table table-bordered table-striped table-condensed">
<thead>
<tr>
<th>Type</th>
<th>Name</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td><span class="xref">StringBuilder</span></td>
<td><span class="parametername">stringBuilder</span></td>
<td><p>The <see cref="!:StringBuilder"></see> to wrap.</p>
</td>
</tr>
</tbody>
</table>
<h3 id="methods">Methods
</h3>
<span class="small pull-right mobile-hide">
<span class="divider">|</span>
<a href="https://github.com/oliverbooth/X10D/new/main/apiSpec/new?filename=X10D_Text_StringBuilderReader_Close.md&amp;value=---%0Auid%3A%20X10D.Text.StringBuilderReader.Close%0Asummary%3A%20'*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax'%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A">Improve this Doc</a>
</span>
<span class="small pull-right mobile-hide">
<a href="https://github.com/oliverbooth/X10D/blob/main/X10D/src/Text/StringBuilderReader.cs/#L28">View Source</a>
</span>
<a id="X10D_Text_StringBuilderReader_Close_" data-uid="X10D.Text.StringBuilderReader.Close*"></a>
<h4 id="X10D_Text_StringBuilderReader_Close" data-uid="X10D.Text.StringBuilderReader.Close">Close()</h4>
<div class="markdown level1 summary"></div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public override void Close()</code></pre>
</div>
<span class="small pull-right mobile-hide">
<span class="divider">|</span>
<a href="https://github.com/oliverbooth/X10D/new/main/apiSpec/new?filename=X10D_Text_StringBuilderReader_Peek.md&amp;value=---%0Auid%3A%20X10D.Text.StringBuilderReader.Peek%0Asummary%3A%20'*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax'%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A">Improve this Doc</a>
</span>
<span class="small pull-right mobile-hide">
<a href="https://github.com/oliverbooth/X10D/blob/main/X10D/src/Text/StringBuilderReader.cs/#L34">View Source</a>
</span>
<a id="X10D_Text_StringBuilderReader_Peek_" data-uid="X10D.Text.StringBuilderReader.Peek*"></a>
<h4 id="X10D_Text_StringBuilderReader_Peek" data-uid="X10D.Text.StringBuilderReader.Peek">Peek()</h4>
<div class="markdown level1 summary"></div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public override int Peek()</code></pre>
</div>
<h5 class="returns">Returns</h5>
<table class="table table-bordered table-striped table-condensed">
<thead>
<tr>
<th>Type</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td><span class="xref">System.Int32</span></td>
<td></td>
</tr>
</tbody>
</table>
<span class="small pull-right mobile-hide">
<span class="divider">|</span>
<a href="https://github.com/oliverbooth/X10D/new/main/apiSpec/new?filename=X10D_Text_StringBuilderReader_Read.md&amp;value=---%0Auid%3A%20X10D.Text.StringBuilderReader.Read%0Asummary%3A%20'*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax'%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A">Improve this Doc</a>
</span>
<span class="small pull-right mobile-hide">
<a href="https://github.com/oliverbooth/X10D/blob/main/X10D/src/Text/StringBuilderReader.cs/#L45">View Source</a>
</span>
<a id="X10D_Text_StringBuilderReader_Read_" data-uid="X10D.Text.StringBuilderReader.Read*"></a>
<h4 id="X10D_Text_StringBuilderReader_Read" data-uid="X10D.Text.StringBuilderReader.Read">Read()</h4>
<div class="markdown level1 summary"></div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public override int Read()</code></pre>
</div>
<h5 class="returns">Returns</h5>
<table class="table table-bordered table-striped table-condensed">
<thead>
<tr>
<th>Type</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td><span class="xref">System.Int32</span></td>
<td></td>
</tr>
</tbody>
</table>
<span class="small pull-right mobile-hide">
<span class="divider">|</span>
<a href="https://github.com/oliverbooth/X10D/new/main/apiSpec/new?filename=X10D_Text_StringBuilderReader_Read_Span_System_Char__.md&amp;value=---%0Auid%3A%20X10D.Text.StringBuilderReader.Read(Span%7BSystem.Char%7D)%0Asummary%3A%20'*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax'%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A">Improve this Doc</a>
</span>
<span class="small pull-right mobile-hide">
<a href="https://github.com/oliverbooth/X10D/blob/main/X10D/src/Text/StringBuilderReader.cs/#L90">View Source</a>
</span>
<a id="X10D_Text_StringBuilderReader_Read_" data-uid="X10D.Text.StringBuilderReader.Read*"></a>
<h4 id="X10D_Text_StringBuilderReader_Read_Span_System_Char__" data-uid="X10D.Text.StringBuilderReader.Read(Span{System.Char})">Read(Span&lt;Char&gt;)</h4>
<div class="markdown level1 summary"></div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public override int Read(Span&lt;char&gt; buffer)</code></pre>
</div>
<h5 class="parameters">Parameters</h5>
<table class="table table-bordered table-striped table-condensed">
<thead>
<tr>
<th>Type</th>
<th>Name</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td><span class="xref">Span</span>&lt;<span class="xref">System.Char</span>&gt;</td>
<td><span class="parametername">buffer</span></td>
<td></td>
</tr>
</tbody>
</table>
<h5 class="returns">Returns</h5>
<table class="table table-bordered table-striped table-condensed">
<thead>
<tr>
<th>Type</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td><span class="xref">System.Int32</span></td>
<td></td>
</tr>
</tbody>
</table>
<span class="small pull-right mobile-hide">
<span class="divider">|</span>
<a href="https://github.com/oliverbooth/X10D/new/main/apiSpec/new?filename=X10D_Text_StringBuilderReader_Read_System_Char___System_Int32_System_Int32_.md&amp;value=---%0Auid%3A%20X10D.Text.StringBuilderReader.Read(System.Char%5B%5D%2CSystem.Int32%2CSystem.Int32)%0Asummary%3A%20'*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax'%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A">Improve this Doc</a>
</span>
<span class="small pull-right mobile-hide">
<a href="https://github.com/oliverbooth/X10D/blob/main/X10D/src/Text/StringBuilderReader.cs/#L56">View Source</a>
</span>
<a id="X10D_Text_StringBuilderReader_Read_" data-uid="X10D.Text.StringBuilderReader.Read*"></a>
<h4 id="X10D_Text_StringBuilderReader_Read_System_Char___System_Int32_System_Int32_" data-uid="X10D.Text.StringBuilderReader.Read(System.Char[],System.Int32,System.Int32)">Read(Char[], Int32, Int32)</h4>
<div class="markdown level1 summary"></div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public override int Read(char[] buffer, int index, int count)</code></pre>
</div>
<h5 class="parameters">Parameters</h5>
<table class="table table-bordered table-striped table-condensed">
<thead>
<tr>
<th>Type</th>
<th>Name</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td><span class="xref">System.Char</span>[]</td>
<td><span class="parametername">buffer</span></td>
<td></td>
</tr>
<tr>
<td><span class="xref">System.Int32</span></td>
<td><span class="parametername">index</span></td>
<td></td>
</tr>
<tr>
<td><span class="xref">System.Int32</span></td>
<td><span class="parametername">count</span></td>
<td></td>
</tr>
</tbody>
</table>
<h5 class="returns">Returns</h5>
<table class="table table-bordered table-striped table-condensed">
<thead>
<tr>
<th>Type</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td><span class="xref">System.Int32</span></td>
<td></td>
</tr>
</tbody>
</table>
<span class="small pull-right mobile-hide">
<span class="divider">|</span>
<a href="https://github.com/oliverbooth/X10D/new/main/apiSpec/new?filename=X10D_Text_StringBuilderReader_ReadAsync_Memory_System_Char__CancellationToken_.md&amp;value=---%0Auid%3A%20X10D.Text.StringBuilderReader.ReadAsync(Memory%7BSystem.Char%7D%2CCancellationToken)%0Asummary%3A%20'*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax'%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A">Improve this Doc</a>
</span>
<span class="small pull-right mobile-hide">
<a href="https://github.com/oliverbooth/X10D/blob/main/X10D/src/Text/StringBuilderReader.cs/#L122">View Source</a>
</span>
<a id="X10D_Text_StringBuilderReader_ReadAsync_" data-uid="X10D.Text.StringBuilderReader.ReadAsync*"></a>
<h4 id="X10D_Text_StringBuilderReader_ReadAsync_Memory_System_Char__CancellationToken_" data-uid="X10D.Text.StringBuilderReader.ReadAsync(Memory{System.Char},CancellationToken)">ReadAsync(Memory&lt;Char&gt;, CancellationToken)</h4>
<div class="markdown level1 summary"><p>Asynchronously reads the characters from the current stream into a memory block.</p>
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public override ValueTask&lt;int&gt; ReadAsync(Memory&lt;char&gt; buffer, CancellationToken cancellationToken = null)</code></pre>
</div>
<h5 class="parameters">Parameters</h5>
<table class="table table-bordered table-striped table-condensed">
<thead>
<tr>
<th>Type</th>
<th>Name</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td><span class="xref">Memory</span>&lt;<span class="xref">System.Char</span>&gt;</td>
<td><span class="parametername">buffer</span></td>
<td><p>When this method returns, contains the specified memory block of characters replaced by the characters read from the
current source.</p>
</td>
</tr>
<tr>
<td><span class="xref">CancellationToken</span></td>
<td><span class="parametername">cancellationToken</span></td>
<td><p>Ignored.</p>
</td>
</tr>
</tbody>
</table>
<h5 class="returns">Returns</h5>
<table class="table table-bordered table-striped table-condensed">
<thead>
<tr>
<th>Type</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td><span class="xref">ValueTask</span>&lt;<span class="xref">System.Int32</span>&gt;</td>
<td><p>A value task that represents the asynchronous read operation. The value of the type parameter contains the number of
characters that have been read, or 0 if at the end of the stream and no data was read. The number will be less than or
equal to the buffer length, depending on whether the data is available within the stream.</p>
</td>
</tr>
</tbody>
</table>
<span class="small pull-right mobile-hide">
<span class="divider">|</span>
<a href="https://github.com/oliverbooth/X10D/new/main/apiSpec/new?filename=X10D_Text_StringBuilderReader_ReadAsync_System_Char___System_Int32_System_Int32_.md&amp;value=---%0Auid%3A%20X10D.Text.StringBuilderReader.ReadAsync(System.Char%5B%5D%2CSystem.Int32%2CSystem.Int32)%0Asummary%3A%20'*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax'%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A">Improve this Doc</a>
</span>
<span class="small pull-right mobile-hide">
<a href="https://github.com/oliverbooth/X10D/blob/main/X10D/src/Text/StringBuilderReader.cs/#L103">View Source</a>
</span>
<a id="X10D_Text_StringBuilderReader_ReadAsync_" data-uid="X10D.Text.StringBuilderReader.ReadAsync*"></a>
<h4 id="X10D_Text_StringBuilderReader_ReadAsync_System_Char___System_Int32_System_Int32_" data-uid="X10D.Text.StringBuilderReader.ReadAsync(System.Char[],System.Int32,System.Int32)">ReadAsync(Char[], Int32, Int32)</h4>
<div class="markdown level1 summary"></div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public override Task&lt;int&gt; ReadAsync(char[] buffer, int index, int count)</code></pre>
</div>
<h5 class="parameters">Parameters</h5>
<table class="table table-bordered table-striped table-condensed">
<thead>
<tr>
<th>Type</th>
<th>Name</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td><span class="xref">System.Char</span>[]</td>
<td><span class="parametername">buffer</span></td>
<td></td>
</tr>
<tr>
<td><span class="xref">System.Int32</span></td>
<td><span class="parametername">index</span></td>
<td></td>
</tr>
<tr>
<td><span class="xref">System.Int32</span></td>
<td><span class="parametername">count</span></td>
<td></td>
</tr>
</tbody>
</table>
<h5 class="returns">Returns</h5>
<table class="table table-bordered table-striped table-condensed">
<thead>
<tr>
<th>Type</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td><span class="xref">Task</span>&lt;<span class="xref">System.Int32</span>&gt;</td>
<td></td>
</tr>
</tbody>
</table>
<span class="small pull-right mobile-hide">
<span class="divider">|</span>
<a href="https://github.com/oliverbooth/X10D/new/main/apiSpec/new?filename=X10D_Text_StringBuilderReader_ReadBlock_Span_System_Char__.md&amp;value=---%0Auid%3A%20X10D.Text.StringBuilderReader.ReadBlock(Span%7BSystem.Char%7D)%0Asummary%3A%20'*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax'%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A">Improve this Doc</a>
</span>
<span class="small pull-right mobile-hide">
<a href="https://github.com/oliverbooth/X10D/blob/main/X10D/src/Text/StringBuilderReader.cs/#L128">View Source</a>
</span>
<a id="X10D_Text_StringBuilderReader_ReadBlock_" data-uid="X10D.Text.StringBuilderReader.ReadBlock*"></a>
<h4 id="X10D_Text_StringBuilderReader_ReadBlock_Span_System_Char__" data-uid="X10D.Text.StringBuilderReader.ReadBlock(Span{System.Char})">ReadBlock(Span&lt;Char&gt;)</h4>
<div class="markdown level1 summary"></div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public override int ReadBlock(Span&lt;char&gt; buffer)</code></pre>
</div>
<h5 class="parameters">Parameters</h5>
<table class="table table-bordered table-striped table-condensed">
<thead>
<tr>
<th>Type</th>
<th>Name</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td><span class="xref">Span</span>&lt;<span class="xref">System.Char</span>&gt;</td>
<td><span class="parametername">buffer</span></td>
<td></td>
</tr>
</tbody>
</table>
<h5 class="returns">Returns</h5>
<table class="table table-bordered table-striped table-condensed">
<thead>
<tr>
<th>Type</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td><span class="xref">System.Int32</span></td>
<td></td>
</tr>
</tbody>
</table>
<span class="small pull-right mobile-hide">
<span class="divider">|</span>
<a href="https://github.com/oliverbooth/X10D/new/main/apiSpec/new?filename=X10D_Text_StringBuilderReader_ReadBlock_System_Char___System_Int32_System_Int32_.md&amp;value=---%0Auid%3A%20X10D.Text.StringBuilderReader.ReadBlock(System.Char%5B%5D%2CSystem.Int32%2CSystem.Int32)%0Asummary%3A%20'*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax'%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A">Improve this Doc</a>
</span>
<span class="small pull-right mobile-hide">
<a href="https://github.com/oliverbooth/X10D/blob/main/X10D/src/Text/StringBuilderReader.cs/#L134">View Source</a>
</span>
<a id="X10D_Text_StringBuilderReader_ReadBlock_" data-uid="X10D.Text.StringBuilderReader.ReadBlock*"></a>
<h4 id="X10D_Text_StringBuilderReader_ReadBlock_System_Char___System_Int32_System_Int32_" data-uid="X10D.Text.StringBuilderReader.ReadBlock(System.Char[],System.Int32,System.Int32)">ReadBlock(Char[], Int32, Int32)</h4>
<div class="markdown level1 summary"></div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public override int ReadBlock(char[] buffer, int index, int count)</code></pre>
</div>
<h5 class="parameters">Parameters</h5>
<table class="table table-bordered table-striped table-condensed">
<thead>
<tr>
<th>Type</th>
<th>Name</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td><span class="xref">System.Char</span>[]</td>
<td><span class="parametername">buffer</span></td>
<td></td>
</tr>
<tr>
<td><span class="xref">System.Int32</span></td>
<td><span class="parametername">index</span></td>
<td></td>
</tr>
<tr>
<td><span class="xref">System.Int32</span></td>
<td><span class="parametername">count</span></td>
<td></td>
</tr>
</tbody>
</table>
<h5 class="returns">Returns</h5>
<table class="table table-bordered table-striped table-condensed">
<thead>
<tr>
<th>Type</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td><span class="xref">System.Int32</span></td>
<td></td>
</tr>
</tbody>
</table>
<span class="small pull-right mobile-hide">
<span class="divider">|</span>
<a href="https://github.com/oliverbooth/X10D/new/main/apiSpec/new?filename=X10D_Text_StringBuilderReader_ReadBlockAsync_Memory_System_Char__CancellationToken_.md&amp;value=---%0Auid%3A%20X10D.Text.StringBuilderReader.ReadBlockAsync(Memory%7BSystem.Char%7D%2CCancellationToken)%0Asummary%3A%20'*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax'%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A">Improve this Doc</a>
</span>
<span class="small pull-right mobile-hide">
<a href="https://github.com/oliverbooth/X10D/blob/main/X10D/src/Text/StringBuilderReader.cs/#L168">View Source</a>
</span>
<a id="X10D_Text_StringBuilderReader_ReadBlockAsync_" data-uid="X10D.Text.StringBuilderReader.ReadBlockAsync*"></a>
<h4 id="X10D_Text_StringBuilderReader_ReadBlockAsync_Memory_System_Char__CancellationToken_" data-uid="X10D.Text.StringBuilderReader.ReadBlockAsync(Memory{System.Char},CancellationToken)">ReadBlockAsync(Memory&lt;Char&gt;, CancellationToken)</h4>
<div class="markdown level1 summary"><p>Asynchronously reads the characters from the current stream and writes the data to a buffer.</p>
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public override ValueTask&lt;int&gt; ReadBlockAsync(Memory&lt;char&gt; buffer, CancellationToken cancellationToken = null)</code></pre>
</div>
<h5 class="parameters">Parameters</h5>
<table class="table table-bordered table-striped table-condensed">
<thead>
<tr>
<th>Type</th>
<th>Name</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td><span class="xref">Memory</span>&lt;<span class="xref">System.Char</span>&gt;</td>
<td><span class="parametername">buffer</span></td>
<td><p>When this method returns, contains the specified memory block of characters replaced by the characters read from the
current source.</p>
</td>
</tr>
<tr>
<td><span class="xref">CancellationToken</span></td>
<td><span class="parametername">cancellationToken</span></td>
<td><p>Ignored.</p>
</td>
</tr>
</tbody>
</table>
<h5 class="returns">Returns</h5>
<table class="table table-bordered table-striped table-condensed">
<thead>
<tr>
<th>Type</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td><span class="xref">ValueTask</span>&lt;<span class="xref">System.Int32</span>&gt;</td>
<td><p>A value task that represents the asynchronous read operation. The value of the type parameter contains the total
number of characters read into the buffer. The result value can be less than the number of characters requested if the
number of characters currently available is less than the requested number, or it can be 0 (zero) if the end of the
stream has been reached.</p>
</td>
</tr>
</tbody>
</table>
<span class="small pull-right mobile-hide">
<span class="divider">|</span>
<a href="https://github.com/oliverbooth/X10D/new/main/apiSpec/new?filename=X10D_Text_StringBuilderReader_ReadBlockAsync_System_Char___System_Int32_System_Int32_.md&amp;value=---%0Auid%3A%20X10D.Text.StringBuilderReader.ReadBlockAsync(System.Char%5B%5D%2CSystem.Int32%2CSystem.Int32)%0Asummary%3A%20'*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax'%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A">Improve this Doc</a>
</span>
<span class="small pull-right mobile-hide">
<a href="https://github.com/oliverbooth/X10D/blob/main/X10D/src/Text/StringBuilderReader.cs/#L148">View Source</a>
</span>
<a id="X10D_Text_StringBuilderReader_ReadBlockAsync_" data-uid="X10D.Text.StringBuilderReader.ReadBlockAsync*"></a>
<h4 id="X10D_Text_StringBuilderReader_ReadBlockAsync_System_Char___System_Int32_System_Int32_" data-uid="X10D.Text.StringBuilderReader.ReadBlockAsync(System.Char[],System.Int32,System.Int32)">ReadBlockAsync(Char[], Int32, Int32)</h4>
<div class="markdown level1 summary"></div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public override Task&lt;int&gt; ReadBlockAsync(char[] buffer, int index, int count)</code></pre>
</div>
<h5 class="parameters">Parameters</h5>
<table class="table table-bordered table-striped table-condensed">
<thead>
<tr>
<th>Type</th>
<th>Name</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td><span class="xref">System.Char</span>[]</td>
<td><span class="parametername">buffer</span></td>
<td></td>
</tr>
<tr>
<td><span class="xref">System.Int32</span></td>
<td><span class="parametername">index</span></td>
<td></td>
</tr>
<tr>
<td><span class="xref">System.Int32</span></td>
<td><span class="parametername">count</span></td>
<td></td>
</tr>
</tbody>
</table>
<h5 class="returns">Returns</h5>
<table class="table table-bordered table-striped table-condensed">
<thead>
<tr>
<th>Type</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td><span class="xref">Task</span>&lt;<span class="xref">System.Int32</span>&gt;</td>
<td></td>
</tr>
</tbody>
</table>
<span class="small pull-right mobile-hide">
<span class="divider">|</span>
<a href="https://github.com/oliverbooth/X10D/new/main/apiSpec/new?filename=X10D_Text_StringBuilderReader_ReadLine.md&amp;value=---%0Auid%3A%20X10D.Text.StringBuilderReader.ReadLine%0Asummary%3A%20'*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax'%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A">Improve this Doc</a>
</span>
<span class="small pull-right mobile-hide">
<a href="https://github.com/oliverbooth/X10D/blob/main/X10D/src/Text/StringBuilderReader.cs/#L174">View Source</a>
</span>
<a id="X10D_Text_StringBuilderReader_ReadLine_" data-uid="X10D.Text.StringBuilderReader.ReadLine*"></a>
<h4 id="X10D_Text_StringBuilderReader_ReadLine" data-uid="X10D.Text.StringBuilderReader.ReadLine">ReadLine()</h4>
<div class="markdown level1 summary"></div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public override string? ReadLine()</code></pre>
</div>
<h5 class="returns">Returns</h5>
<table class="table table-bordered table-striped table-condensed">
<thead>
<tr>
<th>Type</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td><span class="xref">System.Nullable</span>&lt;<span class="xref">System.String</span>&gt;</td>
<td></td>
</tr>
</tbody>
</table>
<span class="small pull-right mobile-hide">
<span class="divider">|</span>
<a href="https://github.com/oliverbooth/X10D/new/main/apiSpec/new?filename=X10D_Text_StringBuilderReader_ReadLineAsync.md&amp;value=---%0Auid%3A%20X10D.Text.StringBuilderReader.ReadLineAsync%0Asummary%3A%20'*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax'%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A">Improve this Doc</a>
</span>
<span class="small pull-right mobile-hide">
<a href="https://github.com/oliverbooth/X10D/blob/main/X10D/src/Text/StringBuilderReader.cs/#L203">View Source</a>
</span>
<a id="X10D_Text_StringBuilderReader_ReadLineAsync_" data-uid="X10D.Text.StringBuilderReader.ReadLineAsync*"></a>
<h4 id="X10D_Text_StringBuilderReader_ReadLineAsync" data-uid="X10D.Text.StringBuilderReader.ReadLineAsync">ReadLineAsync()</h4>
<div class="markdown level1 summary"></div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public override Task&lt;string?&gt; ReadLineAsync()</code></pre>
</div>
<h5 class="returns">Returns</h5>
<table class="table table-bordered table-striped table-condensed">
<thead>
<tr>
<th>Type</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td><span class="xref">Task</span>&lt;<span class="xref">System.Nullable</span>&lt;<span class="xref">System.String</span>&gt;&gt;</td>
<td></td>
</tr>
</tbody>
</table>
<span class="small pull-right mobile-hide">
<span class="divider">|</span>
<a href="https://github.com/oliverbooth/X10D/new/main/apiSpec/new?filename=X10D_Text_StringBuilderReader_ReadToEnd.md&amp;value=---%0Auid%3A%20X10D.Text.StringBuilderReader.ReadToEnd%0Asummary%3A%20'*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax'%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A">Improve this Doc</a>
</span>
<span class="small pull-right mobile-hide">
<a href="https://github.com/oliverbooth/X10D/blob/main/X10D/src/Text/StringBuilderReader.cs/#L209">View Source</a>
</span>
<a id="X10D_Text_StringBuilderReader_ReadToEnd_" data-uid="X10D.Text.StringBuilderReader.ReadToEnd*"></a>
<h4 id="X10D_Text_StringBuilderReader_ReadToEnd" data-uid="X10D.Text.StringBuilderReader.ReadToEnd">ReadToEnd()</h4>
<div class="markdown level1 summary"></div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public override string ReadToEnd()</code></pre>
</div>
<h5 class="returns">Returns</h5>
<table class="table table-bordered table-striped table-condensed">
<thead>
<tr>
<th>Type</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td><span class="xref">System.String</span></td>
<td></td>
</tr>
</tbody>
</table>
<span class="small pull-right mobile-hide">
<span class="divider">|</span>
<a href="https://github.com/oliverbooth/X10D/new/main/apiSpec/new?filename=X10D_Text_StringBuilderReader_ReadToEndAsync.md&amp;value=---%0Auid%3A%20X10D.Text.StringBuilderReader.ReadToEndAsync%0Asummary%3A%20'*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax'%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A">Improve this Doc</a>
</span>
<span class="small pull-right mobile-hide">
<a href="https://github.com/oliverbooth/X10D/blob/main/X10D/src/Text/StringBuilderReader.cs/#L217">View Source</a>
</span>
<a id="X10D_Text_StringBuilderReader_ReadToEndAsync_" data-uid="X10D.Text.StringBuilderReader.ReadToEndAsync*"></a>
<h4 id="X10D_Text_StringBuilderReader_ReadToEndAsync" data-uid="X10D.Text.StringBuilderReader.ReadToEndAsync">ReadToEndAsync()</h4>
<div class="markdown level1 summary"></div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public override Task&lt;string&gt; ReadToEndAsync()</code></pre>
</div>
<h5 class="returns">Returns</h5>
<table class="table table-bordered table-striped table-condensed">
<thead>
<tr>
<th>Type</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td><span class="xref">Task</span>&lt;<span class="xref">System.String</span>&gt;</td>
<td></td>
</tr>
</tbody>
</table>
<h3 id="extensionmethods">Extension Methods</h3>
<div>
<a class="xref" href="X10D.Core.Extensions.html#X10D_Core_Extensions_AsArrayValue__1___0_">Extensions.AsArrayValue&lt;T&gt;(T)</a>
</div>
<div>
<a class="xref" href="X10D.Core.Extensions.html#X10D_Core_Extensions_AsEnumerableValue__1___0_">Extensions.AsEnumerableValue&lt;T&gt;(T)</a>
</div>
<div>
<a class="xref" href="X10D.Core.Extensions.html#X10D_Core_Extensions_RepeatValue__1___0_System_Int32_">Extensions.RepeatValue&lt;T&gt;(T, Int32)</a>
</div>
<div>
<a class="xref" href="X10D.Text.Extensions.html#X10D_Text_Extensions_ToJson__1___0_System_Nullable_JsonSerializerOptions__">Extensions.ToJson&lt;T&gt;(T, Nullable&lt;JsonSerializerOptions&gt;)</a>
</div>
</article>
</div>
<div class="copyright-footer">
<span>&#169; Singulink. All rights reserved.</span>
</div>
</main>
</div>
<script src="https://code.jquery.com/jquery-3.5.1.min.js" integrity="sha256-9/aliU8dGd2tb6OSsuzixeV4y/faTqgFtohetphbbj0=" crossorigin="anonymous"></script>
<script src="https://cdn.jsdelivr.net/npm/popper.js@1.16.0/dist/umd/popper.min.js" integrity="sha384-Q6E9RHvbIyZFJoft+2mJbHaEWldlvI9IOYy5n3zV9zzTtmI3UksdQRVvoxMfooAo" crossorigin="anonymous"></script>
<script src="https://stackpath.bootstrapcdn.com/bootstrap/4.5.0/js/bootstrap.min.js" integrity="sha384-OgVRvuATP1z7JjHLkuOU7Xw704+h835Lr+6QL9UvYjZE3Ipu6Tp75j7Bh/kR0JKI" crossorigin="anonymous"></script>
<script src="//cdnjs.cloudflare.com/ajax/libs/highlight.js/10.1.1/highlight.min.js"></script>
<script type="text/javascript" src="../styles/jquery.twbsPagination.js"></script>
<script type="text/javascript" src="../styles/url.min.js"></script>
<script src="https://cdn.jsdelivr.net/npm/anchor-js/anchor.min.js"></script>
<script type="text/javascript" src="../styles/docfx.js"></script>
<script type="text/javascript" src="../styles/singulink.js"></script>
<script type="text/javascript" src="../styles/main.js"></script> </body>
</html>