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

382 lines
12 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>
Module: Rex::Parser::GraphML
&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 = "Rex::Parser::GraphML";
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 (G)</a> &raquo;
<span class='title'><span class='object_link'><a href="../../Rex.html" title="Rex (module)">Rex</a></span></span> &raquo; <span class='title'><span class='object_link'><a href="../Parser.html" title="Rex::Parser (module)">Parser</a></span></span>
&raquo;
<span class="title">GraphML</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>Module: Rex::Parser::GraphML
</h1>
<div class="box_info">
<dl>
<dt>Defined in:</dt>
<dd>lib/rex/parser/graphml.rb</dd>
</dl>
</div>
<h2>Overview</h2><div class="docstring">
<div class="discussion">
<p>A partial implementation of the GraphML specification for loading structured data from an XML file. Notable missing components include GraphML parse meta-data (XML attributes with the “parse” prefix), hyperedges and ports. See: <a href="http://graphml.graphdrawing.org">graphml.graphdrawing.org</a>/</p>
</div>
</div>
<div class="tags">
</div><h2>Defined Under Namespace</h2>
<p class="children">
<strong class="modules">Modules:</strong> <span class='object_link'><a href="GraphML/Element.html" title="Rex::Parser::GraphML::Element (module)">Element</a></span>, <span class='object_link'><a href="GraphML/Error.html" title="Rex::Parser::GraphML::Error (module)">Error</a></span>
<strong class="classes">Classes:</strong> <span class='object_link'><a href="GraphML/AttributeContainer.html" title="Rex::Parser::GraphML::AttributeContainer (class)">AttributeContainer</a></span>, <span class='object_link'><a href="GraphML/Document.html" title="Rex::Parser::GraphML::Document (class)">Document</a></span>, <span class='object_link'><a href="GraphML/MetaAttribute.html" title="Rex::Parser::GraphML::MetaAttribute (class)">MetaAttribute</a></span>
</p>
<h2>
Class Method Summary
<small><a href="#" class="summary_toggle">collapse</a></small>
</h2>
<ul class="summary">
<li class="public ">
<span class="summary_signature">
<a href="#convert_attribute-class_method" title="convert_attribute (class method)">.<strong>convert_attribute</strong>(attr_type, value) &#x21d2; Object </a>
</span>
<span class="summary_desc"><div class='inline'>
<p>Convert a GraphML value string into a Ruby value depending on the specified type.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#from_file-class_method" title="from_file (class method)">.<strong>from_file</strong>(file_path) &#x21d2; Rex::Parser::GraphML::Element::GraphML </a>
</span>
<span class="summary_desc"><div class='inline'>
<p>Load the contents of a GraphML file by parsing it with Nokogiri and returning the top level GraphML structure.</p>
</div></span>
</li>
</ul>
<div id="class_method_details" class="method_details_list">
<h2>Class Method Details</h2>
<div class="method_details first">
<h3 class="signature first" id="convert_attribute-class_method">
.<strong>convert_attribute</strong>(attr_type, value) &#x21d2; <tt>Object</tt>
</h3><div class="docstring">
<div class="discussion">
<p>Convert a GraphML value string into a Ruby value depending on the specified type. Values of int and long will be converted to Ruby integer, while float and double values will be converted to floats. For booleans, values that are either blank or “false” (case-insensitive) will evaluate to Ruby’s false, while everything else will be true.</p>
</div>
</div>
<div class="tags">
<p class="tag_title">Parameters:</p>
<ul class="param">
<li>
<span class='name'>attr_type</span>
<span class='type'>(<tt>Symbol</tt>)</span>
&mdash;
<div class='inline'>
<p>The type of the attribute, one of either boolean, int, long, float, double or string.</p>
</div>
</li>
<li>
<span class='name'>value</span>
<span class='type'>(<tt>String</tt>)</span>
&mdash;
<div class='inline'>
<p>The value to convert into a native Ruby data type.</p>
</div>
</li>
</ul>
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/rex/parser/graphml.rb', line 30</span>
<span class='kw'>def</span> <span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_convert_attribute'>convert_attribute</span><span class='lparen'>(</span><span class='id identifier rubyid_attr_type'>attr_type</span><span class='comma'>,</span> <span class='id identifier rubyid_value'>value</span><span class='rparen'>)</span>
<span class='kw'>case</span> <span class='id identifier rubyid_attr_type'>attr_type</span>
<span class='kw'>when</span> <span class='symbol'>:boolean</span>
<span class='id identifier rubyid_value'>value</span><span class='period'>.</span><span class='id identifier rubyid_strip!'>strip!</span>
<span class='kw'>if</span> <span class='id identifier rubyid_value'>value</span><span class='period'>.</span><span class='id identifier rubyid_blank?'>blank?</span>
<span class='id identifier rubyid_value'>value</span> <span class='op'>=</span> <span class='kw'>false</span>
<span class='kw'>else</span>
<span class='id identifier rubyid_value'>value</span> <span class='op'>=</span> <span class='id identifier rubyid_value'>value</span><span class='period'>.</span><span class='id identifier rubyid_downcase'>downcase</span> <span class='op'>!=</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>false</span><span class='tstring_end'>&#39;</span></span>
<span class='kw'>end</span>
<span class='kw'>when</span> <span class='symbol'>:int</span><span class='comma'>,</span> <span class='symbol'>:long</span>
<span class='id identifier rubyid_value'>value</span> <span class='op'>=</span> <span class='const'>Integer</span><span class='lparen'>(</span><span class='id identifier rubyid_value'>value</span><span class='rparen'>)</span>
<span class='kw'>when</span> <span class='symbol'>:float</span><span class='comma'>,</span> <span class='symbol'>:double</span>
<span class='id identifier rubyid_value'>value</span> <span class='op'>=</span> <span class='const'>Float</span><span class='lparen'>(</span><span class='id identifier rubyid_value'>value</span><span class='rparen'>)</span>
<span class='kw'>when</span> <span class='symbol'>:string</span> <span class='comment'># rubocop:disable Lint/EmptyWhen
</span> <span class='kw'>else</span>
<span class='id identifier rubyid_raise'>raise</span> <span class='const'>ArgumentError</span><span class='comma'>,</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>Unsupported attribute type: </span><span class='tstring_end'>&#39;</span></span> <span class='op'>+</span> <span class='id identifier rubyid_attr_type'>attr_type</span><span class='period'>.</span><span class='id identifier rubyid_to_s'>to_s</span>
<span class='kw'>end</span>
<span class='id identifier rubyid_value'>value</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
<div class="method_details ">
<h3 class="signature " id="from_file-class_method">
.<strong>from_file</strong>(file_path) &#x21d2; <tt><span class='object_link'><a href="GraphML/Element/GraphML.html" title="Rex::Parser::GraphML::Element::GraphML (class)">Rex::Parser::GraphML::Element::GraphML</a></span></tt>
</h3><div class="docstring">
<div class="discussion">
<p>Load the contents of a GraphML file by parsing it with Nokogiri and returning the top level GraphML structure.</p>
</div>
</div>
<div class="tags">
<p class="tag_title">Parameters:</p>
<ul class="param">
<li>
<span class='name'>file_path</span>
<span class='type'>(<tt>String</tt>)</span>
&mdash;
<div class='inline'>
<p>The file path to load the data from.</p>
</div>
</li>
</ul>
<p class="tag_title">Returns:</p>
<ul class="return">
<li>
<span class='type'>(<tt><span class='object_link'><a href="GraphML/Element/GraphML.html" title="Rex::Parser::GraphML::Element::GraphML (class)">Rex::Parser::GraphML::Element::GraphML</a></span></tt>)</span>
</li>
</ul>
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
17
18
19
20
21</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/rex/parser/graphml.rb', line 17</span>
<span class='kw'>def</span> <span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_from_file'>from_file</span><span class='lparen'>(</span><span class='id identifier rubyid_file_path'>file_path</span><span class='rparen'>)</span>
<span class='id identifier rubyid_parser'>parser</span> <span class='op'>=</span> <span class='const'>Nokogiri</span><span class='op'>::</span><span class='const'>XML</span><span class='op'>::</span><span class='const'>SAX</span><span class='op'>::</span><span class='const'>Parser</span><span class='period'>.</span><span class='id identifier rubyid_new'>new</span><span class='lparen'>(</span><span class='const'><span class='object_link'><a href="GraphML/Document.html" title="Rex::Parser::GraphML::Document (class)">Document</a></span></span><span class='period'>.</span><span class='id identifier rubyid_new'><span class='object_link'><a href="GraphML/Document.html#initialize-instance_method" title="Rex::Parser::GraphML::Document#initialize (method)">new</a></span></span><span class='rparen'>)</span>
<span class='id identifier rubyid_parser'>parser</span><span class='period'>.</span><span class='id identifier rubyid_parse'>parse</span><span class='lparen'>(</span><span class='const'>File</span><span class='period'>.</span><span class='id identifier rubyid_read'>read</span><span class='lparen'>(</span><span class='id identifier rubyid_file_path'>file_path</span><span class='comma'>,</span> <span class='label'>mode:</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>rb</span><span class='tstring_end'>&#39;</span></span><span class='rparen'>)</span><span class='rparen'>)</span>
<span class='id identifier rubyid_parser'>parser</span><span class='period'>.</span><span class='id identifier rubyid_document'>document</span><span class='period'>.</span><span class='id identifier rubyid_graphml'>graphml</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
</div>
</div>
<div id="footer">
Generated on Fri May 8 17:03:09 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