sttp.tapir.static

Members list

Concise view

Type members

Classlikes

Attributes

Companion:
class
Graph
Supertypes
trait Product
trait Mirror
class Object
trait Matchable
class Any
Self type
case class HeadInput(path: List[String])

Attributes

Graph
Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any

Attributes

Companion:
object
Graph
Supertypes
class Object
trait Matchable
class Any
Known subtypes
class Found
object HeadOutput

Attributes

Companion:
trait
Graph
Supertypes
class Object
trait Matchable
class Any
Self type

Attributes

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

Attributes

Companion:
object
Graph
Supertypes
class Object
trait Matchable
class Any
Known subtypes
object BadRequest.type
object NotFound.type

Attributes

Companion:
trait
Graph
Supertypes
class Object
trait Matchable
class Any
Self type
case class StaticInput(path: List[String], ifNoneMatch: Option[List[ETag]], ifModifiedSince: Option[Instant], range: Option[Range], acceptEncoding: Option[String])

Attributes

Graph
Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
trait StaticOutput[+T]

Attributes

Companion:
object
Graph
Supertypes
class Object
trait Matchable
class Any
Known subtypes
class Found[T]
class FoundPartial[T]
object NotModified.type

Attributes

Companion:
trait
Graph
Supertypes
class Object
trait Matchable
class Any
Self type

Static content endpoints, including files and resources.

Static content endpoints, including files and resources.

Attributes

Graph
Supertypes
class Object
trait Matchable
class Any
Known subtypes
trait Tapir

Deprecated classlikes

object Files

Attributes

Deprecated
[Since version 1.3.0]
Graph
Supertypes
class Object
trait Matchable
class Any
Self type
Files.type
case class FilesOptions[F[_]](calculateETag: MonadError[F] => File => F[Option[ETag]], fileFilter: List[String] => Boolean, defaultFile: Option[List[String]])

Attributes

defaultFile

path segments (relative to the system path from which files are read) of the file to return in case the one requested by the user isn't found. This is useful for SPA apps, where the same main application file needs to be returned regardless of the path.

fileFilter

A file will be exposed only if this function returns true.

Companion:
object
Deprecated
[Since version 1.3.0]
Graph
Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
object Resources

Attributes

Deprecated
[Since version 1.3.0]
Graph
Supertypes
class Object
trait Matchable
class Any
Self type
case class ResourcesOptions[F[_]](useETags: Boolean, useGzippedIfAvailable: Boolean, resourceFilter: List[String] => Boolean, defaultResource: Option[List[String]])

Attributes

defaultResource

path segments (relative to the resource prefix from which resources are read) of the resource to return in case the one requested by the user isn't found. This is useful for SPA apps, where the same main application resource needs to be returned regardless of the path.

resourceFilter

A resource will be exposed only if this function returns true.

Companion:
object
Deprecated
[Since version 1.3.0]
Graph
Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any

Value members

Concrete methods

def defaultETag(lastModified: Long, length: Long): ETag