adam/metasploit-gs
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity
Files
c3f5bd3de2d1affa01e2f6c2066c6bb0fc6413bc
metasploit-gs/api/Msf/DataStore/DataStoreSearchResult.html
T
jenkins-metasploit c3f5bd3de2 Reboot gh-pages
2026-05-08 17:08:43 +00:00

892 lines
17 KiB
HTML
Raw Blame History

This file contains ambiguous Unicode characters
This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.
<!DOCTYPE html>
<html>
<head>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>
Class: Msf::DataStore::DataStoreSearchResult
&mdash; Documentation by YARD 0.9.37
</title>
<link rel="stylesheet" href="../../css/style.css" type="text/css" />
<link rel="stylesheet" href="../../css/common.css" type="text/css" />
<script type="text/javascript">
pathId = "Msf::DataStore::DataStoreSearchResult";
relpath = '../../';
</script>
<script type="text/javascript" charset="utf-8" src="../../js/jquery.js"></script>
<script type="text/javascript" charset="utf-8" src="../../js/app.js"></script>
</head>
<body>
<div class="nav_wrap">
<iframe id="nav" src="../../class_list.html?1"></iframe>
<div id="resizer"></div>
</div>
<div id="main" tabindex="-1">
<div id="header">
<div id="menu">
<a href="../../_index.html">Index (D)</a> &raquo;
<span class='title'><span class='object_link'><a href="../../Msf.html" title="Msf (module)">Msf</a></span></span> &raquo; <span class='title'><span class='object_link'><a href="../DataStore.html" title="Msf::DataStore (class)">DataStore</a></span></span>
&raquo;
<span class="title">DataStoreSearchResult</span>
</div>
<div id="search">
<a class="full_list_link" id="class_list_link"
href="../../class_list.html">
<svg width="24" height="24">
<rect x="0" y="4" width="24" height="4" rx="1" ry="1"></rect>
<rect x="0" y="12" width="24" height="4" rx="1" ry="1"></rect>
<rect x="0" y="20" width="24" height="4" rx="1" ry="1"></rect>
</svg>
</a>
</div>
<div class="clear"></div>
</div>
<div id="content"><h1>Class: Msf::DataStore::DataStoreSearchResult
</h1>
<div class="box_info">
<dl>
<dt>Inherits:</dt>
<dd>
<span class="inheritName">Object</span>
<ul class="fullTree">
<li>Object</li>
<li class="next">Msf::DataStore::DataStoreSearchResult</li>
</ul>
<a href="#" class="inheritanceTree">show all</a>
</dd>
</dl>
<dl>
<dt>Defined in:</dt>
<dd>lib/msf/core/data_store.rb</dd>
</dl>
</div>
<h2>Overview</h2><div class="docstring">
<div class="discussion">
<p>Simple dataclass for storing the result of a datastore search</p>
</div>
</div>
<div class="tags">
</div>
<h2>Instance Attribute Summary <small><a href="#" class="summary_toggle">collapse</a></small></h2>
<ul class="summary">
<li class="public ">
<span class="summary_signature">
<a href="#fallback_key-instance_method" title="#fallback_key (instance method)">#<strong>fallback_key</strong> &#x21d2; String<sup>?</sup> </a>
</span>
<span class="note title readonly">readonly</span>
<span class="summary_desc"><div class='inline'>
<p>The key associated with the fallback value.</p>
</div></span>
</li>
<li class="protected ">
<span class="summary_signature">
<a href="#namespace-instance_method" title="#namespace (instance method)">#<strong>namespace</strong> &#x21d2; Symbol </a>
</span>
<span class="note title readonly">readonly</span>
<span class="note title protected">protected</span>
<span class="summary_desc"><div class='inline'>
<p>Namespace Where the search result was found, i.e.</p>
</div></span>
</li>
<li class="protected ">
<span class="summary_signature">
<a href="#result-instance_method" title="#result (instance method)">#<strong>result</strong> &#x21d2; Symbol </a>
</span>
<span class="note title readonly">readonly</span>
<span class="note title protected">protected</span>
<span class="summary_desc"><div class='inline'>
<p>Result is one of ‘user_defined`, `not_found`, `option_fallback`, `option_default`, `imported_default`.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#value-instance_method" title="#value (instance method)">#<strong>value</strong> &#x21d2; object<sup>?</sup> </a>
</span>
<span class="note title readonly">readonly</span>
<span class="summary_desc"><div class='inline'>
<p>The value if found.</p>
</div></span>
</li>
</ul>
<h2>
Instance Method Summary
<small><a href="#" class="summary_toggle">collapse</a></small>
</h2>
<ul class="summary">
<li class="public ">
<span class="summary_signature">
<a href="#default%3F-instance_method" title="#default? (instance method)">#<strong>default?</strong> &#x21d2; Boolean </a>
</span>
<span class="summary_desc"><div class='inline'></div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#fallback%3F-instance_method" title="#fallback? (instance method)">#<strong>fallback?</strong> &#x21d2; Boolean </a>
</span>
<span class="summary_desc"><div class='inline'></div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#found%3F-instance_method" title="#found? (instance method)">#<strong>found?</strong> &#x21d2; Boolean </a>
</span>
<span class="summary_desc"><div class='inline'></div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#global%3F-instance_method" title="#global? (instance method)">#<strong>global?</strong> &#x21d2; Boolean </a>
</span>
<span class="summary_desc"><div class='inline'></div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#initialize-instance_method" title="#initialize (instance method)">#<strong>initialize</strong>(result, value, namespace: nil, fallback_key: nil) &#x21d2; DataStoreSearchResult </a>
</span>
<span class="note title constructor">constructor</span>
<span class="summary_desc"><div class='inline'>
<p>A new instance of DataStoreSearchResult.</p>
</div></span>
</li>
</ul>
<div id="constructor_details" class="method_details_list">
<h2>Constructor Details</h2>
<div class="method_details first">
<h3 class="signature first" id="initialize-instance_method">
#<strong>initialize</strong>(result, value, namespace: nil, fallback_key: nil) &#x21d2; <tt><span class='object_link'><a href="" title="Msf::DataStore::DataStoreSearchResult (class)">DataStoreSearchResult</a></span></tt>
</h3><div class="docstring">
<div class="discussion">
<p>Returns a new instance of DataStoreSearchResult.</p>
</div>
</div>
<div class="tags">
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
514
515
516
517
518
519</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/msf/core/data_store.rb', line 514</span>
<span class='kw'>def</span> <span class='id identifier rubyid_initialize'>initialize</span><span class='lparen'>(</span><span class='id identifier rubyid_result'>result</span><span class='comma'>,</span> <span class='id identifier rubyid_value'>value</span><span class='comma'>,</span> <span class='label'>namespace:</span> <span class='kw'>nil</span><span class='comma'>,</span> <span class='label'>fallback_key:</span> <span class='kw'>nil</span><span class='rparen'>)</span>
<span class='ivar'>@namespace</span> <span class='op'>=</span> <span class='id identifier rubyid_namespace'>namespace</span>
<span class='ivar'>@result</span> <span class='op'>=</span> <span class='id identifier rubyid_result'>result</span>
<span class='ivar'>@value</span> <span class='op'>=</span> <span class='id identifier rubyid_value'>value</span>
<span class='ivar'>@fallback_key</span> <span class='op'>=</span> <span class='id identifier rubyid_fallback_key'>fallback_key</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
</div>
<div id="instance_attr_details" class="attr_details">
<h2>Instance Attribute Details</h2>
<span id=""></span>
<div class="method_details first">
<h3 class="signature first" id="fallback_key-instance_method">
#<strong>fallback_key</strong> &#x21d2; <tt>String</tt><sup>?</sup> <span class="extras">(readonly)</span>
</h3><div class="docstring">
<div class="discussion">
<p>Returns the key associated with the fallback value.</p>
</div>
</div>
<div class="tags">
<p class="tag_title">Returns:</p>
<ul class="return">
<li>
<span class='type'>(<tt>String</tt>, <tt>nil</tt>)</span>
&mdash;
<div class='inline'>
<p>the key associated with the fallback value</p>
</div>
</li>
</ul>
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
509
510
511</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/msf/core/data_store.rb', line 509</span>
<span class='kw'>def</span> <span class='id identifier rubyid_fallback_key'>fallback_key</span>
<span class='ivar'>@fallback_key</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
<span id=""></span>
<div class="method_details ">
<h3 class="signature " id="namespace-instance_method">
#<strong>namespace</strong> &#x21d2; <tt>Symbol</tt> <span class="extras">(readonly, protected)</span>
</h3><div class="docstring">
<div class="discussion">
<p>Returns namespace Where the search result was found, i.e. a module datastore or global datastore.</p>
</div>
</div>
<div class="tags">
<p class="tag_title">Returns:</p>
<ul class="return">
<li>
<span class='type'>(<tt>Symbol</tt>)</span>
&mdash;
<div class='inline'>
<p>namespace Where the search result was found, i.e. a module datastore or global datastore</p>
</div>
</li>
</ul>
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
540
541
542</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/msf/core/data_store.rb', line 540</span>
<span class='kw'>def</span> <span class='id identifier rubyid_namespace'>namespace</span>
<span class='ivar'>@namespace</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
<span id=""></span>
<div class="method_details ">
<h3 class="signature " id="result-instance_method">
#<strong>result</strong> &#x21d2; <tt>Symbol</tt> <span class="extras">(readonly, protected)</span>
</h3><div class="docstring">
<div class="discussion">
<p>Returns result is one of ‘user_defined`, `not_found`, `option_fallback`, `option_default`, `imported_default`.</p>
</div>
</div>
<div class="tags">
<p class="tag_title">Returns:</p>
<ul class="return">
<li>
<span class='type'>(<tt>Symbol</tt>)</span>
&mdash;
<div class='inline'>
<p>result is one of 'user_defined`, `not_found`, `option_fallback`, `option_default`, `imported_default`</p>
</div>
</li>
</ul>
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
543
544
545</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/msf/core/data_store.rb', line 543</span>
<span class='kw'>def</span> <span class='id identifier rubyid_result'>result</span>
<span class='ivar'>@result</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
<span id=""></span>
<div class="method_details ">
<h3 class="signature " id="value-instance_method">
#<strong>value</strong> &#x21d2; <tt>object</tt><sup>?</sup> <span class="extras">(readonly)</span>
</h3><div class="docstring">
<div class="discussion">
<p>Returns The value if found.</p>
</div>
</div>
<div class="tags">
<p class="tag_title">Returns:</p>
<ul class="return">
<li>
<span class='type'>(<tt>object</tt>, <tt>nil</tt>)</span>
&mdash;
<div class='inline'>
<p>The value if found</p>
</div>
</li>
</ul>
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
512
513
514</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/msf/core/data_store.rb', line 512</span>
<span class='kw'>def</span> <span class='id identifier rubyid_value'>value</span>
<span class='ivar'>@value</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
</div>
<div id="instance_method_details" class="method_details_list">
<h2>Instance Method Details</h2>
<div class="method_details first">
<h3 class="signature first" id="default?-instance_method">
#<strong>default?</strong> &#x21d2; <tt>Boolean</tt>
</h3><div class="docstring">
<div class="discussion">
</div>
</div>
<div class="tags">
<p class="tag_title">Returns:</p>
<ul class="return">
<li>
<span class='type'>(<tt>Boolean</tt>)</span>
</li>
</ul>
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
521
522
523</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/msf/core/data_store.rb', line 521</span>
<span class='kw'>def</span> <span class='id identifier rubyid_default?'>default?</span>
<span class='id identifier rubyid_result'>result</span> <span class='op'>==</span> <span class='symbol'>:imported_default</span> <span class='op'>||</span> <span class='id identifier rubyid_result'>result</span> <span class='op'>==</span> <span class='symbol'>:option_default</span> <span class='op'>||</span> <span class='op'>!</span><span class='id identifier rubyid_found?'>found?</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
<div class="method_details ">
<h3 class="signature " id="fallback?-instance_method">
#<strong>fallback?</strong> &#x21d2; <tt>Boolean</tt>
</h3><div class="docstring">
<div class="discussion">
</div>
</div>
<div class="tags">
<p class="tag_title">Returns:</p>
<ul class="return">
<li>
<span class='type'>(<tt>Boolean</tt>)</span>
</li>
</ul>
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
529
530
531</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/msf/core/data_store.rb', line 529</span>
<span class='kw'>def</span> <span class='id identifier rubyid_fallback?'>fallback?</span>
<span class='id identifier rubyid_result'>result</span> <span class='op'>==</span> <span class='symbol'>:option_fallback</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
<div class="method_details ">
<h3 class="signature " id="found?-instance_method">
#<strong>found?</strong> &#x21d2; <tt>Boolean</tt>
</h3><div class="docstring">
<div class="discussion">
</div>
</div>
<div class="tags">
<p class="tag_title">Returns:</p>
<ul class="return">
<li>
<span class='type'>(<tt>Boolean</tt>)</span>
</li>
</ul>
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
525
526
527</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/msf/core/data_store.rb', line 525</span>
<span class='kw'>def</span> <span class='id identifier rubyid_found?'>found?</span>
<span class='id identifier rubyid_result'>result</span> <span class='op'>!=</span> <span class='symbol'>:not_found</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
<div class="method_details ">
<h3 class="signature " id="global?-instance_method">
#<strong>global?</strong> &#x21d2; <tt>Boolean</tt>
</h3><div class="docstring">
<div class="discussion">
</div>
</div>
<div class="tags">
<p class="tag_title">Returns:</p>
<ul class="return">
<li>
<span class='type'>(<tt>Boolean</tt>)</span>
</li>
</ul>
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
533
534
535</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/msf/core/data_store.rb', line 533</span>
<span class='kw'>def</span> <span class='id identifier rubyid_global?'>global?</span>
<span class='id identifier rubyid_namespace'>namespace</span> <span class='op'>==</span> <span class='symbol'>:global_data_store</span> <span class='op'>&amp;&amp;</span> <span class='id identifier rubyid_found?'>found?</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
</div>
</div>
<div id="footer">
Generated on Fri May 8 17:03:19 2026 by
<a href="https://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
0.9.37 (ruby-3.1.5).
</div>
</div>
</body>
</html>
Reference in New Issue View Git Blame Copy Permalink