fs2-data-xml
1.7.1
API
Generated with
fs2-data-xml/fs2.data.xml

fs2.data.xml

package fs2.data.xml

Members list

Concise view

Type members

Classlikes

case class Attr(name: QName, value: List[XmlTexty])

Attributes

Source:
Attr.scala
Graph
Supertypes
trait Product
trait Equals
class Object
trait Matchable
class Any
case object NSCAttributesUnique extends NSError

Attributes

Source:
errors.scala
Graph
Supertypes
trait Singleton
trait Product
trait Mirror
trait Product
trait Equals
class NSError
class XmlError
class Object
trait Matchable
class Any
Self type
case object NSCNoPrefixUndeclaring extends NSError

Attributes

Source:
errors.scala
Graph
Supertypes
trait Singleton
trait Product
trait Mirror
trait Product
trait Equals
class NSError
class XmlError
class Object
trait Matchable
class Any
Self type
case object NSCPrefixDeclared extends NSError

Attributes

Source:
errors.scala
Graph
Supertypes
trait Singleton
trait Product
trait Mirror
trait Product
trait Equals
class NSError
class XmlError
class Object
trait Matchable
class Any
Self type
sealed abstract class NSError(name: String) extends XmlError

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

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

Attributes

Source:
errors.scala
Graph
Supertypes
class XmlError
class Object
trait Matchable
class Any
Known subtypes
object NSCPrefixDeclared.type
case class QName(prefix: Option[String], local: String)

Attributes

Companion:
object
Source:
QName.scala
Graph
Supertypes
trait Product
trait Equals
class Object
trait Matchable
class Any
object QName

Attributes

Companion:
class
Source:
QName.scala
Graph
Supertypes
trait Product
trait Mirror
class Object
trait Matchable
class Any
Self type
QName.type
case object WFCElementTypeMatch extends WFError

Attributes

Source:
errors.scala
Graph
Supertypes
trait Singleton
trait Product
trait Mirror
trait Product
trait Equals
class WFError
class XmlError
class Object
trait Matchable
class Any
Self type
case object WFCEntityDeclared extends WFError

Attributes

Source:
errors.scala
Graph
Supertypes
trait Singleton
trait Product
trait Mirror
trait Product
trait Equals
class WFError
class XmlError
class Object
trait Matchable
class Any
Self type
case object WFCNoRecursion extends WFError

Attributes

Source:
errors.scala
Graph
Supertypes
trait Singleton
trait Product
trait Mirror
trait Product
trait Equals
class WFError
class XmlError
class Object
trait Matchable
class Any
Self type
sealed abstract class WFError(name: String) extends XmlError

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

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

Attributes

Source:
errors.scala
Graph
Supertypes
class XmlError
class Object
trait Matchable
class Any
Known subtypes
object WFCEntityDeclared.type
object WFCNoRecursion.type
abstract class XmlError(val name: String)

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

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

Attributes

Source:
errors.scala
Graph
Supertypes
class Object
trait Matchable
class Any
Known subtypes
class NSError
object NSCPrefixDeclared.type
class WFError
object WFCEntityDeclared.type
object WFCNoRecursion.type
class XmlSyntax
sealed trait XmlEvent

Attributes

Companion:
object
Source:
XmlEvent.scala
Graph
Supertypes
class Object
trait Matchable
class Any
Known subtypes
class Comment
object EndDocument.type
class EndTag
object StartDocument.type
class StartTag
class XmlDecl
class XmlPI
trait XmlTexty
class XmlString
object XmlEvent

Attributes

Companion:
trait
Source:
XmlEvent.scala
Graph
Supertypes
trait Sum
trait Mirror
class Object
trait Matchable
class Any
Self type
case class XmlException(error: XmlError, msg: String) extends Exception

Attributes

Source:
XmlException.scala
Graph
Supertypes
trait Product
trait Equals
class Exception
class Throwable
class Object
trait Matchable
class Any
final implicit class XmlInterpolators(val sc: StringContext) extends AnyVal

Attributes

Source:
package.scala
Graph
Supertypes
class AnyVal
trait Matchable
class Any
case class XmlSyntax(id: String) extends XmlError

Represents a syntax error according to an XML production rule.

Represents a syntax error according to an XML production rule.

Attributes

Source:
errors.scala
Graph
Supertypes
trait Product
trait Equals
class XmlError
class Object
trait Matchable
class Any
object collector

XML event stream collectors.

XML event stream collectors.

Attributes

Source:
package.scala
Graph
Supertypes
class Object
trait Matchable
class Any
Self type

Value members

Concrete methods

def events[F[_], T](includeComments: Boolean)(implicit F: RaiseThrowable[F], T: CharLikeChunks[F, T]): (F, T) => XmlEvent

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.

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.

Attributes

Source:
package.scala
def isNCNameChar(c: Char): Boolean

Attributes

Source:
package.scala
def isNCNameStart(c: Char): Boolean

Attributes

Source:
package.scala
def isXmlWhitespace(c: Char): Boolean

Attributes

Source:
package.scala
def namespaceResolver[F[_]](implicit F: MonadError[F, Throwable]): (F, XmlEvent) => XmlEvent

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).

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).

Attributes

Source:
package.scala
def normalize[F[_]]: (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.

Attributes

Source:
package.scala
def referenceResolver[F[_]](entities: Map[String, String])(implicit F: MonadError[F, Throwable]): (F, XmlEvent) => XmlEvent

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.

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.

Attributes

Source:
package.scala
def render[F[_]](collapseEmpty: Boolean): (F, XmlEvent) => String

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 if collapseEmpty is true. Preserves chunking, each String in the output will correspond to one event in the input.

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 if collapseEmpty is true. Preserves chunking, each String in the output will correspond to one event in the input.

Attributes

Source:
package.scala

Deprecated methods

def events[F[_], T](implicit F: RaiseThrowable[F], T: CharLikeChunks[F, T]): (F, T) => XmlEvent

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.

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.

Attributes

Deprecated
[Since version fs2-data 1.4.0] Use `fs2.data.xml.events()` instead.
Source:
package.scala

Concrete fields

val ncNameChar: CharRanges

Attributes

Source:
package.scala
val ncNameStart: CharRanges

Attributes

Source:
package.scala
val xmlEntities: Map[String, String]

The predefined XML character entities

The predefined XML character entities

Attributes

Source:
package.scala

Implicits

Implicits

final implicit def XmlInterpolators(sc: StringContext): XmlInterpolators

Attributes

Source:
package.scala
Generated with