struct XML::Reader

Defined in:

xml/reader/type.cr
xml/reader.cr

Constructors

Instance Method Summary

Instance methods inherited from struct Struct

==(other) : Bool ==, hash(hasher) hash, inspect(io : IO) : Nil inspect, pretty_print(pp) : Nil pretty_print, to_s(io : IO) : Nil to_s

Instance methods inherited from struct Value

==(other : JSON::Any)
==(other : YAML::Any)
==(other)
==
, dup dup

Instance methods inherited from class Object

! : Bool !, !=(other) !=, !~(other) !~, ==(other) ==, ===(other : JSON::Any)
===(other : YAML::Any)
===(other)
===
, =~(other) =~, as(type : Class) as, as?(type : Class) as?, class class, dup dup, hash
hash(hasher)
hash
, inspect(io : IO) : Nil
inspect : String
inspect
, is_a?(type : Class) : Bool is_a?, itself itself, nil? : Bool nil?, not_nil! not_nil!, pretty_inspect(width = 79, newline = "\n", indent = 0) : String pretty_inspect, pretty_print(pp : PrettyPrint) : Nil pretty_print, responds_to?(name : Symbol) : Bool responds_to?, tap(&) tap, to_json(io : IO)
to_json
to_json
, to_pretty_json(indent : String = " ")
to_pretty_json(io : IO, indent : String = " ")
to_pretty_json
, to_s : String
to_s(io : IO) : Nil
to_s
, to_yaml(io : IO)
to_yaml
to_yaml
, try(&) try, unsafe_as(type : T.class) forall T unsafe_as

Constructor methods inherited from class Object

from_json(string_or_io, root : String) : self
from_json(string_or_io) : self
from_json
, from_yaml(string_or_io : String | IO) : self from_yaml

Constructor Detail

def self.new(str : String, options : XML::ParserOptions = XML::ParserOptions.default) #

Creates a new reader from a string.

See XML::ParserOptions.default for default options.


[View source]
def self.new(io : IO, options : XML::ParserOptions = XML::ParserOptions.default) #

Creates a new reader from an IO.

See XML::ParserOptions.default for default options.


[View source]

Instance Method Detail

def [](attribute : String) : String #

Gets the attribute content for the attribute given by name. Raises KeyError if attribute is not found.


[View source]
def []?(attribute : String) : String? #

Gets the attribute content for the attribute given by name. Returns nil if attribute is not found.


[View source]
def attributes_count #

Returns attribute count of the node.


[View source]
def depth #

Returns the current nesting depth of the reader.


[View source]
def empty_element? #

Checks if the node is an empty element.


[View source]
def expand : XML::Node #

Expands the node to a XML::Node that can be searched with XPath etc. The returned XML::Node is only valid until the next call to #read.

Raises a XML::Error if the node could not be expanded.


[View source]
def expand? : XML::Node? #

Expands the node to a XML::Node that can be searched with XPath etc. The returned XML::Node is only valid until the next call to #read.

Returns nil if the node could not be expanded.


[View source]
def has_attributes? #

Checks if the node has any attributes.


[View source]
def move_to_attribute(name : String) #

Moves to the XML::Reader::Type::ATTRIBUTE with the specified name.


[View source]
def move_to_element #

Moves from the XML::Reader::Type::ATTRIBUTE to its containing XML::Reader::Type::ELEMENT.


[View source]
def move_to_first_attribute #

Moves to the first XML::Reader::Type::ATTRIBUTE of the node.


[View source]
def move_to_next_attribute #

Moves to the next XML::Reader::Type::ATTRIBUTE of the node.


[View source]
def name #

Returns the name of the node.


[View source]
def next #

Moves the reader to the next node while skipping subtrees.


[View source]
def next_sibling #

Moves the reader to the next sibling node while skipping subtrees.


[View source]
def node_type : XML::Reader::Type #

Returns the XML::Reader::Type of the node.


[View source]
def read #

Moves the reader to the next node.


[View source]
def read_inner_xml #

Returns the node's XML content including subtrees.


[View source]
def read_outer_xml #

Returns the XML for the node and its content including subtrees.


[View source]
def to_unsafe : LibXML::XMLTextReader #

Returns a reference to the underlying LibXML::XMLTextReader.


[View source]
def value #

Returns the text content of the node.


[View source]