Class

org.http4s.server.staticcontent.ResourceService

Config

Related Doc: package ResourceService

Permalink

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

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

    Permalink

    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

    Permalink
    Definition Classes
    AnyRef → Any
  2. final def ##(): Int

    Permalink
    Definition Classes
    AnyRef → Any
  3. final def ==(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any
  4. final def asInstanceOf[T0]: T0

    Permalink
    Definition Classes
    Any
  5. val basePath: String

    Permalink

    prefix of the path files will be served from

  6. val blockingExecutionContext: ExecutionContext

    Permalink

    ExecutionContext to use when collecting content

  7. val bufferSize: Int

    Permalink

    size hint of internal buffers to use when serving resources

  8. val cacheStrategy: CacheStrategy[F]

    Permalink

    strategy to use for caching purposes.

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

  9. def clone(): AnyRef

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  10. final def eq(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef
  11. def finalize(): Unit

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  12. final def getClass(): Class[_]

    Permalink
    Definition Classes
    AnyRef → Any
  13. final def isInstanceOf[T0]: Boolean

    Permalink
    Definition Classes
    Any
  14. final def ne(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef
  15. final def notify(): Unit

    Permalink
    Definition Classes
    AnyRef
  16. final def notifyAll(): Unit

    Permalink
    Definition Classes
    AnyRef
  17. val pathPrefix: String

    Permalink

    prefix of the Uri that content will be served from

  18. val preferGzipped: Boolean

    Permalink

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

  19. final def synchronized[T0](arg0: ⇒ T0): T0

    Permalink
    Definition Classes
    AnyRef
  20. final def wait(): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  21. final def wait(arg0: Long, arg1: Int): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  22. final def wait(arg0: Long): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

Inherited from Serializable

Inherited from Serializable

Inherited from Product

Inherited from Equals

Inherited from AnyRef

Inherited from Any

Ungrouped