declslides.rendering

Members list

Type members

Classlikes

Production renderer registry shipped with DeclSlides.

Production renderer registry shipped with DeclSlides.

This registry exposes the renderers available out of the box.

Attributes

Supertypes
class Object
trait Matchable
class Any
Self type
final case class Document(target: RenderFormat, content: Body)

Rendered document produced by a renderer.

Rendered document produced by a renderer.

Value parameters

content

serialized document body

target

format used to render the document

Attributes

Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
final case class RenderFormat(label: String, fileExtension: FileExtension, acceptedInputs: Set[String])

Rendering target metadata understood by the rendering layer.

Rendering target metadata understood by the rendering layer.

A RenderFormat describes how a renderer is addressed by users and what file extension it naturally produces.

Value parameters

acceptedInputs

raw labels accepted when parsing a user request

fileExtension

default file extension produced by the renderer

label

canonical label for the format

Attributes

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

Component that turns a validated declslides.domain.Presentation into a Document.

Component that turns a validated declslides.domain.Presentation into a Document.

Attributes

Supertypes
class Object
trait Matchable
class Any
Known subtypes

Registry of available renderers.

Registry of available renderers.

A renderer registry is responsible for three small but important tasks: listing renderers, resolving a renderer from a concrete target, and parsing a raw format label into a known rendering target.

Attributes

Companion
object
Supertypes
class Object
trait Matchable
class Any

Attributes

Companion
trait
Supertypes
class Object
trait Matchable
class Any
Self type

Types

type Body = String
type FileExtension = String