Class: XMLRPC::Base64 (Ruby 2.3.7)
Description: Class : XMLRPC::Base64 - Ruby 2.3.7

- Home
- Core 2.3.7
- Std-lib 2.3.7
- Downloads

Support for the Ruby 2.3 series has ended. See here for reference.

### Home Classes Methods

### In Files

- xmlrpc/base64.rb

### Parent

Object

### Methods

- ::decode
- ::encode
- ::new
- #decoded
- #encoded

### Class/Module Index

Quicksearch

- NQXML
- NQXML::Node
- XMLRPC
- XMLRPC::Base64
- XMLRPC::BasicServer
- XMLRPC::CGIServer
- XMLRPC::Client
- XMLRPC::Client::Proxy
- XMLRPC::Config
- XMLRPC::Convert
- XMLRPC::Create
- XMLRPC::DateTime
- XMLRPC::FaultException
- XMLRPC::Marshal
- XMLRPC::Marshallable
- XMLRPC::ModRubyServer
- XMLRPC::ParseContentType
- XMLRPC::ParserWriterChooseMixin
- XMLRPC::Server
- XMLRPC::Service
- XMLRPC::Service::BasicInterface
- XMLRPC::Service::Interface
- XMLRPC::Service::PublicInstanceMethodsInterface
- XMLRPC::WEBrickServlet
- XMLRPC::XMLParser
- XMLRPC::XMLParser::AbstractStreamParser
- XMLRPC::XMLParser::AbstractTreeParser
- XMLRPC::XMLParser::LibXMLStreamParser
- XMLRPC::XMLParser::LibXMLStreamParser::LibXMLStreamListener
- XMLRPC::XMLParser::NQXMLParser
- XMLRPC::XMLParser::NQXMLStreamParser
- XMLRPC::XMLParser::NQXMLStreamParser::XMLRPCParser
- XMLRPC::XMLParser::NQXMLTreeParser
- XMLRPC::XMLParser::REXMLStreamParser
- XMLRPC::XMLParser::REXMLStreamParser::StreamListener
- XMLRPC::XMLParser::StreamParserMixin
- XMLRPC::XMLParser::XMLParser
- XMLRPC::XMLParser::XMLScanStreamParser
- XMLRPC::XMLParser::XMLScanStreamParser::XMLScanParser
- XMLRPC::XMLParser::XMLStreamParser
- XMLRPC::XMLParser::XMLTreeParser
- XMLRPC::XMLWriter
- XMLRPC::XMLWriter::Abstract
- XMLRPC::XMLWriter::Simple
- XMLRPC::XMLWriter::XMLParser

No matching classes.

# XMLRPC::Base64

This class is necessary for 'xmlrpc4r' to determine that a string should be transmitted base64-encoded and not as a raw-string.

You can use XMLRPC::Base64 on the client and server-side as a parameter and/or return-value.

### Public Class Methods

decode(str) click to toggle source

Decodes string `str` with base64 and returns that value.

                   # File xmlrpc/base64.rb, line 44
    def Base64.decode(str)
      str.gsub(/\s+/, "").unpack("m")[0]
    end

encode(str) click to toggle source

Encodes string `str` with base64 and returns that value.

                   # File xmlrpc/base64.rb, line 49
    def Base64.encode(str)
      [str].pack("m")
    end

new(str, state = :dec) click to toggle source

Creates a new XMLRPC::Base64 instance with string `str` as the internal string. When `state` is `:dec` it assumes that the string `str` is not in base64 format (perhaps already decoded), otherwise if `state` is `:enc` it decodes `str` and stores it as the internal string.

                   # File xmlrpc/base64.rb, line 21
    def initialize(str, state = :dec)
      case state
      when :enc
        @str = Base64.decode(str)
      when :dec
        @str = str
      else
        raise ArgumentError, "wrong argument; either :enc or :dec"
      end
    end

### Public Instance Methods

decoded() click to toggle source

Returns the decoded internal string.

                   # File xmlrpc/base64.rb, line 33
    def decoded
      @str
    end

encoded() click to toggle source

Returns the base64 encoded internal string.

                   # File xmlrpc/base64.rb, line 38
    def encoded
      Base64.encode(@str)
    end