class XML::Reader
Defined in:
xml/reader.crxml/reader/type.cr
Constructors
- .new(str : String, options : XML::ParserOptions = XML::ParserOptions.default)
Creates a new reader from a string.
- .new(io : IO, options : XML::ParserOptions = XML::ParserOptions.default)
Creates a new reader from an IO.
Instance Method Summary
- #[](attribute : String) : String
Gets the attribute content for the attribute given by name.
- #[]?(attribute : String) : String?
Gets the attribute content for the attribute given by name.
- #attributes_count : Int32
Returns attribute count of the node.
- #depth : Int32
Returns the current nesting depth of the reader.
- #empty_element? : Bool
Checks if the node is an empty element.
- #expand : XML::Node
Expands the node to a
XML::Nodethat can be searched with XPath etc. - #expand? : XML::Node?
Expands the node to a
XML::Nodethat can be searched with XPath etc. - #has_attributes? : Bool
Checks if the node has any attributes.
- #move_to_attribute(name : String) : Bool
Moves to the
XML::Reader::Type::ATTRIBUTEwith the specified name. - #move_to_element : Bool
Moves from the
XML::Reader::Type::ATTRIBUTEto its containingXML::Reader::Type::ELEMENT. - #move_to_first_attribute : Bool
Moves to the first
XML::Reader::Type::ATTRIBUTEof the node. - #move_to_next_attribute : Bool
Moves to the next
XML::Reader::Type::ATTRIBUTEof the node. - #name : String
Returns the name of the node.
- #next : Bool
Moves the reader to the next node while skipping subtrees.
- #next_sibling : Bool
Moves the reader to the next sibling node while skipping subtrees.
- #node_type : XML::Reader::Type
Returns the
XML::Reader::Typeof the node. - #read : Bool
Moves the reader to the next node.
- #read_inner_xml : String
Returns the node's XML content including subtrees.
- #read_outer_xml : String
Returns the XML for the node and its content including subtrees.
- #to_unsafe : LibXML::XMLTextReader
Returns a reference to the underlying
LibXML::XMLTextReader. - #value : String
Returns the text content of the node.
Instance methods inherited from class Reference
==(other : self)==(other : JSON::Any)
==(other : YAML::Any)
==(other) ==, dup dup, hash(hasher) hash, inspect(io : IO) : Nil inspect, object_id : UInt64 object_id, pretty_print(pp) : Nil pretty_print, same?(other : Reference) : Bool
same?(other : Nil) same?, to_s(io : IO) : Nil to_s
Constructor methods inherited from class Reference
new new 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(hasher)
hash hash, in?(collection : Object) : Bool
in?(*values : Object) : Bool in?, 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) : Nil
to_json : String to_json, to_pretty_json(indent : String = " ") : String
to_pretty_json(io : IO, indent : String = " ") : Nil to_pretty_json, to_s(io : IO) : Nil
to_s : String to_s, to_yaml(io : IO) : Nil
to_yaml : String to_yaml, try(&) try, unsafe_as(type : T.class) forall T unsafe_as
Class methods inherited from class Object
from_json(string_or_io, root : String)from_json(string_or_io) from_json, from_yaml(string_or_io : String | IO) from_yaml
Constructor Detail
def self.new(str : String, options : XML::ParserOptions = XML::ParserOptions.default)Source
Creates a new reader from a string.
See XML::ParserOptions.default for default options.
def self.new(io : IO, options : XML::ParserOptions = XML::ParserOptions.default)Source
Creates a new reader from an IO.
See XML::ParserOptions.default for default options.
Instance Method Detail
def [](attribute : String) : StringSource
Gets the attribute content for the attribute given by name. Raises KeyError if attribute is not found.
def []?(attribute : String) : String?Source
Gets the attribute content for the attribute given by name. Returns nil if attribute is not found.
def expand : XML::NodeSource
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.
def move_to_attribute(name : String) : BoolSource
Moves to the XML::Reader::Type::ATTRIBUTE with the specified name.
def move_to_element : BoolSource
Moves from the XML::Reader::Type::ATTRIBUTE to its containing XML::Reader::Type::ELEMENT.
def move_to_first_attribute : BoolSource
Moves to the first XML::Reader::Type::ATTRIBUTE of the node.
def move_to_next_attribute : BoolSource
Moves to the next XML::Reader::Type::ATTRIBUTE of the node.
def node_type : XML::Reader::TypeSource
Returns the XML::Reader::Type of the node.
def to_unsafe : LibXML::XMLTextReaderSource
Returns a reference to the underlying LibXML::XMLTextReader.
© 2012–2021 Manas Technology Solutions.
Licensed under the Apache License, Version 2.0.
https://crystal-lang.org/api/1.2.1/XML/Reader.html