xml
API
Generated with
xml/smithy4s.xml/XmlDocument

XmlDocument

smithy4s.xml.XmlDocument
See theXmlDocument companion class
object XmlDocument

Attributes

Companion
class
Graph
Supertypes
trait Product
trait Mirror
class Object
trait Matchable
class Any
Self type

Members list

Type members

Classlikes

object Decoder extends DerivingImpl[Decoder]

Attributes

Supertypes
class DerivingImpl[Decoder]
class Impl[Decoder]
trait CachedSchemaCompiler[Decoder]
class Object
trait Matchable
class Any
Show all
Self type
Decoder.type
object Encoder extends Impl[Encoder]

Attributes

Companion
trait
Supertypes
class Impl[Encoder]
trait CachedSchemaCompiler[Encoder]
class Object
trait Matchable
class Any
Self type
Encoder.type
trait Encoder[A]

Attributes

Companion
object
Supertypes
class Object
trait Matchable
class Any
final case class XmlAttr(name: XmlQName, values: List[XmlText]) extends XmlContent

Attributes

Supertypes
trait XmlContent
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
sealed trait XmlContent extends Product, Serializable

The XmlContent is the the very simple ADT that Smithy4s works against when dealing with XML. It can be either a piece of text, or an XML element. Smithy4s expects XML references to be resolved before this content is created.

The XmlContent is the the very simple ADT that Smithy4s works against when dealing with XML. It can be either a piece of text, or an XML element. Smithy4s expects XML references to be resolved before this content is created.

It is worth noting that comments and other miscellaneous elements are erased before instances of this ADT are produced

Attributes

Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
Known subtypes
class XmlAttr
class XmlElem
class XmlEntityRef
class XmlText
final case class XmlElem(name: XmlQName, attributes: List[XmlAttr], children: List[XmlContent]) extends XmlContent

Attributes

Supertypes
trait XmlContent
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
final case class XmlEntityRef(entityName: String) extends XmlContent

Attributes

Supertypes
trait XmlContent
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
final case class XmlQName(prefix: Option[String], name: String)

Attributes

Companion
object
Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
object XmlQName

Attributes

Companion
class
Supertypes
trait Product
trait Mirror
class Object
trait Matchable
class Any
Self type
XmlQName.type
final case class XmlText(text: String) extends XmlContent

Attributes

Supertypes
trait XmlContent
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all

Types

type Decoder[A] = Decoder[[_] =>> Either[XmlDecodeError, _$3], XmlDocument, A]

A Decoder aims at decoding documents. As such, it is not meant to be a compositional construct, because documents cannot be nested under other documents. This aims at decoding top-level XML payloads.

A Decoder aims at decoding documents. As such, it is not meant to be a compositional construct, because documents cannot be nested under other documents. This aims at decoding top-level XML payloads.

Attributes

Inherited types

type MirroredElemLabels <: Tuple

The names of the product elements

The names of the product elements

Attributes

Inherited from:
Mirror
type MirroredLabel <: String

The name of the type

The name of the type

Attributes

Inherited from:
Mirror

Implicits

Implicits

implicit def decoderFromSchema[A : Schema]: Decoder[A]
implicit val documentBuilder: DocumentBuilder[XmlDocument]

This instance implements the DocumentBuilder interface provided by fs2-data, which can be used to parse a stream of XML events into a stream of our XmlDocument.

This instance implements the DocumentBuilder interface provided by fs2-data, which can be used to parse a stream of XML events into a stream of our XmlDocument.

Attributes

Generated with