class XML::Builder

Overview

An XML builder generates valid XML.

An XML::Error is raised if attempting to generate an invalid XML (for example, if invoking #end_element without a matching #start_element, or trying to use a non-string value as an object's field name)

Defined in:

xml/builder.cr

Constructors

Instance Method Summary

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(io : IO)Source

Creates a builder that writes to the given io.

Instance Method Detail

def attribute(*args, **nargs, &)Source

Emits the start of an attribute, invokes the block, and then emits the end of the attribute.

def attribute(prefix : String?, name : String, namespace_uri : String?, value) : NilSource

Emits an attribute with namespace info and a value.

def attribute(name : String, value) : NilSource

Emits an attribute with a value.

def attributes(attributes : Hash | NamedTuple) : NilSource

Emits the given attributes with their values.

def attributes(**attributes)Source

Emits the given attributes with their values.

def cdata(&)Source

Emits the start of a CDATA section, invokes the block and then emits the end of the CDATA section.

NOTE CDATA end sequences written within the block need to be escaped manually.

def cdata(text : String) : NilSource

Emits a CDATA section. Escapes nested CDATA end sequences.

def comment(&)Source

Emits the start of a comment, invokes the block and then emits the end of the comment.

def comment(text : String) : NilSource

Emits a comment.

def document(version = nil, encoding = nil, &)Source

Emits the start of the document, invokes the block, and then emits the end of the document.

def dtd(name : String, pubid : String, sysid : String, &) : NilSource

Emits the start of a DTD, invokes the block and then emits the end of the DTD.

def dtd(name : String, pubid : String, sysid : String, subset : String? = nil) : NilSource

Emits a DTD.

def element(__prefix__ : String?, __name__ : String, __namespace_uri__ : String?, attributes : Hash | NamedTuple, &)Source

Emits the start of an element with namespace info with the given attributes, invokes the block and then emits the end of the element.

def element(__prefix__ : String?, __name__ : String, __namespace_uri__ : String?, **attributes, &)Source

Emits the start of an element with namespace info with the given attributes, invokes the block and then emits the end of the element.

def element(__name__ : String, attributes : Hash | NamedTuple, &)Source

Emits the start of an element with the given attributes, invokes the block and then emits the end of the element.

def element(__name__ : String, **attributes, &)Source

Emits the start of an element with the given attributes, invokes the block and then emits the end of the element.

def element(prefix : String?, name : String, namespace_uri : String?, attributes : Hash | NamedTuple) : NilSource

Emits an element with namespace info with the given attributes.

def element(prefix : String?, name : String, namespace_uri : String?, **attributes) : NilSource

Emits an element with namespace info with the given attributes.

def element(name : String, attributes : Hash | NamedTuple) : NilSource

Emits an element with the given attributes.

def element(__name__ : String, **attributes)Source

Emits an element with the given attributes.

def end_attribute : NilSource

Emits the end of an attribute.

def end_cdata : NilSource

Emits the end of a CDATA section.

def end_comment : NilSource

Emits the end of a comment.

def end_document : NilSource

Emits the end of a document.

def end_dtd : NilSource

Emits the end of a DTD.

def end_element : NilSource

Emits the end of an element.

def flush : NilSource

Forces content written to this writer to be flushed to this writer's IO.

def indent=(str : String)Source

Sets the indent string.

def indent=(level : Int)Source

Sets the indent level (number of spaces).

def namespace(prefix, uri) : NilSource

Emits a namespace.

def quote_char=(char : Char)Source

Sets the quote char to use, either ' or ".

def start_attribute(prefix : String?, name : String, namespace_uri : String?)Source

Emits the start of an attribute with namespace info.

def start_attribute(name : String) : NilSource

Emits the start of an attribute.

def start_cdata : NilSource

Emits the start of a CDATA section.

def start_comment : NilSource

Emits the start of a comment.

def start_document(version = nil, encoding = nil) : NilSource

Emits the start of the document.

def start_dtd(name : String, pubid : String, sysid : String) : NilSource

Emits the start of a DTD.

def start_element(prefix : String?, name : String, namespace_uri : String?) : NilSource

Emits the start of an element with namespace info.

def start_element(name : String) : NilSource

Emits the start of an element.

def text(content : String) : NilSource

Emits text content.

Text content can happen inside of an #element, #attribute value, #cdata, #dtd, etc.

© 2012–2021 Manas Technology Solutions.
Licensed under the Apache License, Version 2.0.
https://crystal-lang.org/api/1.2.1/XML/Builder.html