← Back
Editing: OkJson.html
<?xml version="1.0" encoding="US-ASCII"?> <!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=US-ASCII" http-equiv="Content-Type" /> <title>Module: Rack::Utils::OkJson</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 id="top" class="module"> <div id="metadata"> <div id="home-metadata"> <div id="home-section" class="section"> <h3 class="section-header"> <a href="../../index.html">Home</a> <a href="../../index.html#classes">Classes</a> <a href="../../index.html#methods">Methods</a> </h3> </div> </div> <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/rack/utils/okjson_rb.html?TB_iframe=true&height=550&width=785" class="thickbox" title="lib/rack/utils/okjson.rb">lib/rack/utils/okjson.rb</a></li> </ul> </div> </div> </div> <div id="class-metadata"> <!-- Namespace Contents --> <div id="namespace-list-section" class="section"> <h3 class="section-header">Namespace</h3> <ul class="link-list"> <li><span class="type">CLASS</span> <a href="OkJson/Error.html">Rack::Utils::OkJson::Error</a></li> <li><span class="type">CLASS</span> <a href="OkJson/Utf8Error.html">Rack::Utils::OkJson::Utf8Error</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="#method-i-decode">#decode</a></li> <li><a href="#method-i-encode">#encode</a></li> <li><a href="#method-i-valenc">#valenc</a></li> </ul> </div> </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="../../KNOWN-ISSUES.html">KNOWN-ISSUES</a></li> </ul> </div> <div id="classindex-section" class="section project-section"> <h3 class="section-header">Class/Module 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="../../Rack.html">Rack</a></li> <li><a href="../../Rack/Auth.html">Rack::Auth</a></li> <li><a href="../../Rack/Auth/AbstractHandler.html">Rack::Auth::AbstractHandler</a></li> <li><a href="../../Rack/Auth/AbstractRequest.html">Rack::Auth::AbstractRequest</a></li> <li><a href="../../Rack/Auth/Basic.html">Rack::Auth::Basic</a></li> <li><a href="../../Rack/Auth/Basic/Request.html">Rack::Auth::Basic::Request</a></li> <li><a href="../../Rack/Auth/Digest.html">Rack::Auth::Digest</a></li> <li><a href="../../Rack/Auth/Digest/MD5.html">Rack::Auth::Digest::MD5</a></li> <li><a href="../../Rack/Auth/Digest/Nonce.html">Rack::Auth::Digest::Nonce</a></li> <li><a href="../../Rack/Auth/Digest/Params.html">Rack::Auth::Digest::Params</a></li> <li><a href="../../Rack/Auth/Digest/Request.html">Rack::Auth::Digest::Request</a></li> <li><a href="../../Rack/BodyProxy.html">Rack::BodyProxy</a></li> <li><a href="../../Rack/Builder.html">Rack::Builder</a></li> <li><a href="../../Rack/Cascade.html">Rack::Cascade</a></li> <li><a href="../../Rack/Chunked.html">Rack::Chunked</a></li> <li><a href="../../Rack/Chunked/Body.html">Rack::Chunked::Body</a></li> <li><a href="../../Rack/CommonLogger.html">Rack::CommonLogger</a></li> <li><a href="../../Rack/ConditionalGet.html">Rack::ConditionalGet</a></li> <li><a href="../../Rack/Config.html">Rack::Config</a></li> <li><a href="../../Rack/ContentLength.html">Rack::ContentLength</a></li> <li><a href="../../Rack/ContentType.html">Rack::ContentType</a></li> <li><a href="../../Rack/Deflater.html">Rack::Deflater</a></li> <li><a href="../../Rack/Deflater/DeflateStream.html">Rack::Deflater::DeflateStream</a></li> <li><a href="../../Rack/Deflater/GzipStream.html">Rack::Deflater::GzipStream</a></li> <li><a href="../../Rack/Directory.html">Rack::Directory</a></li> <li><a href="../../Rack/ETag.html">Rack::ETag</a></li> <li><a href="../../Rack/File.html">Rack::File</a></li> <li><a href="../../Rack/ForwardRequest.html">Rack::ForwardRequest</a></li> <li><a href="../../Rack/Handler.html">Rack::Handler</a></li> <li><a href="../../Rack/Handler/CGI.html">Rack::Handler::CGI</a></li> <li><a href="../../Rack/Handler/EventedMongrel.html">Rack::Handler::EventedMongrel</a></li> <li><a href="../../Rack/Handler/FastCGI.html">Rack::Handler::FastCGI</a></li> <li><a href="../../Rack/Handler/LSWS.html">Rack::Handler::LSWS</a></li> <li><a href="../../Rack/Handler/Mongrel.html">Rack::Handler::Mongrel</a></li> <li><a href="../../Rack/Handler/SCGI.html">Rack::Handler::SCGI</a></li> <li><a href="../../Rack/Handler/SwiftipliedMongrel.html">Rack::Handler::SwiftipliedMongrel</a></li> <li><a href="../../Rack/Handler/Thin.html">Rack::Handler::Thin</a></li> <li><a href="../../Rack/Handler/WEBrick.html">Rack::Handler::WEBrick</a></li> <li><a href="../../Rack/Head.html">Rack::Head</a></li> <li><a href="../../Rack/Lint.html">Rack::Lint</a></li> <li><a href="../../Rack/Lobster.html">Rack::Lobster</a></li> <li><a href="../../Rack/Lock.html">Rack::Lock</a></li> <li><a href="../../Rack/Logger.html">Rack::Logger</a></li> <li><a href="../../Rack/MethodOverride.html">Rack::MethodOverride</a></li> <li><a href="../../Rack/Mime.html">Rack::Mime</a></li> <li><a href="../../Rack/MockRequest.html">Rack::MockRequest</a></li> <li><a href="../../Rack/MockRequest/FatalWarner.html">Rack::MockRequest::FatalWarner</a></li> <li><a href="../../Rack/MockRequest/FatalWarning.html">Rack::MockRequest::FatalWarning</a></li> <li><a href="../../Rack/MockResponse.html">Rack::MockResponse</a></li> <li><a href="../../Rack/Multipart.html">Rack::Multipart</a></li> <li><a href="../../Rack/Multipart/Generator.html">Rack::Multipart::Generator</a></li> <li><a href="../../Rack/Multipart/MultipartPartLimitError.html">Rack::Multipart::MultipartPartLimitError</a></li> <li><a href="../../Rack/Multipart/Parser.html">Rack::Multipart::Parser</a></li> <li><a href="../../Rack/Multipart/UploadedFile.html">Rack::Multipart::UploadedFile</a></li> <li><a href="../../Rack/NullLogger.html">Rack::NullLogger</a></li> <li><a href="../../Rack/Recursive.html">Rack::Recursive</a></li> <li><a href="../../Rack/Reloader.html">Rack::Reloader</a></li> <li><a href="../../Rack/Reloader/Stat.html">Rack::Reloader::Stat</a></li> <li><a href="../../Rack/Request.html">Rack::Request</a></li> <li><a href="../../Rack/Response.html">Rack::Response</a></li> <li><a href="../../Rack/Response/Helpers.html">Rack::Response::Helpers</a></li> <li><a href="../../Rack/RewindableInput.html">Rack::RewindableInput</a></li> <li><a href="../../Rack/RewindableInput/Tempfile.html">Rack::RewindableInput::Tempfile</a></li> <li><a href="../../Rack/Runtime.html">Rack::Runtime</a></li> <li><a href="../../Rack/Sendfile.html">Rack::Sendfile</a></li> <li><a href="../../Rack/Server.html">Rack::Server</a></li> <li><a href="../../Rack/Server/Options.html">Rack::Server::Options</a></li> <li><a href="../../Rack/Session.html">Rack::Session</a></li> <li><a href="../../Rack/Session/Abstract.html">Rack::Session::Abstract</a></li> <li><a href="../../Rack/Session/Abstract/ID.html">Rack::Session::Abstract::ID</a></li> <li><a href="../../Rack/Session/Abstract/SessionHash.html">Rack::Session::Abstract::SessionHash</a></li> <li><a href="../../Rack/Session/Cookie.html">Rack::Session::Cookie</a></li> <li><a href="../../Rack/Session/Cookie/Base64.html">Rack::Session::Cookie::Base64</a></li> <li><a href="../../Rack/Session/Cookie/Base64/JSON.html">Rack::Session::Cookie::Base64::JSON</a></li> <li><a href="../../Rack/Session/Cookie/Base64/Marshal.html">Rack::Session::Cookie::Base64::Marshal</a></li> <li><a href="../../Rack/Session/Cookie/Base64/ZipJSON.html">Rack::Session::Cookie::Base64::ZipJSON</a></li> <li><a href="../../Rack/Session/Cookie/Identity.html">Rack::Session::Cookie::Identity</a></li> <li><a href="../../Rack/Session/Memcache.html">Rack::Session::Memcache</a></li> <li><a href="../../Rack/Session/Pool.html">Rack::Session::Pool</a></li> <li><a href="../../Rack/ShowExceptions.html">Rack::ShowExceptions</a></li> <li><a href="../../Rack/ShowStatus.html">Rack::ShowStatus</a></li> <li><a href="../../Rack/Static.html">Rack::Static</a></li> <li><a href="../../Rack/TempfileReaper.html">Rack::TempfileReaper</a></li> <li><a href="../../Rack/URLMap.html">Rack::URLMap</a></li> <li><a href="../../Rack/Utils.html">Rack::Utils</a></li> <li><a href="../../Rack/Utils/Context.html">Rack::Utils::Context</a></li> <li><a href="../../Rack/Utils/HeaderHash.html">Rack::Utils::HeaderHash</a></li> <li><a href="../../Rack/Utils/InvalidParameterError.html">Rack::Utils::InvalidParameterError</a></li> <li><a href="../../Rack/Utils/KeySpaceConstrainedParams.html">Rack::Utils::KeySpaceConstrainedParams</a></li> <li><a href="../../Rack/Multipart.html">Rack::Utils::Multipart</a></li> <li><a href="../../Rack/Utils/OkJson.html">Rack::Utils::OkJson</a></li> <li><a href="../../Rack/Utils/OkJson/Error.html">Rack::Utils::OkJson::Error</a></li> <li><a href="../../Rack/Utils/OkJson/Utf8Error.html">Rack::Utils::OkJson::Utf8Error</a></li> <li><a href="../../Rack/Utils/ParameterTypeError.html">Rack::Utils::ParameterTypeError</a></li> <li><a href="../../FCGI.html">FCGI</a></li> <li><a href="../../FCGI/Stream.html">FCGI::Stream</a></li> <li><a href="../../WEBrick.html">WEBrick</a></li> <li><a href="../../WEBrick/HTTPResponse.html">WEBrick::HTTPResponse</a></li> <li><a href="../../Object.html">Object</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">Rack::Utils::OkJson</h1> <div id="description" class="description"> <p>Some parts adapted from <a href="https://golang.org/src/encoding/json/decode.go">golang.org/src/encoding/json/decode.go</a> and <a href="https://golang.org/src/unicode/utf8/utf8.go">golang.org/src/unicode/utf8/utf8.go</a></p> </div><!-- description --> <div id="5Buntitled-5D" class="documentation-section"> <!-- Constants --> <div id="constants-list" class="section"> <h3 class="section-header">Constants</h3> <dl> <dt><a name="Spc">Spc</a></dt> <dd class="description"></dd> <dt><a name="Uchar1max">Uchar1max</a></dt> <dd class="description"></dd> <dt><a name="Uchar2max">Uchar2max</a></dt> <dd class="description"></dd> <dt><a name="Uchar3max">Uchar3max</a></dt> <dd class="description"></dd> <dt><a name="Ucharerr">Ucharerr</a></dt> <dd class="description"></dd> <dt><a name="Umask2">Umask2</a></dt> <dd class="description"></dd> <dt><a name="Umask3">Umask3</a></dt> <dd class="description"></dd> <dt><a name="Umask4">Umask4</a></dt> <dd class="description"></dd> <dt><a name="Umaskx">Umaskx</a></dt> <dd class="description"></dd> <dt><a name="Unesc">Unesc</a></dt> <dd class="description"></dd> <dt><a name="Upstream">Upstream</a></dt> <dd class="description"></dd> <dt><a name="Ustrerr">Ustrerr</a></dt> <dd class="description"></dd> <dt><a name="Usurr1">Usurr1</a></dt> <dd class="description"></dd> <dt><a name="Usurr2">Usurr2</a></dt> <dd class="description"></dd> <dt><a name="Usurr3">Usurr3</a></dt> <dd class="description"></dd> <dt><a name="Usurrself">Usurrself</a></dt> <dd class="description"></dd> <dt><a name="Utag2">Utag2</a></dt> <dd class="description"></dd> <dt><a name="Utag3">Utag3</a></dt> <dd class="description"></dd> <dt><a name="Utag4">Utag4</a></dt> <dd class="description"></dd> <dt><a name="Utag5">Utag5</a></dt> <dd class="description"></dd> <dt><a name="Utagx">Utagx</a></dt> <dd class="description"></dd> </dl> </div> <!-- Methods --> <div id="public-instance-method-details" class="method-section section"> <h3 class="section-header">Public Instance Methods</h3> <div id="decode-method" class="method-detail "> <a name="method-i-decode"></a> <div class="method-heading"> <span class="method-name">decode</span><span class="method-args">(s)</span> <span class="method-click-advice">click to toggle source</span> </div> <div class="method-description"> <p>Decodes a json document in string s and returns the corresponding ruby value. String s must be valid UTF-8. If you have a string in some other encoding, convert it first.</p> <p>String values in the resulting structure will be UTF-8.</p> <div class="method-source-code" id="decode-source"> <pre> <span class="ruby-comment"># File lib/rack/utils/okjson.rb, line 42</span> <span class="ruby-keyword">def</span> <span class="ruby-identifier">decode</span>(<span class="ruby-identifier">s</span>) <span class="ruby-identifier">ts</span> = <span class="ruby-identifier">lex</span>(<span class="ruby-identifier">s</span>) <span class="ruby-identifier">v</span>, <span class="ruby-identifier">ts</span> = <span class="ruby-identifier">textparse</span>(<span class="ruby-identifier">ts</span>) <span class="ruby-keyword">if</span> <span class="ruby-identifier">ts</span>.<span class="ruby-identifier">length</span> <span class="ruby-operator">></span> <span class="ruby-value">0</span> <span class="ruby-identifier">raise</span> <span class="ruby-constant">Error</span>, <span class="ruby-string">'trailing garbage'</span> <span class="ruby-keyword">end</span> <span class="ruby-identifier">v</span> <span class="ruby-keyword">end</span></pre> </div><!-- decode-source --> </div> </div><!-- decode-method --> <div id="encode-method" class="method-detail "> <a name="method-i-encode"></a> <div class="method-heading"> <span class="method-name">encode</span><span class="method-args">(x)</span> <span class="method-click-advice">click to toggle source</span> </div> <div class="method-description"> <p>Encodes x into a json text. It may contain only Array, Hash, String, Numeric, true, false, nil. (Note, this list excludes Symbol.) X itself must be an Array or a Hash. No other value can be encoded, and an error will be raised if x contains any other value, such as Nan, Infinity, Symbol, and Proc, or if a Hash key is not a String. Strings contained in x must be valid UTF-8.</p> <div class="method-source-code" id="encode-source"> <pre> <span class="ruby-comment"># File lib/rack/utils/okjson.rb, line 61</span> <span class="ruby-keyword">def</span> <span class="ruby-identifier">encode</span>(<span class="ruby-identifier">x</span>) <span class="ruby-keyword">case</span> <span class="ruby-identifier">x</span> <span class="ruby-keyword">when</span> <span class="ruby-constant">Hash</span> <span class="ruby-keyword">then</span> <span class="ruby-identifier">objenc</span>(<span class="ruby-identifier">x</span>) <span class="ruby-keyword">when</span> <span class="ruby-constant">Array</span> <span class="ruby-keyword">then</span> <span class="ruby-identifier">arrenc</span>(<span class="ruby-identifier">x</span>) <span class="ruby-keyword">else</span> <span class="ruby-identifier">raise</span> <span class="ruby-constant">Error</span>, <span class="ruby-string">'root value must be an Array or a Hash'</span> <span class="ruby-keyword">end</span> <span class="ruby-keyword">end</span></pre> </div><!-- encode-source --> </div> </div><!-- encode-method --> <div id="valenc-method" class="method-detail "> <a name="method-i-valenc"></a> <div class="method-heading"> <span class="method-name">valenc</span><span class="method-args">(x)</span> <span class="method-click-advice">click to toggle source</span> </div> <div class="method-description"> <div class="method-source-code" id="valenc-source"> <pre> <span class="ruby-comment"># File lib/rack/utils/okjson.rb, line 71</span> <span class="ruby-keyword">def</span> <span class="ruby-identifier">valenc</span>(<span class="ruby-identifier">x</span>) <span class="ruby-keyword">case</span> <span class="ruby-identifier">x</span> <span class="ruby-keyword">when</span> <span class="ruby-constant">Hash</span> <span class="ruby-keyword">then</span> <span class="ruby-identifier">objenc</span>(<span class="ruby-identifier">x</span>) <span class="ruby-keyword">when</span> <span class="ruby-constant">Array</span> <span class="ruby-keyword">then</span> <span class="ruby-identifier">arrenc</span>(<span class="ruby-identifier">x</span>) <span class="ruby-keyword">when</span> <span class="ruby-constant">String</span> <span class="ruby-keyword">then</span> <span class="ruby-identifier">strenc</span>(<span class="ruby-identifier">x</span>) <span class="ruby-keyword">when</span> <span class="ruby-constant">Numeric</span> <span class="ruby-keyword">then</span> <span class="ruby-identifier">numenc</span>(<span class="ruby-identifier">x</span>) <span class="ruby-keyword">when</span> <span class="ruby-keyword">true</span> <span class="ruby-keyword">then</span> <span class="ruby-string">"true"</span> <span class="ruby-keyword">when</span> <span class="ruby-keyword">false</span> <span class="ruby-keyword">then</span> <span class="ruby-string">"false"</span> <span class="ruby-keyword">when</span> <span class="ruby-keyword">nil</span> <span class="ruby-keyword">then</span> <span class="ruby-string">"null"</span> <span class="ruby-keyword">else</span> <span class="ruby-identifier">raise</span> <span class="ruby-constant">Error</span>, <span class="ruby-node">"cannot encode #{x.class}: #{x.inspect}"</span> <span class="ruby-keyword">end</span> <span class="ruby-keyword">end</span></pre> </div><!-- valenc-source --> </div> </div><!-- valenc-method --> </div><!-- public-instance-method-details --> </div><!-- 5Buntitled-5D --> </div><!-- documentation --> <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> 2</small>.</p> </div> </body> </html>
Save File
Cancel