cyberpresidentvanellope/tgstation-server
1
0
Fork 0
mirror of https://github.com/tgstation/tgstation-server.git synced 2026-08-29 08:00:19 +01:00
Code Issues Packages Projects Releases Wiki Activity
Files
gh-pages
tgstation-server/_paginatable_result_8cs_source.html
T

134 lines
15 KiB
HTML
Raw Permalink Blame History

<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" lang="en-US">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=11"/>
<meta name="generator" content="Doxygen 1.9.8"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>tgstation-server: src/Tgstation.Server.Host/Controllers/Results/PaginatableResult.cs Source File</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/searchdata.js"></script>
<script type="text/javascript" src="search/search.js"></script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
<tbody>
<tr id="projectrow">
<td id="projectalign">
<div id="projectname">tgstation-server<span id="projectnumber">&#160;6.19.3</span>
</div>
<div id="projectbrief">The /tg/station 13 server suite</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.9.8 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
var searchBox = new SearchBox("searchBox", "search/",'.html');
/* @license-end */
</script>
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
$(function() {
initMenu('',true,false,'search.php','Search');
$(document).ready(function() { init_search(); });
});
/* @license-end */
</script>
<div id="main-nav"></div>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
$(document).ready(function() { init_codefold(0); });
/* @license-end */
</script>
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
onkeydown="return searchBox.OnSearchSelectKey(event)">
</div>
<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<div id="MSearchResults">
<div class="SRPage">
<div id="SRIndex">
<div id="SRResults"></div>
<div class="SRStatus" id="Loading">Loading...</div>
<div class="SRStatus" id="Searching">Searching...</div>
<div class="SRStatus" id="NoMatches">No Matches</div>
</div>
</div>
</div>
</div>
<div id="nav-path" class="navpath">
<ul>
<li class="navelem"><a class="el" href="dir_68267d1309a1af8e8297ef4c3efbcdba.html">src</a></li><li class="navelem"><a class="el" href="dir_34761767c1c3cd212f9d2f80ea0828a8.html">Tgstation.Server.Host</a></li><li class="navelem"><a class="el" href="dir_38cec1532eaed7aa1de0b599a76e3e80.html">Controllers</a></li><li class="navelem"><a class="el" href="dir_a13f130ab75633c98a973b4116486bde.html">Results</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="headertitle"><div class="title">PaginatableResult.cs</div></div>
</div><!--header-->
<div class="contents">
<a href="_paginatable_result_8cs.html">Go to the documentation of this file.</a><div class="fragment"><div class="line"><a id="l00001" name="l00001"></a><span class="lineno"> 1</span><span class="keyword">using </span>System;</div>
<div class="line"><a id="l00002" name="l00002"></a><span class="lineno"> 2</span><span class="keyword">using </span>System.Diagnostics.CodeAnalysis;</div>
<div class="line"><a id="l00003" name="l00003"></a><span class="lineno"> 3</span><span class="keyword">using </span>System.Linq;</div>
<div class="line"><a id="l00004" name="l00004"></a><span class="lineno"> 4</span> </div>
<div class="line"><a id="l00005" name="l00005"></a><span class="lineno"> 5</span><span class="keyword">using </span>Microsoft.AspNetCore.Mvc;</div>
<div class="line"><a id="l00006" name="l00006"></a><span class="lineno"> 6</span> </div>
<div class="line"><a id="l00007" name="l00007"></a><span class="lineno"> 7</span><span class="keyword">namespace </span><a class="code hl_namespace" href="namespace_tgstation_1_1_server_1_1_host_1_1_controllers_1_1_results.html">Tgstation.Server.Host.Controllers.Results</a></div>
<div class="line"><a id="l00008" name="l00008"></a><span class="lineno"> 8</span>{</div>
<div class="foldopen" id="foldopen00013" data-start="{" data-end="};">
<div class="line"><a id="l00013" name="l00013"></a><span class="lineno"><a class="line" href="class_tgstation_1_1_server_1_1_host_1_1_controllers_1_1_results_1_1_paginatable_result.html"> 13</a></span> <span class="keyword">public</span> <span class="keyword">sealed</span> <span class="keyword">class </span><a class="code hl_class" href="class_tgstation_1_1_server_1_1_host_1_1_controllers_1_1_results_1_1_paginatable_result.html">PaginatableResult</a>&lt;TModel&gt;</div>
<div class="line"><a id="l00014" name="l00014"></a><span class="lineno"> 14</span> {</div>
<div class="line"><a id="l00018" name="l00018"></a><span class="lineno"> 18</span> [MemberNotNullWhen(<span class="keyword">true</span>, nameof(<a class="code hl_property" href="class_tgstation_1_1_server_1_1_host_1_1_controllers_1_1_results_1_1_paginatable_result.html#acbbda811ad042b69966872cb6dcfd53c">Results</a>))]</div>
<div class="line"><a id="l00019" name="l00019"></a><span class="lineno"> 19</span> [MemberNotNullWhen(<span class="keyword">false</span>, nameof(<a class="code hl_property" href="class_tgstation_1_1_server_1_1_host_1_1_controllers_1_1_results_1_1_paginatable_result.html#a7d8088f9889e3510a1c7dfe87e0d5976">EarlyOut</a>))]</div>
<div class="line"><a id="l00020" name="l00020"></a><span class="lineno"><a class="line" href="class_tgstation_1_1_server_1_1_host_1_1_controllers_1_1_results_1_1_paginatable_result.html#a695c0b31a6cd1965c8d4a58019bd2e6c"> 20</a></span> <span class="keyword">public</span> <span class="keywordtype">bool</span> <a class="code hl_property" href="class_tgstation_1_1_server_1_1_host_1_1_controllers_1_1_results_1_1_paginatable_result.html#a695c0b31a6cd1965c8d4a58019bd2e6c">Valid</a> =&gt; <a class="code hl_property" href="class_tgstation_1_1_server_1_1_host_1_1_controllers_1_1_results_1_1_paginatable_result.html#a7d8088f9889e3510a1c7dfe87e0d5976">EarlyOut</a> == <span class="keyword">null</span>;</div>
<div class="line"><a id="l00021" name="l00021"></a><span class="lineno"> 21</span> </div>
<div class="line"><a id="l00025" name="l00025"></a><span class="lineno"><a class="line" href="class_tgstation_1_1_server_1_1_host_1_1_controllers_1_1_results_1_1_paginatable_result.html#acbbda811ad042b69966872cb6dcfd53c"> 25</a></span> <span class="keyword">public</span> IOrderedQueryable&lt;TModel&gt;? <a class="code hl_property" href="class_tgstation_1_1_server_1_1_host_1_1_controllers_1_1_results_1_1_paginatable_result.html#acbbda811ad042b69966872cb6dcfd53c">Results</a> { <span class="keyword">get</span>; }</div>
<div class="line"><a id="l00026" name="l00026"></a><span class="lineno"> 26</span> </div>
<div class="line"><a id="l00030" name="l00030"></a><span class="lineno"><a class="line" href="class_tgstation_1_1_server_1_1_host_1_1_controllers_1_1_results_1_1_paginatable_result.html#a7d8088f9889e3510a1c7dfe87e0d5976"> 30</a></span> <span class="keyword">public</span> IActionResult? <a class="code hl_property" href="class_tgstation_1_1_server_1_1_host_1_1_controllers_1_1_results_1_1_paginatable_result.html#a7d8088f9889e3510a1c7dfe87e0d5976">EarlyOut</a> { <span class="keyword">get</span>; }</div>
<div class="line"><a id="l00031" name="l00031"></a><span class="lineno"> 31</span> </div>
<div class="foldopen" id="foldopen00036" data-start="{" data-end="}">
<div class="line"><a id="l00036" name="l00036"></a><span class="lineno"><a class="line" href="class_tgstation_1_1_server_1_1_host_1_1_controllers_1_1_results_1_1_paginatable_result.html#a83f5a2bbb73158146801ad7209fe90d1"> 36</a></span> <span class="keyword">public</span> <a class="code hl_function" href="class_tgstation_1_1_server_1_1_host_1_1_controllers_1_1_results_1_1_paginatable_result.html#a83f5a2bbb73158146801ad7209fe90d1">PaginatableResult</a>(IOrderedQueryable&lt;TModel&gt; results)</div>
<div class="line"><a id="l00037" name="l00037"></a><span class="lineno"> 37</span> {</div>
<div class="line"><a id="l00038" name="l00038"></a><span class="lineno"> 38</span> <a class="code hl_property" href="class_tgstation_1_1_server_1_1_host_1_1_controllers_1_1_results_1_1_paginatable_result.html#acbbda811ad042b69966872cb6dcfd53c">Results</a> = results ?? <span class="keywordflow">throw</span> <span class="keyword">new</span> ArgumentNullException(nameof(results));</div>
<div class="line"><a id="l00039" name="l00039"></a><span class="lineno"> 39</span> }</div>
</div>
<div class="line"><a id="l00040" name="l00040"></a><span class="lineno"> 40</span> </div>
<div class="foldopen" id="foldopen00045" data-start="{" data-end="}">
<div class="line"><a id="l00045" name="l00045"></a><span class="lineno"><a class="line" href="class_tgstation_1_1_server_1_1_host_1_1_controllers_1_1_results_1_1_paginatable_result.html#a2f44dbf156822edf038d5f41220b8927"> 45</a></span> <span class="keyword">public</span> <a class="code hl_function" href="class_tgstation_1_1_server_1_1_host_1_1_controllers_1_1_results_1_1_paginatable_result.html#a2f44dbf156822edf038d5f41220b8927">PaginatableResult</a>(IActionResult earlyOut)</div>
<div class="line"><a id="l00046" name="l00046"></a><span class="lineno"> 46</span> {</div>
<div class="line"><a id="l00047" name="l00047"></a><span class="lineno"> 47</span> <a class="code hl_property" href="class_tgstation_1_1_server_1_1_host_1_1_controllers_1_1_results_1_1_paginatable_result.html#a7d8088f9889e3510a1c7dfe87e0d5976">EarlyOut</a> = earlyOut ?? <span class="keywordflow">throw</span> <span class="keyword">new</span> ArgumentNullException(nameof(earlyOut));</div>
<div class="line"><a id="l00048" name="l00048"></a><span class="lineno"> 48</span> }</div>
</div>
<div class="line"><a id="l00049" name="l00049"></a><span class="lineno"> 49</span> }</div>
</div>
<div class="line"><a id="l00050" name="l00050"></a><span class="lineno"> 50</span>}</div>
<div class="ttc" id="aclass_tgstation_1_1_server_1_1_host_1_1_controllers_1_1_results_1_1_paginatable_result_html"><div class="ttname"><a href="class_tgstation_1_1_server_1_1_host_1_1_controllers_1_1_results_1_1_paginatable_result.html">Tgstation.Server.Host.Controllers.Results.PaginatableResult</a></div><div class="ttdoc">Helper for returning paginated models.</div><div class="ttdef"><b>Definition</b> <a href="_paginatable_result_8cs_source.html#l00013">PaginatableResult.cs:14</a></div></div>
<div class="ttc" id="aclass_tgstation_1_1_server_1_1_host_1_1_controllers_1_1_results_1_1_paginatable_result_html_a2f44dbf156822edf038d5f41220b8927"><div class="ttname"><a href="class_tgstation_1_1_server_1_1_host_1_1_controllers_1_1_results_1_1_paginatable_result.html#a2f44dbf156822edf038d5f41220b8927">Tgstation.Server.Host.Controllers.Results.PaginatableResult.PaginatableResult</a></div><div class="ttdeci">PaginatableResult(IActionResult earlyOut)</div><div class="ttdoc">Initializes a new instance of the PaginatableResult&lt;TModel&gt; class.</div><div class="ttdef"><b>Definition</b> <a href="_paginatable_result_8cs_source.html#l00045">PaginatableResult.cs:45</a></div></div>
<div class="ttc" id="aclass_tgstation_1_1_server_1_1_host_1_1_controllers_1_1_results_1_1_paginatable_result_html_a695c0b31a6cd1965c8d4a58019bd2e6c"><div class="ttname"><a href="class_tgstation_1_1_server_1_1_host_1_1_controllers_1_1_results_1_1_paginatable_result.html#a695c0b31a6cd1965c8d4a58019bd2e6c">Tgstation.Server.Host.Controllers.Results.PaginatableResult.Valid</a></div><div class="ttdeci">bool Valid</div><div class="ttdoc">Whether or not the PaginatableResult&lt;TModel&gt; is valid.</div><div class="ttdef"><b>Definition</b> <a href="_paginatable_result_8cs_source.html#l00020">PaginatableResult.cs:20</a></div></div>
<div class="ttc" id="aclass_tgstation_1_1_server_1_1_host_1_1_controllers_1_1_results_1_1_paginatable_result_html_a7d8088f9889e3510a1c7dfe87e0d5976"><div class="ttname"><a href="class_tgstation_1_1_server_1_1_host_1_1_controllers_1_1_results_1_1_paginatable_result.html#a7d8088f9889e3510a1c7dfe87e0d5976">Tgstation.Server.Host.Controllers.Results.PaginatableResult.EarlyOut</a></div><div class="ttdeci">IActionResult? EarlyOut</div><div class="ttdoc">An IActionResult to return immediately.</div><div class="ttdef"><b>Definition</b> <a href="_paginatable_result_8cs_source.html#l00030">PaginatableResult.cs:30</a></div></div>
<div class="ttc" id="aclass_tgstation_1_1_server_1_1_host_1_1_controllers_1_1_results_1_1_paginatable_result_html_a83f5a2bbb73158146801ad7209fe90d1"><div class="ttname"><a href="class_tgstation_1_1_server_1_1_host_1_1_controllers_1_1_results_1_1_paginatable_result.html#a83f5a2bbb73158146801ad7209fe90d1">Tgstation.Server.Host.Controllers.Results.PaginatableResult.PaginatableResult</a></div><div class="ttdeci">PaginatableResult(IOrderedQueryable&lt; TModel &gt; results)</div><div class="ttdoc">Initializes a new instance of the PaginatableResult&lt;TModel&gt; class.</div><div class="ttdef"><b>Definition</b> <a href="_paginatable_result_8cs_source.html#l00036">PaginatableResult.cs:36</a></div></div>
<div class="ttc" id="aclass_tgstation_1_1_server_1_1_host_1_1_controllers_1_1_results_1_1_paginatable_result_html_acbbda811ad042b69966872cb6dcfd53c"><div class="ttname"><a href="class_tgstation_1_1_server_1_1_host_1_1_controllers_1_1_results_1_1_paginatable_result.html#acbbda811ad042b69966872cb6dcfd53c">Tgstation.Server.Host.Controllers.Results.PaginatableResult.Results</a></div><div class="ttdeci">IOrderedQueryable&lt; TModel &gt;? Results</div><div class="ttdoc">The IOrderedQueryable&lt;T&gt; TModel results.</div><div class="ttdef"><b>Definition</b> <a href="_paginatable_result_8cs_source.html#l00025">PaginatableResult.cs:25</a></div></div>
<div class="ttc" id="anamespace_tgstation_1_1_server_1_1_host_1_1_controllers_1_1_results_html"><div class="ttname"><a href="namespace_tgstation_1_1_server_1_1_host_1_1_controllers_1_1_results.html">Tgstation.Server.Host.Controllers.Results</a></div><div class="ttdef"><b>Definition</b> <a href="_limited_stream_result_8cs_source.html#l00013">LimitedStreamResult.cs:14</a></div></div>
</div><!-- fragment --></div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated by&#160;<a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.9.8
</small></address>
</body>
</html>
Reference in New Issue View Git Blame Copy Permalink