/fparsec/main/Doc/html/reference/error.html
HTML | 955 lines | 932 code | 17 blank | 6 comment | 0 complexity | 26a00c1049e17ca4ac4ce91fcf8ec2e5 MD5 | raw file
- <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
- <html xmlns="http://www.w3.org/1999/xhtml">
- <head>
- <meta http-equiv="Content-Type" content="text/html; charset=UTF-8" />
- <title>FParsec.Error</title>
- <link rel="stylesheet" type="text/css" media="all" href="../css/style.css" />
- <link rel="stylesheet" type="text/css" media="screen" href="../css/screen-sidebar.css" title="Sidebar" />
- <link rel="alternate stylesheet" type="text/css" media="screen" href="../css/screen-no-sidebar.css" title="No sidebar" />
- <!--[if IE]>
- <link rel="stylesheet" type="text/css" media="all" href="../css/style-ie.css" />
- <![endif]-->
- <!--[if IE 6]>
- <link rel="stylesheet" type="text/css" media="all" href="../css/style-ie6.css" />
- <![endif]-->
- <link rel="stylesheet" type="text/css" media="print" href="../css/print.css" />
- </head>
- <body>
- <div id="fixed-layer">
- <div id="fixed-wrapper">
- <div id="sidebar">
- <div id="breadcrumbs-dummy"><span class="breadcrumbs"> </span></div>
- <div id="nav-tree">
- <table class="nav n1">
- <tbody class="nav-open n1">
- <tr class="nav-entry n1 _1">
- <td class="nav-number n1"></td>
- <td class="nav-title n1"><a href="../index.html">FParsec Documentation</a></td>
- </tr>
- <tr class="nav-sub-entries n1 _1">
- <td class="nav-sub-entries-number n1"></td>
- <td class="nav-sub-entries n1">
- <table class="nav n2">
- <tbody class="nav-before-open n2">
- <tr class="nav-entry n2 _1">
- <td class="nav-number n2"><a href="../tutorial.html"><span class="section-number">1</span><span class="nav-space"></span></a></td>
- <td class="nav-title n2"><a href="../tutorial.html">Tutorial</a></td>
- </tr>
- </tbody>
- <tbody class="nav-open n2">
- <tr class="nav-entry n2 _2">
- <td class="nav-number n2"><a href="index.html"><span class="section-number">2</span><span class="nav-space"></span></a></td>
- <td class="nav-title n2"><a href="index.html">Reference</a></td>
- </tr>
- <tr class="nav-sub-entries n2 _2">
- <td class="nav-sub-entries-number n2"></td>
- <td class="nav-sub-entries n2">
- <table class="nav n3">
- <tbody class="nav-before-open n3">
- <tr class="nav-entry n3 _1">
- <td class="nav-number n3"><a href="parser-overview.html"><span class="section-number">1</span><span class="nav-space"></span></a></td>
- <td class="nav-title n3"><a href="parser-overview.html">Parser overview</a></td>
- </tr>
- <tr class="nav-entry n3 _2">
- <td class="nav-number n3"><a href="primitives.html"><span class="section-number">2</span><span class="nav-space"></span></a></td>
- <td class="nav-title n3"><a href="primitives.html">FParsec.Primitives</a></td>
- </tr>
- <tr class="nav-entry n3 _3">
- <td class="nav-number n3"><a href="charparsers.html"><span class="section-number">3</span><span class="nav-space"></span></a></td>
- <td class="nav-title n3"><a href="charparsers.html">FParsec.CharParsers</a></td>
- </tr>
- <tr class="nav-entry n3 _4">
- <td class="nav-number n3">
- <a href="operatorprecedenceparser.html"><span class="section-number">4</span><span class="nav-space"></span></a>
- </td>
- <td class="nav-title n3"><a href="operatorprecedenceparser.html">FParsec.OperatorPrecedenceParser</a></td>
- </tr>
- </tbody>
- <tbody class="nav-open selected n3">
- <tr class="nav-entry selected n3 _5">
- <td class="nav-number selected n3"><a href="#"><span class="section-number">5</span><span class="nav-space"></span></a></td>
- <td class="nav-title selected n3"><a href="#">FParsec.Error</a></td>
- </tr>
- <tr class="nav-sub-entries selected n3 _5">
- <td class="nav-sub-entries-number selected n3"></td>
- <td class="nav-sub-entries selected n3">
- <table class="nav n4">
- <tbody class="nav-before-open n4">
- <tr class="nav-entry n4 _1">
- <td class="nav-number n4"><a href="#interface"><span class="section-number">1</span><span class="nav-space"></span></a></td>
- <td class="nav-title n4"><a href="#interface">Interface</a></td>
- </tr>
- <tr class="nav-entry n4 _2">
- <td class="nav-number n4"><a href="#members"><span class="section-number">2</span><span class="nav-space"></span></a></td>
- <td class="nav-title n4"><a href="#members">Members</a></td>
- </tr>
- </tbody>
- </table>
- </td>
- </tr>
- </tbody>
- <tbody class="nav-after-open n3">
- <tr class="nav-entry n3 _6">
- <td class="nav-number n3"><a href="state.html"><span class="section-number">6</span><span class="nav-space"></span></a></td>
- <td class="nav-title n3"><a href="state.html">FParsec.State</a></td>
- </tr>
- <tr class="nav-entry n3 _7">
- <td class="nav-number n3"><a href="position.html"><span class="section-number">7</span><span class="nav-space"></span></a></td>
- <td class="nav-title n3"><a href="position.html">FParsec.Position</a></td>
- </tr>
- <tr class="nav-entry n3 _8">
- <td class="nav-number n3"><a href="charstream.html"><span class="section-number">8</span><span class="nav-space"></span></a></td>
- <td class="nav-title n3"><a href="charstream.html">FParsec.CharStream</a></td>
- </tr>
- </tbody>
- </table>
- </td>
- </tr>
- </tbody>
- </table>
- </td>
- </tr>
- </tbody>
- </table>
- </div>
- </div>
- </div>
- </div>
- <div id="wrapper">
- <div id="main">
- <div id="main-content">
- <div id="breadcrumbs">
- <span class="breadcrumbs">
- <span id="breadcrumbs-parents"><a href="../index.html">FParsec Documentation</a><span class="breadcrumbs-sep"> > </span><a href="index.html">Reference</a></span><span class="breadcrumbs-sep"> > </span>FParsec.Error
- </span>
- </div>
- <div class="section s2">
- <h1 class="title h2"><span class="section-number">2.5</span> FParsec.Error</h1>
- <div id="interface" class="section s3">
- <h2 class="title h3"><span class="section-number">2.5.1</span> Interface</h2>
- <div class="intro i3">
- <div class="para _1">
- <pre class="code fsharp"><span class="ck">module</span> <span class="ci">FParsec</span><span class="cm">.</span><span class="ci">Error</span>
- <span class="ck">type</span> <a id="interface.ErrorMessage:B:" href="#members.ErrorMessage"><span class="interface-member-marker"><span class="ci">ErrorMessage</span></span></a> <span class="co">=</span>
- <span class="cp">|</span> <a id="interface.Expected:B:" href="#members.Expected"><span class="interface-member-marker"><span class="ci">Expected</span></span></a> <span class="ck">of</span> <span class="ci">string</span>
- <span class="cp">|</span> <a id="interface.ExpectedString:B:" href="#members.ExpectedString"><span class="interface-member-marker"><span class="ci">ExpectedString</span></span></a> <span class="ck">of</span> <span class="ci">string</span>
- <span class="cp">|</span> <a id="interface.ExpectedStringCI:B:" href="#members.ExpectedStringCI"><span class="interface-member-marker"><span class="ci">ExpectedStringCI</span></span></a> <span class="ck">of</span> <span class="ci">string</span>
- <span class="cp">|</span> <a id="interface.Unexpected:B:" href="#members.Unexpected"><span class="interface-member-marker"><span class="ci">Unexpected</span></span></a> <span class="ck">of</span> <span class="ci">string</span>
- <span class="cp">|</span> <a id="interface.UnexpectedString:B:" href="#members.UnexpectedString"><span class="interface-member-marker"><span class="ci">UnexpectedString</span></span></a> <span class="ck">of</span> <span class="ci">string</span>
- <span class="cp">|</span> <a id="interface.UnexpectedStringCI:B:" href="#members.UnexpectedStringCI"><span class="interface-member-marker"><span class="ci">UnexpectedStringCI</span></span></a> <span class="ck">of</span> <span class="ci">string</span>
- <span class="cp">|</span> <a id="interface.Message:B:" href="#members.Message"><span class="interface-member-marker"><span class="ci">Message</span></span></a> <span class="ck">of</span> <span class="ci">string</span>
- <span class="cp">|</span> <a id="interface.CompoundError:B:" href="#members.CompoundError"><span class="interface-member-marker"><span class="ci">CompoundError</span></span></a> <span class="ck">of</span> <span class="ci">string</span> <span class="cp">*</span> <a href="position.html"><span class="ci">Position</span></a> <span class="cp">*</span> <a href="#members.ErrorMessageList"><span class="ci">ErrorMessageList</span></a>
- <span class="cp">|</span> <a id="interface.BacktrackPoint:B:" href="#members.BacktrackPoint"><span class="interface-member-marker"><span class="ci">BacktrackPoint</span></span></a> <span class="ck">of</span> <a href="position.html"><span class="ci">Position</span></a> <span class="cp">*</span> <a href="#members.ErrorMessageList"><span class="ci">ErrorMessageList</span></a>
- <span class="cp">|</span> <a id="interface.OtherError:B:" href="#members.OtherError"><span class="interface-member-marker"><span class="ci">OtherError</span></span></a> <span class="ck">of</span> <a href="http://msdn.microsoft.com/en-us/library/system.icomparable.aspx"><span class="ci">System</span><span class="cm">.</span><span class="ci">IComparable</span></a>
- <span class="cp">[<</span><span class="ci">CompilationRepresentation</span><span class="cp">(</span><span class="ci">CompilationRepresentationFlags</span><span class="cm">.</span><span class="ci">UseNullAsTrueValue</span><span class="cp">)</span><span class="cp">;</span>
- <span class="ci">CustomEquality</span><span class="cp">;</span> <span class="ci">CustomComparison</span><span class="cp">>]</span>
- <span class="ck">type</span> <a id="interface.ErrorMessageList:B:" href="#members.ErrorMessageList"><span class="interface-member-marker"><span class="ci">ErrorMessageList</span></span></a> <span class="co">=</span>
- <span class="cp">|</span> <a id="interface.AddErrorMessage:B:" href="#members.AddErrorMessage"><span class="interface-member-marker"><span class="ci">AddErrorMessage</span></span></a> <span class="ck">of</span> <a href="#members.ErrorMessage"><span class="ci">ErrorMessage</span></a> <span class="cp">*</span> <span class="ci">ErrorMessageList</span>
- <span class="cp">|</span> <a id="interface.NoErrorMessages:B:" href="#members.NoErrorMessages"><span class="interface-member-marker"><span class="ci">NoErrorMessages</span></span></a>
- <span class="ck">with</span>
- <span class="ck">member</span> <a id="interface.ToSet:B:" href="#members.ToSet"><span class="interface-member-marker"><span class="ci">ToSet</span></span></a><span class="cp">:</span> <span class="ci">unit</span> <span class="cr">-></span> <span class="ci">Set</span><span class="cp"><</span><a href="#members.ErrorMessage"><span class="ci">ErrorMessage</span></a><span class="cp">></span>
- <span class="ck">static</span> <span class="ck">member</span> <a id="interface.OfSeq:B:" href="#members.OfSeq"><span class="interface-member-marker"><span class="ci">OfSeq</span></span></a><span class="cp">:</span> <span class="ci">seq</span><span class="cp"><</span><a href="#members.ErrorMessage"><span class="ci">ErrorMessage</span></a><span class="cp">></span> <span class="cr">-></span> <span class="ci">ErrorMessageList</span>
- <span class="ck">override</span> <span class="ci">Equals</span><span class="cp">:</span> <span class="ci">obj</span> <span class="cr">-></span> <span class="ci">bool</span>
- <span class="ck">override</span> <span class="ci">GetHashCode</span><span class="cp">:</span> <span class="ci">unit</span> <span class="cr">-></span> <span class="ci">int</span>
- <span class="ck">interface</span> <a href="http://msdn.microsoft.com/en-us/library/system.icomparable.aspx"><span class="ci">System</span><span class="cm">.</span><span class="ci">IComparable</span></a>
- <span class="ck">val</span> <a id="interface.expectedError:B:" href="#members.expectedError"><span class="interface-member-marker"><span class="ci">expectedError</span></span></a><span class="cp">:</span> <span class="ci">string</span> <span class="cr">-></span> <a href="#members.ErrorMessageList"><span class="ci">ErrorMessageList</span></a>
- <span class="ck">val</span> <a id="interface.expectedStringError:B:" href="#members.expectedStringError"><span class="interface-member-marker"><span class="ci">expectedStringError</span></span></a><span class="cp">:</span> <span class="ci">string</span> <span class="cr">-></span> <a href="#members.ErrorMessageList"><span class="ci">ErrorMessageList</span></a>
- <span class="ck">val</span> <a id="interface.expectedStringCIError:B:" href="#members.expectedStringCIError"><span class="interface-member-marker"><span class="ci">expectedStringCIError</span></span></a><span class="cp">:</span> <span class="ci">string</span> <span class="cr">-></span> <a href="#members.ErrorMessageList"><span class="ci">ErrorMessageList</span></a>
- <span class="ck">val</span> <a id="interface.unexpectedError:B:" href="#members.unexpectedError"><span class="interface-member-marker"><span class="ci">unexpectedError</span></span></a><span class="cp">:</span> <span class="ci">string</span> <span class="cr">-></span> <a href="#members.ErrorMessageList"><span class="ci">ErrorMessageList</span></a>
- <span class="ck">val</span> <a id="interface.unexpectedStringError:B:" href="#members.unexpectedStringError"><span class="interface-member-marker"><span class="ci">unexpectedStringError</span></span></a><span class="cp">:</span> <span class="ci">string</span> <span class="cr">-></span> <a href="#members.ErrorMessageList"><span class="ci">ErrorMessageList</span></a>
- <span class="ck">val</span> <a id="interface.unexpectedStringCIError:B:" href="#members.unexpectedStringCIError"><span class="interface-member-marker"><span class="ci">unexpectedStringCIError</span></span></a><span class="cp">:</span> <span class="ci">string</span> <span class="cr">-></span> <a href="#members.ErrorMessageList"><span class="ci">ErrorMessageList</span></a>
- <span class="ck">val</span> <a id="interface.messageError:B:" href="#members.messageError"><span class="interface-member-marker"><span class="ci">messageError</span></span></a><span class="cp">:</span> <span class="ci">string</span> <span class="cr">-></span> <a href="#members.ErrorMessageList"><span class="ci">ErrorMessageList</span></a>
- <span class="ck">val</span> <a id="interface.otherError:B:" href="#members.otherError"><span class="interface-member-marker"><span class="ci">otherError</span></span></a><span class="cp">:</span> <span class="ci">obj</span> <span class="cr">-></span> <a href="#members.ErrorMessageList"><span class="ci">ErrorMessageList</span></a>
- <span class="ck">val</span> <a id="interface.compoundError:B:" href="#members.compoundError"><span class="interface-member-marker"><span class="ci">compoundError</span></span></a><span class="cp">:</span> <span class="ci">string</span> <span class="cr">-></span> <a href="state.html"><span class="ci">State</span></a><span class="cp"><</span><span class="ctv">'u</span><span class="cp">></span> <span class="cr">-></span> <a href="#members.ErrorMessageList"><span class="ci">ErrorMessageList</span></a> <span class="cr">-></span> <a href="#members.ErrorMessageList"><span class="ci">ErrorMessageList</span></a>
- <span class="ck">val</span> <a id="interface.backtrackError:B:" href="#members.backtrackError"><span class="interface-member-marker"><span class="ci">backtrackError</span></span></a><span class="cp">:</span> <a href="state.html"><span class="ci">State</span></a><span class="cp"><</span><span class="ctv">'u</span><span class="cp">></span> <span class="cr">-></span> <a href="#members.ErrorMessageList"><span class="ci">ErrorMessageList</span></a> <span class="cr">-></span> <a href="#members.ErrorMessageList"><span class="ci">ErrorMessageList</span></a>
- <span class="ck">val</span> <a id="interface.concatErrorMessages:B:" href="#members.concatErrorMessages"><span class="interface-member-marker"><span class="ci">concatErrorMessages</span></span></a><span class="cp">:</span>
- <a href="#members.ErrorMessageList"><span class="ci">ErrorMessageList</span></a> <span class="cr">-></span> <a href="#members.ErrorMessageList"><span class="ci">ErrorMessageList</span></a> <span class="cr">-></span> <a href="#members.ErrorMessageList"><span class="ci">ErrorMessageList</span></a>
- <span class="ck">val</span> <span class="ck">inline</span> <a id="interface.mergeErrors:B:" href="#members.mergeErrors"><span class="interface-member-marker"><span class="ci">mergeErrors</span></span></a><span class="cp">:</span>
- <a href="#members.ErrorMessageList"><span class="ci">ErrorMessageList</span></a> <span class="cr">-></span> <a href="#members.ErrorMessageList"><span class="ci">ErrorMessageList</span></a> <span class="cr">-></span> <a href="#members.ErrorMessageList"><span class="ci">ErrorMessageList</span></a>
- <span class="ck">val</span> <a id="interface.mergeErrorsIfNeeded:B:" href="#members.mergeErrorsIfNeeded"><span class="interface-member-marker"><span class="ci">mergeErrorsIfNeeded</span></span></a><span class="cp">:</span>
- <span class="ci">oldState</span><span class="cp">:</span> <a href="state.html"><span class="ci">State</span></a><span class="cp"><</span><span class="ctv">'u</span><span class="cp">></span> <span class="cr">-></span> <span class="ci">oldError</span><span class="cp">:</span> <a href="#members.ErrorMessageList"><span class="ci">ErrorMessageList</span></a>
- <span class="cr">-></span> <span class="ci">newState</span><span class="cp">:</span> <a href="state.html"><span class="ci">State</span></a><span class="cp"><</span><span class="ctv">'u</span><span class="cp">></span> <span class="cr">-></span> <span class="ci">newError</span><span class="cp">:</span> <a href="#members.ErrorMessageList"><span class="ci">ErrorMessageList</span></a>
- <span class="cr">-></span> <a href="#members.ErrorMessageList"><span class="ci">ErrorMessageList</span></a>
- <span class="ck">val</span> <a id="interface.mergeErrorsIfNeeded3:B:" href="#members.mergeErrorsIfNeeded3"><span class="interface-member-marker"><span class="ci">mergeErrorsIfNeeded3</span></span></a><span class="cp">:</span>
- <span class="ci">oldestState</span><span class="cp">:</span> <a href="state.html"><span class="ci">State</span></a><span class="cp"><</span><span class="ctv">'u</span><span class="cp">></span> <span class="cr">-></span> <span class="ci">oldestError</span><span class="cp">:</span> <a href="#members.ErrorMessageList"><span class="ci">ErrorMessageList</span></a>
- <span class="cr">-></span> <span class="ci">oldState</span><span class="cp">:</span> <a href="state.html"><span class="ci">State</span></a><span class="cp"><</span><span class="ctv">'u</span><span class="cp">></span> <span class="cr">-></span> <span class="ci">oldError</span><span class="cp">:</span> <a href="#members.ErrorMessageList"><span class="ci">ErrorMessageList</span></a>
- <span class="cr">-></span> <span class="ci">newState</span><span class="cp">:</span> <a href="state.html"><span class="ci">State</span></a><span class="cp"><</span><span class="ctv">'u</span><span class="cp">></span> <span class="cr">-></span> <span class="ci">newError</span><span class="cp">:</span> <a href="#members.ErrorMessageList"><span class="ci">ErrorMessageList</span></a>
- <span class="cr">-></span> <a href="#members.ErrorMessageList"><span class="ci">ErrorMessageList</span></a>
- <span class="cp">[<</span><span class="ci">Sealed</span><span class="cp">>]</span>
- <span class="ck">type</span> <a id="interface.ParserError:B:" href="#members.ParserError"><span class="interface-member-marker"><span class="ci">ParserError</span></span></a> <span class="co">=</span>
- <a id="interface.new:B:" href="#members.new"><span class="interface-member-marker"><span class="ck">new</span></span></a><span class="cp">:</span> <a href="position.html"><span class="ci">Position</span></a> <span class="cp">*</span> <a href="#members.ErrorMessageList"><span class="ci">ErrorMessageList</span></a> <span class="cr">-></span> <span class="ci">ParserError</span>
- <span class="ck">member</span> <a id="interface.Position:B:" href="#members.Position"><span class="interface-member-marker"><span class="ci">Position</span></span></a><span class="cp">:</span> <a href="position.html"><span class="ci">Position</span></a>
- <span class="ck">member</span> <a id="interface.member-ErrorMessageList:B:" href="#members.member-ErrorMessageList"><span class="interface-member-marker"><span class="ci">ErrorMessageList</span></span></a><span class="cp">:</span> <a href="#members.ErrorMessageList"><span class="ci">ErrorMessageList</span></a>
- <a id="interface.ToString:47:WriteTo"></a>
- <span class="ck">override</span> <a id="interface.ToString:B:" href="#members.ToString"><span class="interface-member-marker"><span class="ci">ToString</span></span></a><span class="cp">:</span> <span class="ci">unit</span> <span class="cr">-></span> <span class="ci">string</span>
- <span class="ck">member</span> <a id="interface.ToString_CharStream:B:" href="#members.ToString_CharStream"><span class="interface-member-marker"><span class="ci">ToString</span></span></a><span class="cp">:</span> <span class="ci">streamWhereErrorOccurred</span><span class="cp">:</span> <a href="charstream.html"><span class="ci">CharStream</span></a> <span class="cr">-></span> <span class="ci">string</span>
- <span class="ck">member</span> <a id="interface.WriteTo_stream:B:" href="#members.WriteTo_stream"><span class="interface-member-marker"><span class="ci">WriteTo</span></span></a><span class="cp">:</span>
- <span class="ci">textWriter</span><span class="cp">:</span> <a href="http://msdn.microsoft.com/en-us/library/system.io.textwriter.aspx"><span class="ci">System</span><span class="cm">.</span><span class="ci">IO</span><span class="cm">.</span><span class="ci">TextWriter</span></a>
- <span class="cp">*</span> <span class="ci">streamWhereErrorOccurred</span><span class="cp">:</span> <a href="charstream.html"><span class="ci">CharStream</span></a>
- <span class="cp">*</span> <span class="cp">?</span><span class="ci">columnWidth</span><span class="cp">:</span> <span class="ci">int</span>
- <span class="cp">*</span> <span class="cp">?</span><span class="ci">initialIndentation</span><span class="cp">:</span> <span class="ci">string</span> <span class="cp">*</span> <span class="cp">?</span><span class="ci">indentationIncrement</span><span class="cp">:</span> <span class="ci">string</span>
- <span class="cr">-></span> <span class="ci">unit</span>
- <span class="ck">member</span> <a id="interface.WriteTo_getStreamByName:B:" href="#members.WriteTo_getStreamByName"><span class="interface-member-marker"><span class="ci">WriteTo</span></span></a><span class="cp">:</span>
- <span class="ci">textWriter</span><span class="cp">:</span> <a href="http://msdn.microsoft.com/en-us/library/system.io.textwriter.aspx"><span class="ci">System</span><span class="cm">.</span><span class="ci">IO</span><span class="cm">.</span><span class="ci">TextWriter</span></a>
- <span class="cp">*</span> <span class="ci">getStreamByName</span><span class="cp">:</span> <span class="cp">(</span><span class="ci">string</span> <span class="cr">-></span> <a href="charstream.html"><span class="ci">CharStream</span></a><span class="cp">)</span>
- <span class="cp">*</span> <span class="cp">?</span><span class="ci">columnWidth</span><span class="cp">:</span> <span class="ci">int</span>
- <span class="cp">*</span> <span class="cp">?</span><span class="ci">initialIndentation</span><span class="cp">:</span> <span class="ci">string</span> <span class="cp">*</span> <span class="cp">?</span><span class="ci">indentationIncrement</span><span class="cp">:</span> <span class="ci">string</span>
- <span class="cr">-></span> <span class="ci">unit</span>
- <span class="ck">member</span> <a id="interface.WriteTo:B:" href="#members.WriteTo"><span class="interface-member-marker"><span class="ci">WriteTo</span></span></a><span class="cp">:</span>
- <span class="ci">textWriter</span><span class="cp">:</span> <a href="http://msdn.microsoft.com/en-us/library/system.io.textwriter.aspx"><span class="ci">System</span><span class="cm">.</span><span class="ci">IO</span><span class="cm">.</span><span class="ci">TextWriter</span></a>
- <span class="cp">*</span> <span class="cp">?</span><span class="ci">positionPrinter</span><span class="cp">:</span>
- <span class="cp">(</span><a href="http://msdn.microsoft.com/en-us/library/system.io.textwriter.aspx"><span class="ci">System</span><span class="cm">.</span><span class="ci">IO</span><span class="cm">.</span><span class="ci">TextWriter</span></a> <span class="cr">-></span> <a href="position.html"><span class="ci">Position</span></a> <span class="cr">-></span> <span class="ci">string</span> <span class="cr">-></span> <span class="ci">int</span> <span class="cr">-></span> <span class="ci">unit</span><span class="cp">)</span>
- <span class="cp">*</span> <span class="cp">?</span><span class="ci">columnWidth</span><span class="cp">:</span> <span class="ci">int</span>
- <span class="cp">*</span> <span class="cp">?</span><span class="ci">initialIndentation</span><span class="cp">:</span> <span class="ci">string</span> <span class="cp">*</span> <span class="cp">?</span><span class="ci">indentationIncrement</span><span class="cp">:</span> <span class="ci">string</span>
- <span class="cr">-></span> <span class="ci">unit</span>
- <span class="ck">override</span> <span class="ci">Equals</span><span class="cp">:</span> <span class="ci">obj</span> <span class="cr">-></span> <span class="ci">bool</span>
- <span class="ck">override</span> <span class="ci">GetHashCode</span><span class="cp">:</span> <span class="ci">unit</span> <span class="cr">-></span> <span class="ci">int</span>
- <span class="ck">interface</span> <a href="http://msdn.microsoft.com/en-us/library/system.icomparable.aspx"><span class="ci">System</span><span class="cm">.</span><span class="ci">IComparable</span></a>
- </pre>
- </div>
- </div>
- </div>
- <div id="members" class="section s3">
- <h2 class="title h3"><span class="section-number">2.5.2</span> Members</h2>
- <div class="intro i3">
- <div class="para _1">
- <div class="interface-members">
- <div class="interface-member _1" id="members.ErrorMessage">
- <div class="interface-member-code">
- <a class="interface-member-backlink" href="#interface.ErrorMessage:B:">⇧</a>
- <pre class="code fsharp"><span class="ck">type</span> <span class="interface-member-marker"><span class="ci">ErrorMessage</span></span></pre>
- </div>
- <div class="interface-member-description">
- <p class="para _1">
- This union type represents an individual error message within the <code class="fsharp"><a href="#members.ErrorMessageList"><span
- class="ci">ErrorMessageList</span></a></code> returned by a <code class="fsharp"><a href="primitives.html#members.Parser"><span
- class="ci">Parser</span></a></code> function.
- </p>
- <p class="para _2">
- <code class="fsharp"><span class="ci">ErrorMessage</span></code> values are always associated with a particular input stream position. For
- example, the error messages of the <code class="fsharp"><a href="#members.ErrorMessageList"><span
- class="ci">ErrorMessageList</span></a></code> stored in the <code class="fsharp"><a href="primitives.html#members.Reply"><span
- class="ci">Reply</span></a><span class="cp"><</span><span class="ci">_</span><span class="cp">,</span><span class="ci">_</span><span
- class="cp">></span><span class="cp">.</span><a href="primitives.html#members.Error"><span class="ci">Error</span></a></code> field
- describe an error at the position of the <code class="fsharp"><a href="primitives.html#members.Reply"><span class="ci">Reply</span></a><span
- class="cp"><</span><span class="ci">_</span><span class="cp">,</span><span class="ci">_</span><span class="cp">></span><span
- class="cp">.</span><a href="state.html"><span class="ci">State</span></a></code> value. The <code class="fsharp"><a
- href="#members.ParserError"><span class="ci">ParserError</span></a></code> type is a convenient container type for binding together an <code
- class="fsharp"><a href="#members.ErrorMessageList"><span class="ci">ErrorMessageList</span></a></code> with its associated position.
- </p>
- <p class="para _3"><code class="fsharp"><span class="ci">ErrorMessage</span></code> has the following union cases:</p>
- <div class="para _4">
- <div class="interface-members">
- <div class="interface-member _1" id="members.Expected">
- <div class="interface-member-code">
- <a class="interface-member-backlink" href="#interface.Expected:B:">⇧</a>
- <pre class="code fsharp"><span class="cp">|</span> <span class="interface-member-marker"><span class="ci">Expected</span></span> <span class="ck">of</span> <span class="ci">string</span>
- </pre>
- </div>
- <div class="interface-member-description">
- <p class="para _1">
- Parsers report this <code class="fsharp"><span class="ci">ErrorMessage</span></code> when the input does not match the expected input.
- The string argument describes the expected input.
- </p>
- <p class="para _2">
- This error message can be generated with the labeling operator <code class="fsharp"><a href="primitives.html#members.:60::63::62:"><span
- class="co"><?></span></a></code>.
- </p>
- </div>
- </div>
- <div class="interface-member _2" id="members.ExpectedString">
- <div class="interface-member-code">
- <a class="interface-member-backlink" href="#interface.ExpectedString:B:">⇧</a>
- <pre class="code fsharp"><span class="cp">|</span> <span class="interface-member-marker"><span class="ci">ExpectedString</span></span> <span class="ck">of</span> <span class="ci">string</span>
- </pre>
- </div>
- <div class="interface-member-description">
- <p class="para _1">
- Parsers report this <code class="fsharp"><span class="ci">ErrorMessage</span></code> when the input does not match an expected string
- constant. The constructor argument is the expected string constant.
- </p>
- <p class="para _2">
- This <code class="fsharp"><span class="ci">ErrorMessage</span></code> is mainly generated by the <code class="fsharp"><a
- href="charparsers.html#members.pchar"><span class="ci">pchar</span></a></code> and <code class="fsharp"><a
- href="charparsers.html#members.pstring"><span class="ci">pstring</span></a></code> parsers and its variants.
- </p>
- </div>
- </div>
- <div class="interface-member _3" id="members.ExpectedStringCI">
- <div class="interface-member-code">
- <a class="interface-member-backlink" href="#interface.ExpectedStringCI:B:">⇧</a>
- <pre class="code fsharp"><span class="cp">|</span> <span class="interface-member-marker"><span class="ci">ExpectedStringCI</span></span> <span class="ck">of</span> <span class="ci">string</span>
- </pre>
- </div>
- <div class="interface-member-description">
- <p class="para _1">
- Parsers report this <code class="fsharp"><span class="ci">ErrorMessage</span></code> when the input does not match an expected
- case‐insensitive string constant. The constructor argument is the expected string constant.
- </p>
- <p class="para _2">
- This <code class="fsharp"><span class="ci">ErrorMessage</span></code> is mainly generated by the <code class="fsharp"><a
- href="charparsers.html#members.pstringCI"><span class="ci">pstringCI</span></a></code> parsers and its variants.
- </p>
- </div>
- </div>
- <div class="interface-member _4" id="members.Unexpected">
- <div class="interface-member-code">
- <a class="interface-member-backlink" href="#interface.Unexpected:B:">⇧</a>
- <pre class="code fsharp"><span class="cp">|</span> <span class="interface-member-marker"><span class="ci">Unexpected</span></span> <span class="ck">of</span> <span class="ci">string</span>
- </pre>
- </div>
- <div class="interface-member-description">
- <p class="para _1">
- Parsers report this <code class="fsharp"><span class="ci">ErrorMessage</span></code> when they encounter some unexpected input. The
- string argument describes the unexpected input.
- </p>
- <p class="para _2">
- This <code class="fsharp"><span class="ci">ErrorMessage</span></code> is mainly generated by the <code class="fsharp"><a
- href="primitives.html#members.notFollowedByL"><span class="ci">notFollowedByL</span></a></code> primitive.
- </p>
- </div>
- </div>
- <div class="interface-member _5" id="members.UnexpectedString">
- <div class="interface-member-code">
- <a class="interface-member-backlink" href="#interface.UnexpectedString:B:">⇧</a>
- <pre class="code fsharp"><span class="cp">|</span> <span class="interface-member-marker"><span class="ci">UnexpectedString</span></span> <span class="ck">of</span> <span class="ci">string</span>
- </pre>
- </div>
- <div class="interface-member-description">
- <p class="para _1">
- Parsers report this <code class="fsharp"><span class="ci">ErrorMessage</span></code> when they encounter an unexpected string constant.
- The constructor argument is the unexpected string.
- </p>
- <p class="para _2">
- This <code class="fsharp"><span class="ci">ErrorMessage</span></code> is mainly generated by the <code class="fsharp"><a
- href="charparsers.html#members.notFollowedByChar"><span class="ci">notFollowedByChar</span></a></code> and <code class="fsharp"><a
- href="charparsers.html#members.notFollowedByString"><span class="ci">notFollowedByString</span></a></code> parsers.
- </p>
- </div>
- </div>
- <div class="interface-member _6" id="members.UnexpectedStringCI">
- <div class="interface-member-code">
- <a class="interface-member-backlink" href="#interface.UnexpectedStringCI:B:">⇧</a>
- <pre class="code fsharp"><span class="cp">|</span> <span class="interface-member-marker"><span class="ci">UnexpectedStringCI</span></span> <span class="ck">of</span> <span class="ci">string</span>
- </pre>
- </div>
- <div class="interface-member-description">
- <p class="para _1">
- Parsers report this <code class="fsharp"><span class="ci">ErrorMessage</span></code> when they encounter an unexpected case‐insensitive
- string constant. The constructor argument is the unexpected string.
- </p>
- <p class="para _2">
- This <code class="fsharp"><span class="ci">ErrorMessage</span></code> is mainly generated by the <code class="fsharp"><a
- href="charparsers.html#members.notFollowedByStringCI"><span class="ci">notFollowedByStringCI</span></a></code> parsers.
- </p>
- </div>
- </div>
- <div class="interface-member _7" id="members.Message">
- <div class="interface-member-code">
- <a class="interface-member-backlink" href="#interface.Message:B:">⇧</a>
- <pre class="code fsharp"><span class="cp">|</span> <span class="interface-member-marker"><span class="ci">Message</span></span> <span class="ck">of</span> <span class="ci">string</span>
- </pre>
- </div>
- <div class="interface-member-description">
- <p class="para _1">
- Parsers report this <code class="fsharp"><span class="ci">ErrorMessage</span></code> when an the error does not fit into the other
- categories. The string argument contains the error message.
- </p>
- <p class="para _2">
- This error message can be generated with the <code class="fsharp"><a href="primitives.html#members.fail"><span
- class="ci">fail</span></a></code> and <code class="fsharp"><a href="primitives.html#members.failFatally"><span
- class="ci">failFatally</span></a></code> primitives.
- </p>
- </div>
- </div>
- <div class="interface-member _8" id="members.CompoundError">
- <div class="interface-member-code">
- <a class="interface-member-backlink" href="#interface.CompoundError:B:">⇧</a>
- <pre class="code fsharp"><span class="cp">|</span> <span class="interface-member-marker"><span class="ci">CompoundError</span></span> <span class="ck">of</span> <span class="ci">string</span> <span class="cp">*</span> <a href="position.html"><span class="ci">Position</span></a> <span class="cp">*</span> <a href="#members.ErrorMessageList"><span class="ci">ErrorMessageList</span></a>
- </pre>
- </div>
- <div class="interface-member-description">
- <p class="para _1">
- Parsers report this <code class="fsharp"><span class="ci">ErrorMessage</span></code> when a “compound” failed to parse. The
- constructor arguments are a label for the compound parser and the error (<code class="fsharp"><a href="#members.Position"><span
- class="ci">Position</span></a></code> + <code class="fsharp"><a href="#members.ErrorMessageList"><span
- class="ci">ErrorMessageList</span></a></code>) that caused the compound to fail to parse.
- </p>
- <p class="para _2">
- This error message is mainly generated by the compound‐labelling operator <code class="fsharp"><a
- href="primitives.html#members.:60::63::63::62:"><span class="co"><??></span></a></code>.
- </p>
- </div>
- </div>
- <div class="interface-member _9" id="members.BacktrackPoint">
- <div class="interface-member-code">
- <a class="interface-member-backlink" href="#interface.BacktrackPoint:B:">⇧</a>
- <pre class="code fsharp"><span class="cp">|</span> <span class="interface-member-marker"><span class="ci">BacktrackPoint</span></span> <span class="ck">of</span> <a href="position.html"><span class="ci">Position</span></a> <span class="cp">*</span> <a href="#members.ErrorMessageList"><span class="ci">ErrorMessageList</span></a>
- </pre>
- </div>
- <div class="interface-member-description">
- <p class="para _1">
- Parsers report this <code class="fsharp"><span class="ci">ErrorMessage</span></code> when they backtracked after an error occurred. The
- constructor argument is the error (<code class="fsharp"><a href="#members.Position"><span class="ci">Position</span></a></code> + <code
- class="fsharp"><a href="#members.ErrorMessageList"><span class="ci">ErrorMessageList</span></a></code>) that occurred before the
- backtracking.
- </p>
- <p class="para _2">
- This error message is mainly generated by the <code class="fsharp"><a href="primitives.html#members.attempt"><span
- class="ci">attempt</span></a></code>, <code class="fsharp"><a href="primitives.html#members.:62::62::63:"><span
- class="co">>>?</span></a></code> and <code class="fsharp"><a href="primitives.html#members.:.::62::62::63:"><span
- class="co">.>>?</span></a></code> primitives.
- </p>
- </div>
- </div>
- <div class="interface-member _0" id="members.OtherError">
- <div class="interface-member-code">
- <a class="interface-member-backlink" href="#interface.OtherError:B:">⇧</a>
- <pre class="code fsharp"><span class="cp">|</span> <span class="interface-member-marker"><span class="ci">OtherError</span></span> <span class="ck">of</span> <a href="http://msdn.microsoft.com/en-us/library/system.icomparable.aspx"><span class="ci">System</span><span class="cm">.</span><span class="ci">IComparable</span></a>
- </pre>
- </div>
- <div class="interface-member-description">
- <p class="para _1">
- User‐defined parsers can return this <code class="fsharp"><span class="ci">ErrorMessage</span></code> to report application‐specific
- error data. The object argument contains the error data.
- </p>
- <p class="para _2">
- To display <code class="fsharp"><span class="ci">OtherError</span></code> values in error messages, you will have to define your own
- error printer, as <code class="fsharp"><a href="#members.ParserError"><span class="ci">ParserError</span></a><span class="cm">.</span><a
- href="#interface.ToString:47:WriteTo"><span class="ci">ToString</span><span class="co">/</span><span class="ci">WriteTo</span></a></code>
- ignores them.
- </p>
- </div>
- </div>
- </div>
- </div>
- </div>
- </div>
- <div class="interface-member _2" id="members.ErrorMessageList">
- <div class="interface-member-code">
- <a class="interface-member-backlink" href="#interface.ErrorMessageList:B:">⇧</a>
- <pre class="code fsharp"><span class="ck">type</span> <span class="interface-member-marker"><span class="ci">ErrorMessageList</span></span></pre>
- </div>
- <div class="interface-member-description">
- <p class="para _1">
- This union type represents a list of error messages in which the order of the messages carries no meaning and any duplicates and empty
- messages are ignored. Essentially, an <code class="fsharp"><span class="ci">ErrorMessageList</span></code> is <em>constructed as a list, but
- interpreted as a set</em>.
- </p>
- <p class="para _2">
- All <code class="fsharp"><a href="#members.ErrorMessage"><span class="ci">ErrorMessage</span></a></code> values in an <code
- class="fsharp"><span class="ci">ErrorMessageList</span></code> are associated with the same input stream position. For example, the error
- messages stored in the <code class="fsharp"><a href="primitives.html#members.Reply"><span class="ci">Reply</span></a><span
- class="cp"><</span><span class="ci">_</span><span class="cp">,</span><span class="ci">_</span><span class="cp">></span><span
- class="cp">.</span><a href="primitives.html#members.Error"><span class="ci">Error</span></a></code> field describe an error at the position
- of the <code class="fsharp"><a href="primitives.html#members.Reply"><span class="ci">Reply</span></a><span class="cp"><</span><span
- class="ci">_</span><span class="cp">,</span><span class="ci">_</span><span class="cp">></span><span class="cp">.</span><a
- href="state.html"><span class="ci">State</span></a></code> value. The <code class="fsharp"><a href="#members.ParserError"><span
- class="ci">ParserError</span></a></code> type is a convenient container type for binding together an <code class="fsharp"><span
- class="ci">ErrorMessageList</span></code> with its associated position.
- </p>
- <p class="para _3">
- The easiest way to process an <code class="fsharp"><span class="ci">ErrorMessageList</span></code> as a set is to convert it into an actual
- set by using the <code class="fsharp"><a href="#members.ToSet"><span class="ci">ToSet</span></a></code> member. For example, the <code
- class="fsharp"><a href="#members.ParserError"><span class="ci">ParserError</span></a><span class="cm">.</span><a
- href="#members.WriteTo"><span class="ci">WriteTo</span></a></code> method uses this method to filter out duplicates before printing out the
- messages.
- </p>
- <p class="para _4">
- In order to enforce set semantics in comparison operations, the <code class="fsharp"><span class="ci">ErrorMessageList</span></code>
- overrides the <code class="fsharp"><span class="ci">Equals</span></code>, <code class="fsharp"><span class="ci">GetHashCode</span></code> and
- <code class="fsharp"><span class="ci">CompareTo</span></code> methods.
- </p>
- <div class="para _5">
- <div class="interface-members">
- <div class="interface-member _1" id="members.AddErrorMessage">
- <div class="interface-member-code">
- <a class="interface-member-backlink" href="#interface.AddErrorMessage:B:">⇧</a>
- <pre class="code fsharp"><span class="cp">|</span> <span class="interface-member-marker"><span class="ci">AddErrorMessage</span></span> <span class="ck">of</span> <a href="#members.ErrorMessage"><span class="ci">ErrorMessage</span></a> <span class="cp">*</span> <span class="ci">ErrorMessageList</span>
- </pre>
- </div>
- <div class="interface-member-description">
- <p class="para _1">
- Creates a new <code class="fsharp"><span class="ci">ErrorMessageList</span></code> with the given “head” and
- “tail”.
- </p>
- <div class="para _2">
- <p>For example,</p>
- <pre class="code fsharp"><span class="ci">AddErrorMessage</span><span class="cp">(</span><a href="#members.Expected"><span class="ci">Expected</span></a> <span class="cs"><span class="left-delimiter">"</span>a<span class="right-delimiter">"</span></span><span class="cp">,</span>
- <span class="ci">AddErrorMessage</span><span class="cp">(</span><a href="#members.Expected"><span class="ci">Expected</span></a> <span class="cs"><span class="left-delimiter">"</span>b<span class="right-delimiter">"</span></span><span class="cp">,</span> <a href="#members.NoErrorMessages"><span class="ci">NoErrorMessages</span></a><span class="cp">)</span><span class="cp">)</span>
- </pre>
- <p>creates an <code class="fsharp"><span class="ci">ErrorMessageList</span></code> with two error messages.</p>
- </div>
- </div>
- </div>
- <div class="interface-member _2" id="members.NoErrorMessages">
- <div class="interface-member-code">
- <a class="interface-member-backlink" href="#interface.NoErrorMessages:B:">⇧</a>
- <pre class="code fsharp"><span class="cp">|</span> <span class="interface-member-marker"><span class="ci">NoErrorMessages</span></span>
- </pre>
- </div>
- <div class="interface-member-description">
- <p class="para _1">
- The empty <code class="fsharp"><span class="ci">ErrorMessageList</span></code>. This value is represented as <code class="fsharp"><span
- class="cnu">null</span></code>.
- </p>
- </div>
- </div>
- <div class="interface-member _3" id="members.ToSet">
- <div class="interface-member-code">
- <a class="interface-member-backlink" href="#interface.ToSet:B:">⇧</a>
- <pre class="code fsharp"><span class="ck">member</span> <span class="interface-member-marker"><span class="ci">ToSet</span></span><span class="cp">:</span> <span class="ci">unit</span> <span class="cr">-></span> <span class="ci">Set</span><span class="cp"><</span><a href="#members.ErrorMessage"><span class="ci">ErrorMessage</span></a><span class="cp">></span>
- </pre>
- </div>
- <div class="interface-member-description">
- <p class="para _1">
- Converts the <code class="fsharp"><span class="ci">ErrorMessageList</span></code> to a <code class="fsharp"><span
- class="ci">Set</span><span class="cp"><</span><span class="ci">ErrorMessageList</span><span class="cp">></span></code>. Duplicate
- error messages and empty <code class="fsharp"><a href="#members.Expected"><span class="ci">Expected</span></a></code>, <code
- class="fsharp"><a href="#members.Unexpected"><span class="ci">Unexpected</span></a></code> and <code class="fsharp"><a
- href="#members.Message"><span class="ci">Message</span></a></code> messages are filtered out when the list is converted to a set.
- </p>
- </div>
- </div>
- <div class="interface-member _4" id="members.OfSeq">
- <div class="interface-member-code">
- <a class="interface-member-backlink" href="#interface.OfSeq:B:">⇧</a>
- <pre class="code fsharp"><span class="ck">static</span> <span class="ck">member</span> <span class="interface-member-marker"><span class="ci">OfSeq</span></span><span class="cp">:</span> <span class="ci">seq</span><span class="cp"><</span><a href="#members.ErrorMessage"><span class="ci">ErrorMessage</span></a><span class="cp">></span> <span class="cr">-></span> <span class="ci">ErrorMessageList</span>
- </pre>
- </div>
- <div class="interface-member-description">
- <p class="para _1">
- Converts a sequence of <code class="fsharp"><a href="#members.ErrorMessage"><span class="ci">ErrorMessage</span></a></code> values into
- an <code class="fsharp"><span class="ci">ErrorMessageList</span></code>.
- </p>
- </div>
- </div>
- </div>
- </div>
- </div>
- </div>
- <div class="interface-member _3" id="members.expectedError">
- <div class="interface-member-code">
- <a class="interface-member-backlink" href="#interface.expectedError:B:">⇧</a>
- <pre class="code fsharp"><span class="ck">val</span> <span class="interface-member-marker"><span class="ci">expectedError</span></span><span class="cp">:</span> <span class="ci">string</span> <span class="cr">-></span> <a href="#members.ErrorMessageList"><span class="ci">ErrorMessageList</span></a>
- </pre>
- </div>
- <div class="interface-member-description">
- <p class="para _1">
- <code class="fsharp"><span class="ci">expectedError</span> <span class="ci">label</span></code> creates an <code class="fsharp"><a
- href="#members.ErrorMessageList"><span class="ci">ErrorMessageList</span></a></code> with a single <code class="fsharp"><a
- href="#members.Expected"><span class="ci">Expected</span></a> <span class="ci">label</span></code> message.
- </p>
- </div>
- </div>
- <div class="interface-member _4" id="members.expectedStringError">
- <div class="interface-member-code">
- <a class="interface-member-backlink" href="#interface.expectedStringError:B:">⇧</a>
- <pre class="code fsharp"><span class="ck">val</span> <span class="interface-member-marker"><span class="ci">expectedStringError</span></span><span class="cp">:</span> <span class="ci">string</span> <span class="cr">-></span> <a href="#members.ErrorMessageList"><span class="ci">ErrorMessageList</span></a>
- </pre>
- </div>
- <div class="interface-member-description">
- <p class="para _1">
- <code class="fsharp"><span class="ci">expectedStringError</span> <span class="ci">str</span></code> creates an <code class="fsharp"><a
- href="#members.ErrorMessageList"><span class="ci">ErrorMessageList</span></a></code> with a single <code class="fsharp"><a
- href="#members.ExpectedString"><span class="ci">ExpectedString</span></a> <span class="ci">str</span></code> message.
- </p>
- </div>
- </div>
- <div class="interface-member _5" id="members.expectedStringCIError">
- <div class="interface-member-code">
- <a class="interface-member-backlink" href="#interface.expectedStringCIError:B:">⇧</a>
- <pre class="code fsharp"><span class="ck">val</span> <span class="interface-member-marker"><span class="ci">expectedStringCIError</span></span><span class="cp">:</span> <span class="ci">string</span> <span class="cr">-></span> <a href="#members.ErrorMessageList"><span class="ci">ErrorMessageList</span></a>
- </pre>
- </div>
- <div class="interface-member-description">
- <p class="para _1">
- <code class="fsharp"><span class="ci">expectedStringCIError</span> <span class="ci">str</span></code> creates an <code class="fsharp"><a
- href="#members.ErrorMessageList"><span class="ci">ErrorMessageList</span></a></code> with a single <code class="fsharp"><a
- href="#members.ExpectedStringCI"><span class="ci">ExpectedStringCI</span></a> <span class="ci">str</span></code> message.
- </p>
- </div>
- </div>
- <div class="interface-member _6" id="members.unexpectedError">
- <div class="interface-member-code">
- <a class="interface-member-backlink" href="#interface.unexpectedError:B:">⇧</a>
- <pre class="code fsharp"><span class="ck">val</span> <span class="interface-member-marker"><span class="ci">unexpectedError</span></span><span class="cp">:</span> <span class="ci">string</span> <span class="cr">-></span> <a href="#members.ErrorMessageList"><span class="ci">ErrorMessageList</span></a>
- </pre>
- </div>
- <div class="interface-member-description">
- <p class="para _1">
- <code class="fsharp"><span class="ci">unexpectedError</span> <span class="ci">label</span></code> creates an <code class="fsharp"><a
- href="#members.ErrorMessageList"><span class="ci">ErrorMessageList</span></a></code> with a single <code class="fsharp"><a
- href="#members.Unexpected"><span class="ci">Unexpected</span></a> <span class="ci">label</span></code> message.
- </p>
- </div>
- </div>
- <div class="interface-member _7" id="members.unexpectedStringError">
- <div class="interface-member-code">
- <a class="interface-member-backlink" href="#interface.unexpectedStringError:B:">⇧</a>
- <pre class="code fsharp"><span class="ck">val</span> <span class="interface-member-marker"><span class="ci">unexpectedStringError</span></span><span class="cp">:</span> <span class="ci">string</span> <span class="cr">-></span> <a href="#members.ErrorMessageList"><span class="ci">ErrorMessageList</span></a>
- </pre>
- </div>
- <div class="interface-member-description">
- <p class="para _1">
- <code class="fsharp"><span class="ci">unexpectedStringError</span> <span class="ci">str</span></code> creates an <code class="fsharp"><a
- href="#members.ErrorMessageList"><span class="ci">ErrorMessageList</span></a></code> with a single <code class="fsharp"><a
- href="#members.UnexpectedString"><span class="ci">UnexpectedString</span></a> <span class="ci">str</span></code> message.
- </p>
- </div>
- </div>
- <div class="interface-member _8" id="members.unexpectedStringCIError">
- <div class="interface-member-code">
- <a class="interface-member-backlink" href="#interface.unexpectedStringCIError:B:">⇧</a>
- <pre class="code fsharp"><span class="ck">val</span> <span class="interface-member-marker"><span class="ci">unexpectedStringCIError</span></span><span class="cp">:</span> <span class="ci">string</span> <span class="cr">-></span> <a href="#members.ErrorMessageList"><span class="ci">ErrorMessageList</span></a>
- </pre>
- </div>
- <div class="interface-member-description">
- <p class="para _1">
- <code class="fsharp"><span class="ci">unexpectedStringCIError</span> <span class="ci">str</span></code> creates an <code class="fsharp"><a
- href="#members.ErrorMessageList"><span class="ci">ErrorMessageList</span></a></code> with a single <code class="fsharp"><a
- href="#members.UnexpectedStringCI"><span class="ci">UnexpectedStringCI</span></a> <span class="ci">str</span></code> message.
- </p>
- </div>
- </div>
- <div class="interface-member _9" id="members.messageError">
- <div class="interface-member-code">
- <a class="interface-member-backlink" href="#interface.messageError:B:">⇧</a>
- <pre class="code fsharp"><span class="ck">val</span> <span class="interface-member-marker"><span class="ci">messageError</span></span><span class="cp">:</span> <span class="ci">string</span> <span class="cr">-></span> <a href="#members.ErrorMessageList"><span class="ci">ErrorMessageList</span></a>
- </pre>
- </div>
- <div class="interface-member-description">
- <p class="para _1">
- <code class="fsharp"><span class="ci">messageError</span> <span class="ci">msg</span></code> creates an <code class="fsharp"><a
- href="#members.ErrorMessageList"><span class="ci">ErrorMessageList</span></a></code> with a single <code class="fsharp"><a
- href="#members.Message"><span class="ci">Message</span></a> <span class="ci">msg</span></code> message.
- </p>
- </div>
- </div>
- <div class="interface-member _0" id="members.otherError">
- <div class="interface-member-code">
- <a class="interface-member-backlink" href="#interface.otherError:B:">⇧</a>
- <pre class="code fsharp"><span class="ck">val</span> <span class="interface-member-marker"><span class="ci">otherError</span></span><span class="cp">:</span> <span class="ci">obj</span> <span class="cr">-></span> <a href="#members.ErrorMessageList"><span class="ci">ErrorMessageList</span></a>
- </pre>
- </div>
- <div class="interface-member-description">
- <p class="para _1">
- <code class="fsharp"><span class="ci">otherError</span> <span class="ci">o</span></code> creates an <code class="fsharp"><a
- href="#members.ErrorMessageList"><span class="ci">ErrorMessageList</span></a></code> with a single <code class="fsharp"><a
- href="#members.OtherError"><span class="ci">OtherError</span></a> <span class="ci">o</span></code> message.
- </p>
- </div>
- </div>
- <div class="interface-member _1" id="members.compoundError">
- <div class="interface-member-code">
- <a class="interface-member-backlink" href="#interface.compoundError:B:">⇧</a>
- <pre class="code fsharp"><span class="ck">val</span> <span class="interface-member-marker"><span class="ci">compoundError</span></span><span class="cp">:</span> <span class="ci">string</span> <span class="cr">-></span> <a href="state.html"><span class="ci">State</span></a><span class="cp"><</span><span class="ctv">'u</span><span class="cp">></span> <span class="cr">-></span> <a href="#members.ErrorMessageList"><span class="ci">ErrorMessageList</span></a> <span class="cr">-></span> <a href="#members.ErrorMessageList"><span class="ci">ErrorMessageList</span></a>
- </pre>
- </div>
- <div class="interface-member-description">
- <p class="para _1">
- <code class="fsharp"><span class="ci">compoundError</span> <span class="ci">label</span> <span class="ci">state</span> <span
- class="ci">msgs</span></code> creates an <code class="fsharp"><a href="#members.ErrorMessageList"><span
- class="ci">ErrorMessageList</span></a></code> with a single <code class="fsharp"><a href="#members.CompoundError"><span
- class="ci">CompoundError</span></a> <span class="ci">label</span> <span class="ci">state</span><span class="cm">.</span><a
- href="#members.Position"><span class="ci">Position</span></a> <span class="ci">msgs</span></code> message, except if <code
- class="fsharp"><span class="ci">msgs</span></code> is an <code class="fsharp"><a href="#members.ErrorMessageList"><span
- class="ci">ErrorMessageList</span></a></code> with a single <code class="fsharp"><a href="#members.BacktrackPoint"><span
- class="ci">BacktrackPoint</span></a><span class="cp">(</span><span class="ci">pos2</span><span class="cp">,</span> <span
- class="ci">msgs2</span><span class="cp">)</span></code> message, in which case an <code class="fsharp"><a
- href="#members.ErrorMessageList"><span class="ci">ErrorMessageList</span></a></code> with a single <code class="fsharp"><a
- href="#members.CompoundError"><span class="ci">CompoundError</span></a> <span class="ci">label</span> <span class="ci">pos2</span> <span
- class="ci">msgs2</span></code> message is returned instead.
- </p>
- </div>
- </div>
- <div class="interface-member _2" id="members.backtrackError">
- <div class="interface-member-code">
- <a class="interface-member-backlink" href="#interface.backtrackError:B:">⇧</a>
- <pre class="code fsharp"><span class="ck">val</span> <span class="interface-member-marker"><span class="ci">backtrackError</span></span><span class="cp">:</span> <a href="state.html"><span class="ci">State</span></a><span class="cp"><</span><span class="ctv">'u</span><span class="cp">></span> <span class="cr">-></span> <a href="#members.ErrorMessageList"><span class="ci">ErrorMessageList</span></a> <span class="cr">-></span> <a href="#members.ErrorMessageList"><span class="ci">ErrorMessageList</span></a>
- </pre>
- </div>
- <div class="interface-member-description">
- <p class="para _1">
- <code class="fsharp"><span class="ci">backtrackError</span> <span class="ci">state</span> <span class="ci">msgs</span></code> creates an
- <code class="fsharp"><a href="#members.ErrorMessageList"><span class="ci">ErrorMessageList</span></a></code> with a single <code
- class="fsharp"><a href="#members.BacktrackPoint"><span class="ci">BacktrackPoint</span></a> <span class="ci">stat</span><span
- class="cm">.</span><a href="#members.Position"><span class="ci">Position</span></a> <span class="ci">msgs</span></code> message, except if
- <code class="fsharp"><span class="ci">msgs</span></code> is already an <code class="fsharp"><a href="#members.ErrorMessageList"><span
- class="ci">ErrorMessageList</span></a></code> with a single <code class="fsharp"><a href="#members.BacktrackPoint"><span
- class="ci">BacktrackPoint</span></a><span class="cp">(</span><span class="ci">_</span><span class="cp">,</span> <span
- class="ci">_</span><span class="cp">)</span></code> message, in which case <code class="fsharp"><span class="ci">msgs</span></code> is
- returned instead.
- </p>
- </div>
- </div>
- <div class="interface-member _3" id="members.concatErrorMessages">
- <div class="interface-member-code">
- <a class="interface-member-backlink" href="#interface.concatErrorMessages:B:">⇧</a>
- <pre class="code fsharp"><span class="ck">val</span> <span class="interface-member-marker"><span class="ci">concatErrorMessages</span></span><span class="cp">:</span>
- <a href="#members.ErrorMessageList"><span class="ci">ErrorMessageList</span></a> <span class="cr">-></span> <a href="#members.ErrorMessageList"><span class="ci">ErrorMessageList</span></a> <span class="cr">-></span> <a href="#members.ErrorMessageList"><span class="ci">ErrorMessageList</span></a>
- </pre>
- </div>
- <div class="interface-member-description">
- <p class="para _1">
- <code class="fsharp"><span class="ci">concatErrorMessages</span> <span class="ci">error1</span> <span class="ci">error2</span></code>
- concatenates the two error message lists <code class="fsharp"><span class="ci">error1</span></code> and <code class="fsharp"><span
- class="ci">error2</span></code>.
- </p>
- </div>
- </div>
- <div class="interface-member _4" id="members.mergeErrors">
- <div class="interface-member-code">
- <a class="interface-member-backlink" href="#interface.mergeErrors:B:">⇧</a>
- <pre class="code fsharp"><span class="ck">val</span> <span class="ck">inline</span> <span class="interface-member-marker"><span class="ci">mergeErrors</span></span><span class="cp">:</span>
- <a href="#members.ErrorMessageList"><span class="ci">ErrorMessageList</span></a> <span class="cr">-></span> <a href="#members.ErrorMessageList"><span class="ci">ErrorMessageList</span></a> <span class="cr">-></span> <a href="#members.ErrorMessageList"><span class="ci">ErrorMessageList</span></a>
- </pre>
- </div>
- <div class="interface-member-description">
- <p class="para _1">
- <code class="fsharp"><span class="ci">mergeErrors</span> <span class="ci">error1</span> <span class="ci">error2</span></code> is an inlined
- variant of <code class="fsharp"><a href="#members.concatErrorMessages"><span class="ci">concatErrorMessages</span></a> <span
- class="ci">error1</span> <span class="ci">error2</span></code> that avoids the call to <code class="fsharp"><a
- href="#members.concatErrorMessages"><span class="ci">concatErrorMessages</span></a></code> if <code class="fsharp"><span
- class="ci">error1</span></code> is empty (i.e. equals <code class="fsharp"><a href="#members.NoErrorMessages"><span
- class="ci">NoErrorMessages</span></a></code>).
- </p>
- </div>
- </div>
- <div class="interface-member _5" id="members.mergeErrorsIfNeeded">
- <div class="interface-member-code">
- <a class="interface-member-backlink" href="#interface.mergeErrorsIfNeeded:B:">⇧</a>
- <pre class="code fsharp"><span class="ck">val</span> <span class="interface-member-marker"><span class="ci">mergeErrorsIfNeeded</span></span><span class="cp">:</span>
- <span class="ci">oldState</span><span class="cp">:</span> <a href="state.html"><span class="ci">State</span></a><span class="cp"><</span><span class="ctv">'u</span><span class="cp">></span> <span class="cr">-></span> <span class="ci">oldError</span><span class="cp">:</span> <a href="#members.ErrorMessageList"><span class="ci">ErrorMessageList</span></a>
- <span class="cr">-></span> <span class="ci">newState</span><span class="cp">:</span> <a href="state.html"><span class="ci">State</span></a><span class="cp"><</span><span class="ctv">'u</span><span class="cp">></span> <span class="cr">-></span> <span class="ci">newError</span><span class="cp">:</span> <a href="#members.ErrorMessageList"><span class="ci">ErrorMessageList</span></a>
- <span class="cr">-></span> <a href="#members.ErrorMessageList"><span class="ci">ErrorMessageList</span></a>
- </pre>
- </div>
- <div class="interface-member-description">
- <div class="para _1">
- <p>
- <code class="fsharp"><span class="ci">mergeErrorsIfNeeded</span> <span class="ci">oldState</span> <span class="ci">oldError</span> <span
- class="ci">newState</span> <span class="ci">newError</span></code> is equivalent to
- </p>
- <pre class="code fsharp"><span class="ck">if</span> <span class="ci">newState</span> <span class="co"><></span> <a href="state.html"><span class="ci">State</span></a> <span class="ck">then</span> <span class="ci">newError</span> <span class="ck">else</span> <a href="#members.mergeErrors"><span class="ci">mergeErrors</span></a> <span class="ci">oldError</span> <span class="ci">newError</span></pre>
- </div>
- </div>
- </div>
- <div class="interface-member _6" id="members.mergeErrorsIfNeeded3">
- <div class="interface-member-code">
- <a class="interface-member-backlink" href="#interface.mergeErrorsIfNeeded3:B:">⇧</a>
- <pre class="code fsharp"><span class="ck">val</span> <span class="interface-member-marker"><span class="ci">mergeErrorsIfNeeded3</span></span><span class="cp">:</span>
- <span class="ci">oldestState</span><span class="cp">:</span> <a href="state.html"><span class="ci">State</span></a><span class="cp"><</span><span class="ctv">'u</span><span class="cp">></span> <span class="cr">-></span> <span class="ci">oldestError</span><span class="cp">:</span> <a href="#members.ErrorMessageList"><span class="ci">ErrorMessageList</span></a>
- <span class="cr">-></span> <span class="ci">oldState</span><span class="cp">:</span> <a href="state.html"><span class="ci">State</span></a><span class="cp"><</span><span class="ctv">'u</span><span class="cp">></span> <span class="cr">-></span> <span class="ci">oldError</span><span class="cp">:</span> <a href="#members.ErrorMessageList"><span class="ci">ErrorMessageList</span></a>
- <span class="cr">-></span> <span class="ci">newState</span><span class="cp">:</span> <a href="state.html"><span class="ci">State</span></a><span class="cp"><</span><span class="ctv">'u</span><span class="cp">></span> <span class="cr">-></span> <span class="ci">newError</span><span class="cp">:</span> <a href="#members.ErrorMessageList"><span class="ci">ErrorMessageList</span></a>
- <span class="cr">-></span> <a href="#members.ErrorMessageList"><span class="ci">ErrorMessageList</span></a>
- </pre>
- </div>
- <div class="interface-member-description">
- <div class="para _1">
- <p>
- <code class="fsharp"><span class="ci">mergeErrorsIfNeeded3</span> <span class="ci">veryOldState</span> <span
- class="ci">veryOldError</span> <span class="ci">oldState</span> <span class="ci">oldError</span> <span class="ci">newState</span> <span
- class="ci">newError</span></code> is equivalent to
- </p>
- <pre class="code fsharp"><a href="#members.mergeErrorsIfNeeded"><span class="ci">mergeErrorsIfNeeded</span></a>
- <span class="ci">oldState</span> <span class="cp">(</span><a href="#members.mergeErrorsIfNeeded"><span class="ci">mergeErrorsIfNeeded</span></a> <span class="ci">veryOldState</span> <span class="ci">veryOldError</span>
- <span class="ci">oldState</span> <span class="ci">oldError</span><span class="cp">)</span>
- <span class="ci">newState</span> <span class="ci">newError</span>
- </pre>
- </div>
- </div>
- </div>
- <div class="interface-member _7" id="members.ParserError">
- <div class="interface-member-code">
- <a class="interface-member-backlink" href="#interface.ParserError:B:">⇧</a>
- <pre class="code fsharp"><span class="cp">[<</span><span class="ci">Sealed</span><span class="cp">>]</span>
- <span class="ck">type</span> <span class="interface-member-marker"><span class="ci">ParserError</span></span></pre>
- </div>
- <div class="interface-member-description">
- <p class="para _1">
- <code class="fsharp"><span class="ci">ParserError</span></code> is a simple container type for holding an <code class="fsharp"><a
- href="#members.ErrorMessageList"><span class="ci">ErrorMessageList</span></a></code> together with its associated input stream position.
- </p>
- <div class="para _2">
- <div class="interface-members">
- <div class="interface-member _1" id="members.new">
- <div class="interface-member-code">
- <a class="interface-member-backlink" href="#interface.new:B:">⇧</a>
- <pre class="code fsharp"><span class="interface-member-marker"><span class="ck">new</span></span><span class="cp">:</span> <a href="position.html"><span class="ci">Position</span></a> <span class="cp">*</span> <a href="#members.ErrorMessageList"><span class="ci">ErrorMessageList</span></a> <span class="cr">-></span> <span class="ci">ParserError</span>
- </pre>
- </div>
- <div class="interface-member-description">
- <p class="para _1">
- Constructs a <code class="fsharp"><span class="ci">ParserError</span></code> from an <code class="fsharp"><a
- href="#members.ErrorMessageList"><span class="ci">ErrorMessageList</span></a></code> and its associated position.
- </p>
- </div>
- </div>
- <div class="interface-member _2" id="members.Position">
- <div class="interface-member-code">
- <a class="interface-member-backlink" href="#interface.Position:B:">⇧</a>
- <pre class="code fsharp"><span class="ck">member</span> <span class="interface-member-marker"><span class="ci">Position</span></span><span class="cp">:</span> <a href="position.html"><span class="ci">Position</span></a>
- </pre>
- </div>
- <div class="interface-member-description">
- <p class="para _1">The input stream position of the parser error.</p>
- </div>
- </div>
- <div class="interface-member _3" id="members.member-ErrorMessageList">
- <div class="interface-member-code">
- <a class="interface-member-backlink" href="#interface.member-ErrorMessageList:B:">⇧</a>
- <pre class="code fsharp"><span class="ck">member</span> <span class="interface-member-marker"><span class="ci">ErrorMessageList</span></span><span class="cp">:</span> <a href="#members.ErrorMessageList"><span class="ci">ErrorMessageList</span></a>
- </pre>
- </div>
- <div class="interface-member-description">
- <p class="para _1">The error messages of the parser error.</p>
- </div>
- </div>
- <div class="interface-member _4" id="members.ToString">
- <div class="interface-member-code">
- <a class="interface-member-backlink" href="#interface.ToString:B:">⇧</a>
- <pre class="code fsharp"><span class="ck">override</span> <span class="interface-member-marker"><span class="ci">ToString</span></span><span class="cp">:</span> <span class="ci">unit</span> <span class="cr">-></span> <span class="ci">string</span>
- </pre>
- </div>
- <div class="interface-member-description">
- <div class="para _1">
- <p>Is equivalent to</p>
- <pre class="code fsharp"><span class="ck">use</span> <span class="ci">sw</span> <span class="cp">=</span> <span class="ck">new</span> <a href="http://msdn.microsoft.com/en-us/library/system.io.stringwriter.aspx"><span class="ci">System</span><span class="cm">.</span><span class="ci">IO</span><span class="cm">.</span><span class="ci">StringWriter</span></a><span class="cp">()</span>
- <a href="#members.WriteTo"><span class="ci">WriteTo</span></a><span class="cp">(</span><span class="ci">sw</span><span class="cp">)</span>
- <span class="ci">sw</span><span class="cm">.</span><span class="ci">ToString</span><span class="cp">()</span>
- </pre>
- </div>
- </div>
- </div>
- <div class="interface-member _5" id="members.ToString_CharStream">
- <div class="interface-member-code">
- <a class="interface-member-backlink" href="#interface.ToString_CharStream:B:">⇧</a>
- <pre class="code fsharp"><span class="ck">member</span> <span class="interface-member-marker"><span class="ci">ToString</span></span><span class="cp">:</span> <span class="ci">streamWhereErrorOccurred</span><span class="cp">:</span> <a href="charstream.html"><span class="ci">CharStream</span></a> <span class="cr">-></span> <span class="ci">string</span>
- </pre>
- </div>
- <div class="interface-member-description">
- <div class="para _1">
- <p>Is equivalent to</p>
- <pre class="code fsharp"><span class="ck">use</span> <span class="ci">sw</span> <span class="cp">=</span> <span class="ck">new</span> <a href="http://msdn.microsoft.com/en-us/library/system.io.stringwriter.aspx"><span class="ci">System</span><span class="cm">.</span><span class="ci">IO</span><span class="cm">.</span><span class="ci">StringWriter</span></a><span class="cp">()</span>
- <a href="#members.WriteTo_stream"><span class="ci">WriteTo</span></a><span class="cp">(</span><span class="ci">sw</span><span class="cp">,</span> <span class="ci">streamWhereErrorOccurred</span><span class="cp">)</span>
- <span class="ci">sw</span><span class="cm">.</span><span class="ci">ToString</span><span class="cp">()</span>
- </pre>
- </div>
- </div>
- </div>
- <div class="interface-member _6" id="members.WriteTo_stream">
- <div class="interface-member-code">
- <a class="interface-member-backlink" href="#interface.WriteTo_stream:B:">⇧</a>
- <pre class="code fsharp"><span class="ck">member</span> <span class="interface-member-marker"><span class="ci">WriteTo</span></span><span class="cp">:</span>
- <span class="ci">textWriter</span><span class="cp">:</span> <a href="http://msdn.microsoft.com/en-us/library/system.io.textwriter.aspx"><span class="ci">System</span><span class="cm">.</span><span class="ci">IO</span><span class="cm">.</span><span class="ci">TextWriter</span></a>
- <span class="cp">*</span> <span class="ci">streamWhereErrorOccurred</span><span class="cp">:</span> <a href="charstream.html"><span class="ci">CharStream</span></a>
- <span class="cp">*</span> <span class="cp">?</span><span class="ci">columnWidth</span><span class="cp">:</span> <span class="ci">int</span>
- <span class="cp">*</span> <span class="cp">?</span><span class="ci">initialIndentation</span><span class="cp">:</span> <span class="ci">string</span> <span class="cp">*</span> <span class="cp">?</span><span class="ci">indentationIncrement</span><span class="cp">:</span> <span class="ci">string</span>
- <span class="cr">-></span> <span class="ci">unit</span>
- </pre>
- </div>
- <div class="interface-member-description">
- <div class="para _1">
- <p>Is equivalent to</p>
- <pre class="code fsharp"><span class="ck">let</span> <span class="ci">getStreamByName</span> <span class="ci">streamName</span> <span class="cp">=</span>
- <span class="ck">if</span> <span class="ci">streamName</span> <span class="co">=</span> <a href="#members.Position"><span class="ci">Position</span></a><span class="cm">.</span><span class="ci">StreamName</span> <span class="ck">then</span> <span class="ci">streamWhereErrorOccurred</span> <span class="ck">else</span> <span class="cnu">null</span>
- <a href="#members.WriteTo_getStreamByName"><span class="ci">WriteTo</span></a><span class="cp">(</span><span class="ci">textWriter</span><span class="cp">,</span> <span class="ci">getStreamByName</span><span class="cp">,</span>
- <span class="cp">?</span><span class="ci">columWidth</span> <span class="co">=</span> <span class="ci">columnWidth</span><span class="cp">,</span>
- <span class="cp">?</span><span class="ci">initialIndentation</span> <span class="co">=</span> <span class="ci">initialIndentation</span><span class="cp">,</span>
- <span class="cp">?</span><span class="ci">indentationIncrement</span> <span class="co">=</span> <span class="ci">indentationIncrement</span><span class="cp">)</span>
- </pre>
- </div>
- </div>
- </div>
- <div class="interface-member _7" id="members.WriteTo_getStreamByName">
- <div class="interface-member-code">
- <a class="interface-member-backlink" href="#interface.WriteTo_getStreamByName:B:">⇧</a>
- <pre class="code fsharp"><span class="ck">member</span> <span class="interface-member-marker"><span class="ci">WriteTo</span></span><span class="cp">:</span>
- <span class="ci">textWriter</span><span class="cp">:</span> <a href="http://msdn.microsoft.com/en-us/library/system.io.textwriter.aspx"><span class="ci">System</span><span class="cm">.</span><span class="ci">IO</span><span class="cm">.</span><span class="ci">TextWriter</span></a>
- <span class="cp">*</span> <span class="ci">getStreamByName</span><span class="cp">:</span> <span class="cp">(</span><span class="ci">string</span> <span class="cr">-></span> <a href="charstream.html"><span class="ci">CharStream</span></a><span class="cp">)</span>
- <span class="cp">*</span> <span class="cp">?</span><span class="ci">columnWidth</span><span class="cp">:</span> <span class="ci">int</span>
- <span class="cp">*</span> <span class="cp">?</span><span class="ci">initialIndentation</span><span class="cp">:</span> <span class="ci">string</span> <span class="cp">*</span> <span class="cp">?</span><span class="ci">indentationIncrement</span><span class="cp">:</span> <span class="ci">string</span>
- <span class="cr">-></span> <span class="ci">unit</span>
- </pre>
- </div>
- <div class="interface-member-description">
- <p class="para _1">
- Writes a string representation of the <code class="fsharp"><span class="ci">ParserError</span></code> to the given <code
- class="fsharp"><a href="http://msdn.microsoft.com/en-us/library/system.io.textwriter.aspx"><span class="ci">TextWriter</span></a></code>
- value.
- </p>
- <p class="para _2">
- For each error position <code class="fsharp"><span class="ci">getStreamByName</span></code> is called with the <code class="fsharp"><span
- class="ci">StreamName</span></code> of the <code class="fsharp"><a href="position.html"><span class="ci">Position</span></a></code>. The
- returned <code class="fsharp"><a href="charstream.html"><span class="ci">CharStream</span></a></code> must be <code class="fsharp"><span
- class="cnu">null</span></code> or contain the content of the <code class="fsharp"><a href="charstream.html"><span
- class="ci">CharStream</span></a></code> for which the error was generated (at the original indices).
- </p>
- <p class="para _3">
- If <code class="fsharp"><span class="ci">getStreamByName</span></code> returns a non‐null <code class="fsharp"><a
- href="charstream.html"><span class="ci">CharStream</span></a></code>, the printed error position information is augmented with the line
- of text surrounding the error position, together with a ‘^’‐marker pointing to the exact location of the error in the input
- stream.
- </p>
- </div>
- </div>
- <div class="interface-member _8" id="members.WriteTo">
- <div class="interface-member-code">
- <a class="interface-member-backlink" href="#interface.WriteTo:B:">⇧</a>
- <pre class="code fsharp"><span class="ck">member</span> <span class="interface-member-marker"><span class="ci">WriteTo</span></span><span class="cp">:</span>
- <span class="ci">textWriter</span><span class="cp">:</span> <a href="http://msdn.microsoft.com/en-us/library/system.io.textwriter.aspx"><span class="ci">System</span><span class="cm">.</span><span class="ci">IO</span><span class="cm">.</span><span class="ci">TextWriter</span></a>
- <span class="cp">*</span> <span class="cp">?</span><span class="ci">positionPrinter</span><span class="cp">:</span>
- <span class="cp">(</span><a href="http://msdn.microsoft.com/en-us/library/system.io.textwriter.aspx"><span class="ci">System</span><span class="cm">.</span><span class="ci">IO</span><span class="cm">.</span><span class="ci">TextWriter</span></a> <span class="cr">-></span> <a href="position.html"><span class="ci">Position</span></a> <span class="cr">-></span> <span class="ci">string</span> <span class="cr">-></span> <span class="ci">int</span> <span class="cr">-></span> <span class="ci">unit</span><span class="cp">)</span>
- <span class="cp">*</span> <span class="cp">?</span><span class="ci">columnWidth</span><span class="cp">:</span> <span class="ci">int</span>
- <span class="cp">*</span> <span class="cp">?</span><span class="ci">initialIndentation</span><span class="cp">:</span> <span class="ci">string</span> <span class="cp">*</span> <span class="cp">?</span><span class="ci">indentationIncrement</span><span class="cp">:</span> <span class="ci">string</span>
- <span class="cr">-></span> <span class="ci">unit</span>
- </pre>
- </div>
- <div class="interface-member-description">
- <p class="para _1">
- Writes a string representation of the <code class="fsharp"><span class="ci">ParserError</span></code> to the given <code
- class="fsharp"><a href="http://msdn.microsoft.com/en-us/library/system.io.textwriter.aspx"><span class="ci">TextWriter</span></a></code>
- value.
- </p>
- <p class="para _2">
- The format of the position information can be customized by specifying the <code class="fsharp"><span
- class="ci">positionPrinter</span></code> argument. The given function is expected to print a representation of the passed <code
- class="fsharp"><a href="position.html"><span class="ci">Position</span></a></code> value to the passed <code class="fsharp"><a
- href="http://msdn.microsoft.com/en-us/library/system.io.textwriter.aspx"><span class="ci">TextWriter</span></a></code> value. If
- possible, it should indent text lines with the passed string and take into account the maximum column count (including indentation)
- passed as the last argument.
- </p>
- </div>
- </div>
- </div>
- </div>
- </div>
- </div>
- </div>
- </div>
- </div>
- </div>
- </div>
- </div>
- </div>
- </div>
- </body>
- </html>