Packages

final case class Config(systemPath: String, pathPrefix: String = "", pathCollector: (File, Config, Request) ⇒ Task[Option[Response]] = defaultFileCollector, bufferSize: Int = 50*1024, executor: ExecutorService = DefaultPool, cacheStrategy: CacheStrategy = NoopCacheStrategy) extends Product with Serializable

org.http4s.server.staticcontent.FileService configuration

systemPath

path prefix to the folder from which content will be served

pathPrefix

prefix of Uri from which content will be served

pathCollector

function that performs the work of collecting the file or rendering the directory into a response.

bufferSize

buffer size to use for internal read buffers

executor

ExecutorService to use when collecting content

cacheStrategy

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

Source
FileService.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(systemPath: String, pathPrefix: String = "", pathCollector: (File, Config, Request) ⇒ Task[Option[Response]] = defaultFileCollector, bufferSize: Int = 50*1024, executor: ExecutorService = DefaultPool, cacheStrategy: CacheStrategy = NoopCacheStrategy)

    systemPath

    path prefix to the folder from which content will be served

    pathPrefix

    prefix of Uri from which content will be served

    pathCollector

    function that performs the work of collecting the file or rendering the directory into a response.

    bufferSize

    buffer size to use for internal read buffers

    executor

    ExecutorService to use when collecting content

    cacheStrategy

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

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 to any2stringadd[Config] performed by method any2stringadd in scala.Predef.
    Definition Classes
    any2stringadd
  4. def ->[B](y: B): (Config, B)
    Implicit
    This member is added by an implicit conversion from Config to ArrowAssoc[Config] 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 bufferSize: Int
  8. val cacheStrategy: CacheStrategy
  9. def clone(): AnyRef
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @native() @throws( ... )
  10. def ensuring(cond: (Config) ⇒ Boolean, msg: ⇒ Any): Config
    Implicit
    This member is added by an implicit conversion from Config to Ensuring[Config] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  11. def ensuring(cond: (Config) ⇒ Boolean): Config
    Implicit
    This member is added by an implicit conversion from Config to Ensuring[Config] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  12. def ensuring(cond: Boolean, msg: ⇒ Any): Config
    Implicit
    This member is added by an implicit conversion from Config to Ensuring[Config] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  13. def ensuring(cond: Boolean): Config
    Implicit
    This member is added by an implicit conversion from Config to Ensuring[Config] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  14. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  15. val executor: ExecutorService
  16. def finalize(): Unit
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  17. def formatted(fmtstr: String): String
    Implicit
    This member is added by an implicit conversion from Config to StringFormat[Config] performed by method StringFormat in scala.Predef.
    Definition Classes
    StringFormat
    Annotations
    @inline()
  18. final def getClass(): Class[_]
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  19. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  20. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  21. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  22. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  23. val pathCollector: (File, Config, Request) ⇒ Task[Option[Response]]
  24. val pathPrefix: String
  25. final def synchronized[T0](arg0: ⇒ T0): T0
    Definition Classes
    AnyRef
  26. val systemPath: String
  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
    @native() @throws( ... )
  30. def →[B](y: B): (Config, B)
    Implicit
    This member is added by an implicit conversion from Config to ArrowAssoc[Config] 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 to any2stringadd[Config]

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

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

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

Ungrouped