mirror of
https://github.com/mistergibson/gxg-framework.git
synced 2026-08-15 03:46:00 -07:00
221 lines
11 KiB
HTML
221 lines
11 KiB
HTML
<!DOCTYPE html>
|
|
|
|
<html>
|
|
<head>
|
|
<meta charset="UTF-8">
|
|
|
|
<title>module GxG::Units::Bytes - RDoc Documentation</title>
|
|
|
|
<script type="text/javascript">
|
|
var rdoc_rel_prefix = "../../";
|
|
var index_rel_prefix = "../../";
|
|
</script>
|
|
|
|
<script src="../../js/navigation.js" defer></script>
|
|
<script src="../../js/search.js" defer></script>
|
|
<script src="../../js/search_index.js" defer></script>
|
|
<script src="../../js/searcher.js" defer></script>
|
|
<script src="../../js/darkfish.js" defer></script>
|
|
|
|
<link href="../../css/fonts.css" rel="stylesheet">
|
|
<link href="../../css/rdoc.css" rel="stylesheet">
|
|
|
|
|
|
|
|
<body id="top" role="document" class="module">
|
|
<nav role="navigation">
|
|
<div id="project-navigation">
|
|
<div id="home-section" role="region" title="Quick navigation" class="nav-section">
|
|
<h2>
|
|
<a href="../../index.html" rel="home">Home</a>
|
|
</h2>
|
|
|
|
<div id="table-of-contents-navigation">
|
|
<a href="../../table_of_contents.html#pages">Pages</a>
|
|
<a href="../../table_of_contents.html#classes">Classes</a>
|
|
<a href="../../table_of_contents.html#methods">Methods</a>
|
|
</div>
|
|
</div>
|
|
|
|
<div id="search-section" role="search" class="project-section initially-hidden">
|
|
<form action="#" method="get" accept-charset="utf-8">
|
|
<div id="search-field-wrapper">
|
|
<input id="search-field" role="combobox" aria-label="Search"
|
|
aria-autocomplete="list" aria-controls="search-results"
|
|
type="text" name="search" placeholder="Search" spellcheck="false"
|
|
title="Type to search, Up and Down to navigate, Enter to load">
|
|
</div>
|
|
|
|
<ul id="search-results" aria-label="Search Results"
|
|
aria-busy="false" aria-expanded="false"
|
|
aria-atomic="false" class="initially-hidden"></ul>
|
|
</form>
|
|
</div>
|
|
|
|
</div>
|
|
|
|
|
|
|
|
<div id="class-metadata">
|
|
|
|
|
|
|
|
|
|
<!-- Method Quickref -->
|
|
<div id="method-list-section" class="nav-section">
|
|
<h3>Methods</h3>
|
|
|
|
<ul class="link-list" role="directory">
|
|
|
|
<li ><a href="#method-c-categories">::categories</a>
|
|
|
|
<li ><a href="#method-c-interpret">::interpret</a>
|
|
|
|
</ul>
|
|
</div>
|
|
|
|
</div>
|
|
</nav>
|
|
|
|
<main role="main" aria-labelledby="module-GxG::Units::Bytes">
|
|
<h1 id="module-GxG::Units::Bytes" class="module">
|
|
module GxG::Units::Bytes
|
|
</h1>
|
|
|
|
<section class="description">
|
|
|
|
</section>
|
|
|
|
|
|
<section id="5Buntitled-5D" class="documentation-section">
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<section id="public-class-5Buntitled-5D-method-details" class="method-section">
|
|
<header>
|
|
<h3>Public Class Methods</h3>
|
|
</header>
|
|
|
|
|
|
<div id="method-c-categories" class="method-detail ">
|
|
|
|
<div class="method-heading">
|
|
<span class="method-name">categories</span><span
|
|
class="method-args">()</span>
|
|
|
|
<span class="method-click-advice">click to toggle source</span>
|
|
|
|
</div>
|
|
|
|
|
|
<div class="method-description">
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<div class="method-source-code" id="categories-source">
|
|
<pre><span class="ruby-comment"># File lib/gxg/gxg_units.rb, line 73</span>
|
|
<span class="ruby-keyword">def</span> <span class="ruby-keyword">self</span>.<span class="ruby-identifier ruby-title">categories</span>()
|
|
[<span class="ruby-value">:numeric</span>, <span class="ruby-value">:byte</span>, <span class="ruby-value">:memory</span>, <span class="ruby-value">:storage</span>, <span class="ruby-value">:computer</span>]
|
|
<span class="ruby-keyword">end</span></pre>
|
|
</div>
|
|
|
|
</div>
|
|
|
|
|
|
|
|
|
|
</div>
|
|
|
|
|
|
<div id="method-c-interpret" class="method-detail ">
|
|
|
|
<div class="method-heading">
|
|
<span class="method-name">interpret</span><span
|
|
class="method-args">(quanta_string="",interpret_for_locale=:en_US,interpret_for_numeric_base=10)</span>
|
|
|
|
<span class="method-click-advice">click to toggle source</span>
|
|
|
|
</div>
|
|
|
|
|
|
<div class="method-description">
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<div class="method-source-code" id="interpret-source">
|
|
<pre><span class="ruby-comment"># File lib/gxg/gxg_units.rb, line 76</span>
|
|
<span class="ruby-keyword">def</span> <span class="ruby-keyword">self</span>.<span class="ruby-identifier ruby-title">interpret</span>(<span class="ruby-identifier">quanta_string</span>=<span class="ruby-string">""</span>,<span class="ruby-identifier">interpret_for_locale</span>=<span class="ruby-value">:en_US</span>,<span class="ruby-identifier">interpret_for_numeric_base</span>=<span class="ruby-value">10</span>)
|
|
<span class="ruby-identifier">multiplier</span> = <span class="ruby-keyword">nil</span>
|
|
<span class="ruby-comment">#</span>
|
|
<span class="ruby-keyword">case</span> <span class="ruby-identifier">quanta_string</span>.<span class="ruby-identifier">to_s</span>.<span class="ruby-identifier">downcase</span>.<span class="ruby-identifier">to_sym</span>
|
|
<span class="ruby-comment"># Attribution: http://whatsabyte.com/</span>
|
|
<span class="ruby-comment"># Attribution: https://en.wikipedia.org/wiki/Exabyte</span>
|
|
<span class="ruby-comment"># Note: I am electing to count along the 1024 (to the power) rule. Hard drive manufacturers can kiss my rosey-red,</span>
|
|
<span class="ruby-comment"># I'll not bugger my enumeration standard for their bloody sales force. :P Thus:</span>
|
|
<span class="ruby-comment"># I've attempted to include the IS and IEC terms and abbreviations.</span>
|
|
<span class="ruby-comment"># LATER: add ability to distinguish case: Kb = kiloBIT, KB = KiloBYTE, etc</span>
|
|
<span class="ruby-keyword">when</span> <span class="ruby-value">:byte</span>, <span class="ruby-value">:bytes</span>
|
|
<span class="ruby-identifier">multiplier</span> = <span class="ruby-value">1</span>
|
|
<span class="ruby-keyword">when</span> <span class="ruby-value">:kb</span>, <span class="ruby-value">:kib</span>, <span class="ruby-value">:kilobyte</span>, <span class="ruby-value">:kilobytes</span>, <span class="ruby-value">:kibibyte</span>, <span class="ruby-value">:kibibytes</span>
|
|
<span class="ruby-identifier">multiplier</span> = <span class="ruby-value">1024</span> <span class="ruby-operator">**</span> <span class="ruby-value">1</span>
|
|
<span class="ruby-keyword">when</span> <span class="ruby-value">:mb</span>, <span class="ruby-value">:mib</span>, <span class="ruby-value">:megabyte</span>, <span class="ruby-value">:megabytes</span>, <span class="ruby-value">:mebibyte</span>, <span class="ruby-value">:mebibytes</span>
|
|
<span class="ruby-identifier">multiplier</span> = <span class="ruby-value">1024</span> <span class="ruby-operator">**</span> <span class="ruby-value">2</span>
|
|
<span class="ruby-keyword">when</span> <span class="ruby-value">:gb</span>, <span class="ruby-value">:gib</span>, <span class="ruby-value">:gigabyte</span>, <span class="ruby-value">:gigabytes</span>, <span class="ruby-value">:gibibyte</span>, <span class="ruby-value">:gibibytes</span>
|
|
<span class="ruby-identifier">multiplier</span> = <span class="ruby-value">1024</span> <span class="ruby-operator">**</span> <span class="ruby-value">3</span>
|
|
<span class="ruby-keyword">when</span> <span class="ruby-value">:tb</span>, <span class="ruby-value">:tib</span>, <span class="ruby-value">:terabyte</span>, <span class="ruby-value">:terabytes</span>, <span class="ruby-value">:tebibyte</span>, <span class="ruby-value">:tebibytes</span>
|
|
<span class="ruby-identifier">multiplier</span> = <span class="ruby-value">1024</span> <span class="ruby-operator">**</span> <span class="ruby-value">4</span>
|
|
<span class="ruby-keyword">when</span> <span class="ruby-value">:pb</span>, <span class="ruby-value">:pib</span>, <span class="ruby-value">:petabyte</span>, <span class="ruby-value">:petabytes</span>, <span class="ruby-value">:pebibyte</span>, <span class="ruby-value">:pebibytes</span>
|
|
<span class="ruby-identifier">multiplier</span> = <span class="ruby-value">1024</span> <span class="ruby-operator">**</span> <span class="ruby-value">5</span>
|
|
<span class="ruby-keyword">when</span> <span class="ruby-value">:eb</span>, <span class="ruby-value">:eib</span>, <span class="ruby-value">:exobyte</span>, <span class="ruby-value">:exobytes</span>, <span class="ruby-value">:exbibyte</span>, <span class="ruby-value">:exbibytes</span>
|
|
<span class="ruby-identifier">multiplier</span> = <span class="ruby-value">1024</span> <span class="ruby-operator">**</span> <span class="ruby-value">6</span>
|
|
<span class="ruby-keyword">when</span> <span class="ruby-value">:zb</span>, <span class="ruby-value">:zib</span>, <span class="ruby-value">:zettabyte</span>, <span class="ruby-value">:zettabytes</span>, <span class="ruby-value">:zebibyte</span>, <span class="ruby-value">:zebibytes</span>
|
|
<span class="ruby-identifier">multiplier</span> = <span class="ruby-value">1024</span> <span class="ruby-operator">**</span> <span class="ruby-value">7</span>
|
|
<span class="ruby-keyword">when</span> <span class="ruby-value">:yb</span>, <span class="ruby-value">:yib</span>, <span class="ruby-value">:yottabyte</span>, <span class="ruby-value">:yottabytes</span>, <span class="ruby-value">:yobibyte</span>, <span class="ruby-value">:yobibytes</span>
|
|
<span class="ruby-identifier">multiplier</span> = <span class="ruby-value">1024</span> <span class="ruby-operator">**</span> <span class="ruby-value">8</span>
|
|
<span class="ruby-keyword">when</span> <span class="ruby-value">:bb</span>, <span class="ruby-value">:bib</span>, <span class="ruby-value">:brontobyte</span>, <span class="ruby-value">:brontobytes</span>
|
|
<span class="ruby-identifier">multiplier</span> = <span class="ruby-value">1024</span> <span class="ruby-operator">**</span> <span class="ruby-value">9</span>
|
|
<span class="ruby-keyword">when</span> <span class="ruby-value">:geopbyte</span>, <span class="ruby-value">:geopbytes</span>
|
|
<span class="ruby-comment"># TODO: GeopByte: need to find missing SI and IEC abbreviations</span>
|
|
<span class="ruby-identifier">multiplier</span> = <span class="ruby-value">1024</span> <span class="ruby-operator">**</span> <span class="ruby-value">10</span>
|
|
<span class="ruby-keyword">end</span>
|
|
<span class="ruby-comment">#</span>
|
|
<span class="ruby-keyword">if</span> <span class="ruby-identifier">multiplier</span>
|
|
{<span class="ruby-value">:quantum</span> <span class="ruby-operator">=></span> {<span class="ruby-value">:byte</span> <span class="ruby-operator">=></span> <span class="ruby-identifier">multiplier</span>}, <span class="ruby-value">:attributes</span> <span class="ruby-operator">=></span> <span class="ruby-keyword">nil</span>}
|
|
<span class="ruby-keyword">else</span>
|
|
<span class="ruby-keyword">nil</span>
|
|
<span class="ruby-keyword">end</span>
|
|
<span class="ruby-keyword">end</span></pre>
|
|
</div>
|
|
|
|
</div>
|
|
|
|
|
|
|
|
|
|
</div>
|
|
|
|
|
|
</section>
|
|
|
|
</section>
|
|
</main>
|
|
|
|
|
|
<footer id="validator-badges" role="contentinfo">
|
|
<p><a href="https://validator.w3.org/check/referer">Validate</a>
|
|
<p>Generated by <a href="https://ruby.github.io/rdoc/">RDoc</a> 6.1.2.
|
|
<p>Based on <a href="http://deveiate.org/projects/Darkfish-RDoc/">Darkfish</a> by <a href="http://deveiate.org">Michael Granger</a>.
|
|
</footer>
|
|
|