diff options
Diffstat (limited to 'doc/JSON/Pure/Generator/GeneratorMethods/String.html')
| -rw-r--r-- | doc/JSON/Pure/Generator/GeneratorMethods/String.html | 428 |
1 files changed, 428 insertions, 0 deletions
diff --git a/doc/JSON/Pure/Generator/GeneratorMethods/String.html b/doc/JSON/Pure/Generator/GeneratorMethods/String.html new file mode 100644 index 0000000..6c85e64 --- /dev/null +++ b/doc/JSON/Pure/Generator/GeneratorMethods/String.html @@ -0,0 +1,428 @@ +<?xml version="1.0" encoding="utf-8"?> +<!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" xml:lang="en" lang="en"> +<head> + <meta content="text/html; charset=utf-8" http-equiv="Content-Type" /> + + <title>Module: JSON::Pure::Generator::GeneratorMethods::String</title> + + <link rel="stylesheet" href="../../../../rdoc.css" type="text/css" media="screen" /> + + <script src="../../../../js/jquery.js" type="text/javascript" + charset="utf-8"></script> + <script src="../../../../js/thickbox-compressed.js" type="text/javascript" + charset="utf-8"></script> + <script src="../../../../js/quicksearch.js" type="text/javascript" + charset="utf-8"></script> + <script src="../../../../js/darkfish.js" type="text/javascript" + charset="utf-8"></script> + +</head> +<body class="module"> + + <div id="metadata"> + <div id="file-metadata"> + <div id="file-list-section" class="section"> + <h3 class="section-header">In Files</h3> + <div class="section-body"> + <ul> + + <li><a href="../../../../lib/json/pure/generator_rb.html?TB_iframe=true&height=550&width=785" + class="thickbox" title="lib/json/pure/generator.rb">lib/json/pure/generator.rb</a></li> + + </ul> + </div> + </div> + + + </div> + + <div id="class-metadata"> + + <!-- Parent Class --> + + + <!-- Namespace Contents --> + + <div id="namespace-list-section" class="section"> + <h3 class="section-header">Namespace</h3> + <ul class="link-list"> + + <li><span class="type">MODULE</span> <a href="String/Extend.html">JSON::Pure::Generator::GeneratorMethods::String::Extend</a></li> + + </ul> + </div> + + + <!-- Method Quickref --> + + <div id="method-list-section" class="section"> + <h3 class="section-header">Methods</h3> + <ul class="link-list"> + + <li><a href="#M000059">::included</a></li> + + <li><a href="#M000057">#to_json</a></li> + + <li><a href="#M000061">#to_json_raw</a></li> + + <li><a href="#M000060">#to_json_raw_object</a></li> + + </ul> + </div> + + + <!-- Included Modules --> + + </div> + + <div id="project-metadata"> + + + <div id="fileindex-section" class="section project-section"> + <h3 class="section-header">Files</h3> + <ul> + + <li class="file"><a href="../../../../doc-main_txt.html">doc-main.txt</a></li> + + </ul> + </div> + + + <div id="classindex-section" class="section project-section"> + <h3 class="section-header">Class Index + <span class="search-toggle"><img src="../../../../images/find.png" + height="16" width="16" alt="[+]" + title="show/hide quicksearch" /></span></h3> + <form action="#" method="get" accept-charset="utf-8" class="initially-hidden"> + <fieldset> + <legend>Quicksearch</legend> + <input type="text" name="quicksearch" value="" + class="quicksearch-field" /> + </fieldset> + </form> + + <ul class="link-list"> + + <li><a href="../../../../JSON.html">JSON</a></li> + + <li><a href="../../../../JSON/CircularDatastructure.html">JSON::CircularDatastructure</a></li> + + <li><a href="../../../../JSON/Editor.html">JSON::Editor</a></li> + + <li><a href="../../../../JSON/Editor/EditMenu.html">JSON::Editor::EditMenu</a></li> + + <li><a href="../../../../JSON/Editor/FileMenu.html">JSON::Editor::FileMenu</a></li> + + <li><a href="../../../../JSON/Editor/Gtk.html">JSON::Editor::Gtk</a></li> + + <li><a href="../../../../JSON/Editor/Gtk/TreeIter.html">JSON::Editor::Gtk::TreeIter</a></li> + + <li><a href="../../../../JSON/Editor/JSONTreeView.html">JSON::Editor::JSONTreeView</a></li> + + <li><a href="../../../../JSON/Editor/MainWindow.html">JSON::Editor::MainWindow</a></li> + + <li><a href="../../../../JSON/Editor/MenuExtension.html">JSON::Editor::MenuExtension</a></li> + + <li><a href="../../../../JSON/Editor/OptionsMenu.html">JSON::Editor::OptionsMenu</a></li> + + <li><a href="../../../../JSON/Editor/PopUpMenu.html">JSON::Editor::PopUpMenu</a></li> + + <li><a href="../../../../JSON/Ext.html">JSON::Ext</a></li> + + <li><a href="../../../../JSON/Ext/Generator.html">JSON::Ext::Generator</a></li> + + <li><a href="../../../../JSON/Ext/Generator/GeneratorMethods.html">JSON::Ext::Generator::GeneratorMethods</a></li> + + <li><a href="../../../../JSON/Ext/Generator/GeneratorMethods/Array.html">JSON::Ext::Generator::GeneratorMethods::Array</a></li> + + <li><a href="../../../../JSON/Ext/Generator/GeneratorMethods/FalseClass.html">JSON::Ext::Generator::GeneratorMethods::FalseClass</a></li> + + <li><a href="../../../../JSON/Ext/Generator/GeneratorMethods/Float.html">JSON::Ext::Generator::GeneratorMethods::Float</a></li> + + <li><a href="../../../../JSON/Ext/Generator/GeneratorMethods/Hash.html">JSON::Ext::Generator::GeneratorMethods::Hash</a></li> + + <li><a href="../../../../JSON/Ext/Generator/GeneratorMethods/Integer.html">JSON::Ext::Generator::GeneratorMethods::Integer</a></li> + + <li><a href="../../../../JSON/Ext/Generator/GeneratorMethods/NilClass.html">JSON::Ext::Generator::GeneratorMethods::NilClass</a></li> + + <li><a href="../../../../JSON/Ext/Generator/GeneratorMethods/Object.html">JSON::Ext::Generator::GeneratorMethods::Object</a></li> + + <li><a href="../../../../JSON/Ext/Generator/GeneratorMethods/String.html">JSON::Ext::Generator::GeneratorMethods::String</a></li> + + <li><a href="../../../../JSON/Ext/Generator/GeneratorMethods/String/Extend.html">JSON::Ext::Generator::GeneratorMethods::String::Extend</a></li> + + <li><a href="../../../../JSON/Ext/Generator/GeneratorMethods/TrueClass.html">JSON::Ext::Generator::GeneratorMethods::TrueClass</a></li> + + <li><a href="../../../../JSON/Ext/Generator/State.html">JSON::Ext::Generator::State</a></li> + + <li><a href="../../../../JSON/Ext/Parser.html">JSON::Ext::Parser</a></li> + + <li><a href="../../../../JSON/GeneratorError.html">JSON::GeneratorError</a></li> + + <li><a href="../../../../JSON/JSONError.html">JSON::JSONError</a></li> + + <li><a href="../../../../JSON/MissingUnicodeSupport.html">JSON::MissingUnicodeSupport</a></li> + + <li><a href="../../../../JSON/NestingError.html">JSON::NestingError</a></li> + + <li><a href="../../../../JSON/ParserError.html">JSON::ParserError</a></li> + + <li><a href="../../../../JSON/Pure.html">JSON::Pure</a></li> + + <li><a href="../../../../JSON/Pure/Generator.html">JSON::Pure::Generator</a></li> + + <li><a href="../../../../JSON/Pure/Generator/GeneratorMethods.html">JSON::Pure::Generator::GeneratorMethods</a></li> + + <li><a href="../../../../JSON/Pure/Generator/GeneratorMethods/Array.html">JSON::Pure::Generator::GeneratorMethods::Array</a></li> + + <li><a href="../../../../JSON/Pure/Generator/GeneratorMethods/FalseClass.html">JSON::Pure::Generator::GeneratorMethods::FalseClass</a></li> + + <li><a href="../../../../JSON/Pure/Generator/GeneratorMethods/Float.html">JSON::Pure::Generator::GeneratorMethods::Float</a></li> + + <li><a href="../../../../JSON/Pure/Generator/GeneratorMethods/Hash.html">JSON::Pure::Generator::GeneratorMethods::Hash</a></li> + + <li><a href="../../../../JSON/Pure/Generator/GeneratorMethods/Integer.html">JSON::Pure::Generator::GeneratorMethods::Integer</a></li> + + <li><a href="../../../../JSON/Pure/Generator/GeneratorMethods/NilClass.html">JSON::Pure::Generator::GeneratorMethods::NilClass</a></li> + + <li><a href="../../../../JSON/Pure/Generator/GeneratorMethods/Object.html">JSON::Pure::Generator::GeneratorMethods::Object</a></li> + + <li><a href="../../../../JSON/Pure/Generator/GeneratorMethods/String.html">JSON::Pure::Generator::GeneratorMethods::String</a></li> + + <li><a href="../../../../JSON/Pure/Generator/GeneratorMethods/String/Extend.html">JSON::Pure::Generator::GeneratorMethods::String::Extend</a></li> + + <li><a href="../../../../JSON/Pure/Generator/GeneratorMethods/TrueClass.html">JSON::Pure::Generator::GeneratorMethods::TrueClass</a></li> + + <li><a href="../../../../JSON/Pure/Generator/State.html">JSON::Pure::Generator::State</a></li> + + <li><a href="../../../../JSON/Pure/Parser.html">JSON::Pure::Parser</a></li> + + <li><a href="../../../../Class.html">Class</a></li> + + <li><a href="../../../../Date.html">Date</a></li> + + <li><a href="../../../../DateTime.html">DateTime</a></li> + + <li><a href="../../../../Enumerable.html">Enumerable</a></li> + + <li><a href="../../../../Exception.html">Exception</a></li> + + <li><a href="../../../../Kernel.html">Kernel</a></li> + + <li><a href="../../../../Object.html">Object</a></li> + + <li><a href="../../../../Range.html">Range</a></li> + + <li><a href="../../../../Regexp.html">Regexp</a></li> + + <li><a href="../../../../Struct.html">Struct</a></li> + + <li><a href="../../../../Symbol.html">Symbol</a></li> + + <li><a href="../../../../Time.html">Time</a></li> + + </ul> + <div id="no-class-search-results" style="display: none;">No matching classes.</div> + </div> + + + </div> + </div> + + <div id="documentation"> + <h1 class="module">JSON::Pure::Generator::GeneratorMethods::String</h1> + + <div id="description"> + + </div> + + <!-- Constants --> + + + <!-- Attributes --> + + + <!-- Methods --> + + <div id="public-class-method-details" class="method-section section"> + <h3 class="section-header">Public Class Methods</h3> + + + <div id="included-method" class="method-detail "> + <a name="M000059"></a> + + <div class="method-heading"> + + <span class="method-name">included</span><span + class="method-args">(modul)</span> + <span class="method-click-advice">click to toggle source</span> + + </div> + + <div class="method-description"> + + <p> +Extends <em>modul</em> with the <a +href="String/Extend.html">String::Extend</a> module. +</p> + + + + <div class="method-source-code" + id="included-source"> +<pre> +<span class="ruby-comment cmt"># File lib/json/pure/generator.rb, line 390</span> + <span class="ruby-keyword kw">def</span> <span class="ruby-keyword kw">self</span>.<span class="ruby-identifier">included</span>(<span class="ruby-identifier">modul</span>) + <span class="ruby-identifier">modul</span>.<span class="ruby-identifier">extend</span> <span class="ruby-constant">Extend</span> + <span class="ruby-keyword kw">end</span></pre> + </div> + + </div> + + + </div> + + + </div> + + <div id="public-instance-method-details" class="method-section section"> + <h3 class="section-header">Public Instance Methods</h3> + + + <div id="to-json-method" class="method-detail "> + <a name="M000057"></a> + + <div class="method-heading"> + + <span class="method-name">to_json</span><span + class="method-args">(*)</span> + <span class="method-click-advice">click to toggle source</span> + + </div> + + <div class="method-description"> + + <p> +This string should be encoded with UTF-8 A call to this method returns a <a +href="../../../../JSON.html">JSON</a> string encoded with UTF16 big endian +characters as u????. +</p> + + + + <div class="method-source-code" + id="to-json-source"> +<pre> +<span class="ruby-comment cmt"># File lib/json/pure/generator.rb, line 375</span> + <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">to_json</span>(<span class="ruby-operator">*</span>) + <span class="ruby-value str">'"'</span> <span class="ruby-operator"><<</span> <span class="ruby-constant">JSON</span>.<span class="ruby-identifier">utf8_to_json</span>(<span class="ruby-keyword kw">self</span>) <span class="ruby-operator"><<</span> <span class="ruby-value str">'"'</span> + <span class="ruby-keyword kw">end</span></pre> + </div> + + </div> + + + </div> + + + <div id="to-json-raw-method" class="method-detail "> + <a name="M000061"></a> + + <div class="method-heading"> + + <span class="method-name">to_json_raw</span><span + class="method-args">(*args)</span> + <span class="method-click-advice">click to toggle source</span> + + </div> + + <div class="method-description"> + + <p> +This method creates a <a href="../../../../JSON.html">JSON</a> text from +the result of a call to <a +href="String.html#M000060">to_json_raw_object</a> of this <a +href="String.html">String</a>. +</p> + + + + <div class="method-source-code" + id="to-json-raw-source"> +<pre> +<span class="ruby-comment cmt"># File lib/json/pure/generator.rb, line 407</span> + <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">to_json_raw</span>(<span class="ruby-operator">*</span><span class="ruby-identifier">args</span>) + <span class="ruby-identifier">to_json_raw_object</span>.<span class="ruby-identifier">to_json</span>(<span class="ruby-operator">*</span><span class="ruby-identifier">args</span>) + <span class="ruby-keyword kw">end</span></pre> + </div> + + </div> + + + </div> + + + <div id="to-json-raw-object-method" class="method-detail "> + <a name="M000060"></a> + + <div class="method-heading"> + + <span class="method-name">to_json_raw_object</span><span + class="method-args">()</span> + <span class="method-click-advice">click to toggle source</span> + + </div> + + <div class="method-description"> + + <p> +This method creates a raw object hash, that can be nested into other data +structures and will be unparsed as a raw string. This method should be +used, if you want to convert raw strings to <a +href="../../../../JSON.html">JSON</a> instead of UTF-8 strings, e. g. +binary data. +</p> + + + + <div class="method-source-code" + id="to-json-raw-object-source"> +<pre> +<span class="ruby-comment cmt"># File lib/json/pure/generator.rb, line 398</span> + <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">to_json_raw_object</span> + { + <span class="ruby-constant">JSON</span>.<span class="ruby-identifier">create_id</span> =<span class="ruby-operator">></span> <span class="ruby-keyword kw">self</span>.<span class="ruby-identifier">class</span>.<span class="ruby-identifier">name</span>, + <span class="ruby-value str">'raw'</span> =<span class="ruby-operator">></span> <span class="ruby-keyword kw">self</span>.<span class="ruby-identifier">unpack</span>(<span class="ruby-value str">'C*'</span>), + } + <span class="ruby-keyword kw">end</span></pre> + </div> + + </div> + + + </div> + + + </div> + + + </div> + + + <div id="rdoc-debugging-section-dump" class="debugging-section"> + + <p>Disabled; run with --debug to generate this.</p> + + </div> + + <div id="validator-badges"> + <p><small><a href="http://validator.w3.org/check/referer">[Validate]</a></small></p> + <p><small>Generated with the <a href="http://deveiate.org/projects/Darkfish-Rdoc/">Darkfish + Rdoc Generator</a> 1.1.6</small>.</p> + </div> + +</body> +</html> + |