Packages

final case class Config[F[_]](basePath: String, blockingExecutionContext: ExecutionContext, pathPrefix: String = "", bufferSize: Int = 50 * 1024, cacheStrategy: CacheStrategy[F] = NoopCacheStrategy[F], preferGzipped: Boolean = false) extends Product with Serializable

org.http4s.server.staticcontent.ResourceService configuration

basePath

prefix of the path files will be served from

blockingExecutionContext

ExecutionContext to use when collecting content

pathPrefix

prefix of the Uri that content will be served from

bufferSize

size hint of internal buffers to use when serving resources

cacheStrategy

strategy to use for caching purposes. Default to no caching.

preferGzipped

whether to serve pre-gzipped files (with extension ".gz") if they exist

Source
ResourceService.scala
Linear Supertypes
Serializable, Serializable, Product, Equals, AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. Config
  2. Serializable
  3. Serializable
  4. Product
  5. Equals
  6. AnyRef
  7. Any
Implicitly
  1. by any2stringadd
  2. by StringFormat
  3. by Ensuring
  4. by ArrowAssoc
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Instance Constructors

  1. new Config(basePath: String, blockingExecutionContext: ExecutionContext, pathPrefix: String = "", bufferSize: Int = 50 * 1024, cacheStrategy: CacheStrategy[F] = NoopCacheStrategy[F], preferGzipped: Boolean = false)

    basePath

    prefix of the path files will be served from

    blockingExecutionContext

    ExecutionContext to use when collecting content

    pathPrefix

    prefix of the Uri that content will be served from

    bufferSize

    size hint of internal buffers to use when serving resources

    cacheStrategy

    strategy to use for caching purposes. Default to no caching.

    preferGzipped

    whether to serve pre-gzipped files (with extension ".gz") if they exist

Value Members

  1. final def !=(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  2. final def ##(): Int
    Definition Classes
    AnyRef → Any
  3. def +(other: String): String
    Implicit
    This member is added by an implicit conversion from Config[F] to any2stringadd[Config[F]] performed by method any2stringadd in scala.Predef.
    Definition Classes
    any2stringadd
  4. def ->[B](y: B): (Config[F], B)
    Implicit
    This member is added by an implicit conversion from Config[F] to ArrowAssoc[Config[F]] performed by method ArrowAssoc in scala.Predef.
    Definition Classes
    ArrowAssoc
    Annotations
    @inline()
  5. final def ==(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  6. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  7. val basePath: String
  8. val blockingExecutionContext: ExecutionContext
  9. val bufferSize: Int
  10. val cacheStrategy: CacheStrategy[F]
  11. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... ) @native()
  12. def ensuring(cond: (Config[F]) ⇒ Boolean, msg: ⇒ Any): Config[F]
    Implicit
    This member is added by an implicit conversion from Config[F] to Ensuring[Config[F]] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  13. def ensuring(cond: (Config[F]) ⇒ Boolean): Config[F]
    Implicit
    This member is added by an implicit conversion from Config[F] to Ensuring[Config[F]] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  14. def ensuring(cond: Boolean, msg: ⇒ Any): Config[F]
    Implicit
    This member is added by an implicit conversion from Config[F] to Ensuring[Config[F]] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  15. def ensuring(cond: Boolean): Config[F]
    Implicit
    This member is added by an implicit conversion from Config[F] to Ensuring[Config[F]] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  16. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  17. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  18. def formatted(fmtstr: String): String
    Implicit
    This member is added by an implicit conversion from Config[F] to StringFormat[Config[F]] performed by method StringFormat in scala.Predef.
    Definition Classes
    StringFormat
    Annotations
    @inline()
  19. final def getClass(): Class[_]
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  20. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  21. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  22. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  23. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  24. val pathPrefix: String
  25. val preferGzipped: Boolean
  26. final def synchronized[T0](arg0: ⇒ T0): T0
    Definition Classes
    AnyRef
  27. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  28. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  29. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... ) @native()
  30. def →[B](y: B): (Config[F], B)
    Implicit
    This member is added by an implicit conversion from Config[F] to ArrowAssoc[Config[F]] performed by method ArrowAssoc in scala.Predef.
    Definition Classes
    ArrowAssoc

Inherited from Serializable

Inherited from Serializable

Inherited from Product

Inherited from Equals

Inherited from AnyRef

Inherited from Any

Inherited by implicit conversion any2stringadd from Config[F] to any2stringadd[Config[F]]

Inherited by implicit conversion StringFormat from Config[F] to StringFormat[Config[F]]

Inherited by implicit conversion Ensuring from Config[F] to Ensuring[Config[F]]

Inherited by implicit conversion ArrowAssoc from Config[F] to ArrowAssoc[Config[F]]

Ungrouped