p

fs2.data

xml

package xml

Source
package.scala
Linear Supertypes
AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. xml
  2. AnyRef
  3. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Type Members

  1. case class Attr(name: QName, value: List[XmlTexty]) extends Product with Serializable
  2. sealed abstract class NSError extends XmlError

    Represents a namespace constraint as defined in the XML namespaces recommendation.

  3. case class QName(prefix: Option[String], local: String) extends Product with Serializable
  4. sealed abstract class WFError extends XmlError

    Represents a Well-formedness constraint as defined in the XML specification.

  5. abstract class XmlError extends AnyRef

    All errors encountered in processing an Xml documents have a kind.

    All errors encountered in processing an Xml documents have a kind. These errors are unique code defined in the various normative documents and recommendations.

  6. sealed trait XmlEvent extends AnyRef
  7. case class XmlException(error: XmlError, msg: String) extends Exception with Product with Serializable
  8. implicit final class XmlInterpolators extends AnyVal
  9. case class XmlSyntax(id: String) extends XmlError with Product with Serializable

    Represents a syntax error according to an XML production rule.

Value Members

  1. def events[F[_], T](includeComments: Boolean = false)(implicit F: RaiseThrowable[F], T: CharLikeChunks[F, T]): Pipe[F, T, XmlEvent]

    Transforms a stream of characters into a stream of XML events.

    Transforms a stream of characters into a stream of XML events. Emitted tokens are guaranteed to be valid up to that point. If the streams ends without failure, the sequence of tokens is ensured to represent a (potentially empty) sequence of valid XML documents.

    if includeComments is true, then comment events will be emitted together with the comment content.

  2. def isNCNameChar(c: Char): Boolean
  3. def isNCNameStart(c: Char): Boolean
  4. def isXmlWhitespace(c: Char): Boolean
  5. def namespaceResolver[F[_]](implicit F: MonadError[F, Throwable]): Pipe[F, XmlEvent, XmlEvent]

    Resolves all prefixes in QNames.

    Resolves all prefixes in QNames. Assumes that entity and character references have been resolved already. Make stream go through referenceResolver first if you need it (not needed if you xml doesn't contain any such reference).

  6. val ncNameChar: CharRanges
  7. val ncNameStart: CharRanges
  8. def normalize[F[_]]: Pipe[F, XmlEvent, XmlEvent]

    Performs some event normalizations:

    Performs some event normalizations:

    • group consecutive non CDATA XmlEvent.XmlStrings This can be useful to merge texts once references have been resolved. Attribute values are also normalized, so that they will end up being one single string after normalization if references have been replaced.
  9. def referenceResolver[F[_]](entities: Map[String, String] = xmlEntities)(implicit F: MonadError[F, Throwable]): Pipe[F, XmlEvent, XmlEvent]

    Resolves the character and entity references in the XML stream.

    Resolves the character and entity references in the XML stream. Entities are already defined and validated (especially no recursion), hence the entities map contains the resolved text to replace the entity by.

  10. val xmlEntities: Map[String, String]

    The predefined XML character entities

  11. object Attr extends AbstractFunction2[QName, List[XmlTexty], Attr] with Serializable
  12. object NSCAttributesUnique extends NSError with Product with Serializable
  13. object NSCNoPrefixUndeclaring extends NSError with Product with Serializable
  14. object NSCPrefixDeclared extends NSError with Product with Serializable
  15. object QName extends Serializable
  16. object WFCElementTypeMatch extends WFError with Product with Serializable
  17. object WFCEntityDeclared extends WFError with Product with Serializable
  18. object WFCNoRecursion extends WFError with Product with Serializable
  19. object XmlEvent
  20. object collector

    XML event stream collectors.

  21. object render

    XML Event stream pipes to render XML values.

Deprecated Value Members

  1. def events[F[_], T](implicit F: RaiseThrowable[F], T: CharLikeChunks[F, T]): Pipe[F, T, XmlEvent]

    Transforms a stream of characters into a stream of XML events.

    Transforms a stream of characters into a stream of XML events. Emitted tokens are guaranteed to be valid up to that point. If the streams ends without failure, the sequence of tokens is ensured to represent a (potentially empty) sequence of valid XML documents.

    Annotations
    @deprecated
    Deprecated

    (Since version fs2-data 1.4.0) Use fs2.data.xml.events() instead.

  2. def render[F[_]](collapseEmpty: Boolean = true): Pipe[F, XmlEvent, String]

    Render the incoming xml events to their string representation.

    Render the incoming xml events to their string representation. The output will be concise, without additional (or original) whitespace and with empty tags being collapsed to the short self-closed form <x/> if collapseEmpty is true.

    Annotations
    @deprecated
    Deprecated

    (Since version fs2-data 1.11.0) Use fs2.data.xml.render.raw() instead.

Inherited from AnyRef

Inherited from Any

Ungrouped