Module: SXP

Defined in:

vendor/bundler/ruby/3.3.0/bundler/gems/sxp.rb-7a771a32c5fe/lib/sxp.rb,
vendor/bundler/ruby/3.3.0/bundler/gems/sxp.rb-7a771a32c5fe/lib/sxp/list.rb,
vendor/bundler/ruby/3.3.0/bundler/gems/sxp.rb-7a771a32c5fe/lib/sxp/pair.rb,
vendor/bundler/ruby/3.3.0/bundler/gems/sxp.rb-7a771a32c5fe/lib/sxp/reader.rb,
vendor/bundler/ruby/3.3.0/bundler/gems/sxp.rb-7a771a32c5fe/lib/sxp/version.rb,
vendor/bundler/ruby/3.3.0/bundler/gems/sxp.rb-7a771a32c5fe/lib/sxp/generator.rb,
vendor/bundler/ruby/3.3.0/bundler/gems/sxp.rb-7a771a32c5fe/lib/sxp/reader/basic.rb,
vendor/bundler/ruby/3.3.0/bundler/gems/sxp.rb-7a771a32c5fe/lib/sxp/reader/scheme.rb,
vendor/bundler/ruby/3.3.0/bundler/gems/sxp.rb-7a771a32c5fe/lib/sxp/reader/sparql.rb,
vendor/bundler/ruby/3.3.0/bundler/gems/sxp.rb-7a771a32c5fe/lib/sxp/reader/extended.rb,
vendor/bundler/ruby/3.3.0/bundler/gems/sxp.rb-7a771a32c5fe/lib/sxp/reader/common_lisp.rb

Defined Under Namespace

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

Class Method Summary

• .read(input, **options) ⇒ Object (also: parse)

  Reads one S-expression from the given input stream.

• .read_all(input, **options) ⇒ Enumerable<Object> (also: parse_all)

  Reads all S-expressions from the given input stream.

• .read_file(filename, **options) ⇒ Enumerable<Object> (also: parse_file)

  Reads all S-expressions from a given input file.

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

  Reads all S-expressions from the given input files.

• .read_url(url, **options) ⇒ Enumerable<Object> (also: parse_url, parse_uri, read_uri)

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

• .write(sxp, output = STDOUT) ⇒ Object

  Write an internal S-Expression as a formatted SXP.

Class Method Details

.read(input, **options) ⇒ Object Also known as: parse

Reads one S-expression from the given input stream.

Parameters:

• input (IO, StringIO, String)
• options (Hash{Symbol => Object})

Returns:

• (Object)

# File 'vendor/bundler/ruby/3.3.0/bundler/gems/sxp.rb-7a771a32c5fe/lib/sxp.rb', line 65

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:

• input (IO, StringIO, String)
• options (Hash{Symbol => Object})

Returns:

• (Enumerable<Object>)

# File 'vendor/bundler/ruby/3.3.0/bundler/gems/sxp.rb-7a771a32c5fe/lib/sxp.rb', line 55

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:

• filename (String, #to_s)
• options (Hash{Symbol => Object})

Returns:

• (Enumerable<Object>)

# File 'vendor/bundler/ruby/3.3.0/bundler/gems/sxp.rb-7a771a32c5fe/lib/sxp.rb', line 45

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:

  • filenames (Enumerable<String>)
  • options (Hash{Symbol => Object})

Returns:

• (Enumerable<Object>)

# File 'vendor/bundler/ruby/3.3.0/bundler/gems/sxp.rb-7a771a32c5fe/lib/sxp.rb', line 35

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:

• url (String, #to_s)
• options (Hash{Symbol => Object})

Returns:

• (Enumerable<Object>)

# File 'vendor/bundler/ruby/3.3.0/bundler/gems/sxp.rb-7a771a32c5fe/lib/sxp.rb', line 20

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