Module: SXP

Defined in:
vendor/bundler/ruby/2.5.0/bundler/gems/sxp.rb-ff0ae90d6303/lib/sxp/reader/scheme.rb,
vendor/bundler/ruby/2.5.0/bundler/gems/sxp.rb-ff0ae90d6303/lib/sxp/reader/basic.rb,
vendor/bundler/ruby/2.5.0/bundler/gems/sxp.rb-ff0ae90d6303/lib/sxp/reader/extended.rb,
vendor/bundler/ruby/2.5.0/bundler/gems/sxp.rb-ff0ae90d6303/lib/sxp/reader/sparql.rb,
vendor/bundler/ruby/2.5.0/bundler/gems/sxp.rb-ff0ae90d6303/lib/sxp/reader/common_lisp.rb,
vendor/bundler/ruby/2.5.0/bundler/gems/sxp.rb-ff0ae90d6303/lib/sxp/pair.rb,
vendor/bundler/ruby/2.5.0/bundler/gems/sxp.rb-ff0ae90d6303/lib/sxp/reader.rb,
vendor/bundler/ruby/2.5.0/bundler/gems/sxp.rb-ff0ae90d6303/lib/sxp/generator.rb,
vendor/bundler/ruby/2.5.0/bundler/gems/sxp.rb-ff0ae90d6303/lib/sxp/version.rb,
vendor/bundler/ruby/2.5.0/bundler/gems/sxp.rb-ff0ae90d6303/lib/sxp/list.rb,
vendor/bundler/ruby/2.5.0/bundler/gems/sxp.rb-ff0ae90d6303/lib/sxp.rb

Defined Under Namespace

Modules: VERSION Classes: Generator, List, Pair, Reader

Class Method Summary collapse

Class Method Details

.read(input, options = {}) ⇒ Object Also known as: parse

Reads one S-expression from the given input stream.

Parameters:

Returns:



80
81
82
# File 'vendor/bundler/ruby/2.5.0/bundler/gems/sxp.rb-ff0ae90d6303/lib/sxp.rb', line 80

def self.read(input, options = {})
  Reader::Basic.read(input, options)
end

.read_all(input, options = {}) ⇒ Enumerable<Object> Also known as: parse_all

Reads all S-expressions from the given input stream.

Parameters:

Returns:



70
71
72
# File 'vendor/bundler/ruby/2.5.0/bundler/gems/sxp.rb-ff0ae90d6303/lib/sxp.rb', line 70

def self.read_all(input, options = {})
  Reader::Basic.read_all(input, options)
end

.read_file(filename, options = {}) ⇒ Enumerable<Object> Also known as: parse_file

Reads all S-expressions from a given input file.

Parameters:

Returns:



60
61
62
# File 'vendor/bundler/ruby/2.5.0/bundler/gems/sxp.rb-ff0ae90d6303/lib/sxp.rb', line 60

def self.read_file(filename, options = {})
  Reader::Basic.read_file(filename, options)
end

.read_files(*filenames) ⇒ Enumerable<Object> .read_files(*filenames, options) ⇒ Enumerable<Object> Also known as: parse_files

Reads all S-expressions from the given input files.

Overloads:

  • .read_files(*filenames) ⇒ Enumerable<Object>

    Parameters:

    • filenames (Enumerable<String>)
  • .read_files(*filenames, options) ⇒ Enumerable<Object>

    Parameters:

Returns:



50
51
52
# File 'vendor/bundler/ruby/2.5.0/bundler/gems/sxp.rb-ff0ae90d6303/lib/sxp.rb', line 50

def self.read_files(*filenames)
  Reader::Basic.read_files(*filenames)
end

.read_url(url, options = {}) ⇒ Enumerable<Object> Also known as: parse_url, parse_uri, read_uri

Reads all S-expressions from a given input URL using the HTTP or FTP protocols.

Parameters:

Returns:



35
36
37
# File 'vendor/bundler/ruby/2.5.0/bundler/gems/sxp.rb-ff0ae90d6303/lib/sxp.rb', line 35

def self.read_url(url, options = {})
  Reader::Basic.read_url(url, options)
end

.write(sxp, output = STDOUT) ⇒ Object

Write an internal S-Expression as a formatted SXP

@param[Array] sxp @param[#write] output



89
90
91
# File 'vendor/bundler/ruby/2.5.0/bundler/gems/sxp.rb-ff0ae90d6303/lib/sxp.rb', line 89

def self.write(sxp, output = STDOUT)
  Generator.write(output, sxp)
end