tapir-core
API
Generated with
tapir-core/sttp.tapir/sttp.tapir.static

sttp.tapir.static

package sttp.tapir.static

Members list

Type members

Classlikes

object FilesOptions

Attributes

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

Attributes

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

Attributes

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

Attributes

Companion
trait
Supertypes
class Object
trait Matchable
class Any
Self type
HeadOutput.type
object ResourcesOptions

Attributes

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

Attributes

Companion
object
Supertypes
class Object
trait Matchable
class Any
Known subtypes
object BadRequest.type
object NotFound.type
object RangeNotSatisfiable.type
object StaticErrorOutput

Attributes

Companion
trait
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

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

Attributes

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

Attributes

Companion
trait
Supertypes
class Object
trait Matchable
class Any
Self type
trait TapirStaticContentEndpoints

Static content endpoints, including files and resources.

Static content endpoints, including files and resources.

Attributes

Supertypes
class Object
trait Matchable
class Any
Known subtypes
trait Tapir

Deprecated classlikes

object Files

Attributes

Deprecated
[Since version 1.3.0]
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]])

Value parameters

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.

Attributes

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

Attributes

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

Value parameters

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.

Attributes

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

Value members

Concrete methods

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