org.http4s.server.staticcontent.ResourceService

Config

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

Alphabetic
By Inheritance

Inherited

Config
Serializable
Serializable
Product
Equals
AnyRef
Any

Implicitly

by any2stringadd
by StringFormat
by Ensuring
by ArrowAssoc

Hide All
Show All

Visibility

Public
All

Instance Constructors

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

final def !=(arg0: Any): Boolean

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

Definition Classes
AnyRef → Any
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
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()
final def ==(arg0: Any): Boolean

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

Definition Classes
Any
val basePath: String
val blockingExecutionContext: ExecutionContext
val bufferSize: Int
val cacheStrategy: CacheStrategy[F]
def clone(): AnyRef

Attributes
protected[lang]
Definition Classes
AnyRef
Annotations
@throws( ... ) @native()
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
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
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
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
final def eq(arg0: AnyRef): Boolean

Definition Classes
AnyRef
def finalize(): Unit

Attributes
protected[lang]
Definition Classes
AnyRef
Annotations
@throws( classOf[java.lang.Throwable] )
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()
final def getClass(): Class[_]

Definition Classes
AnyRef → Any
Annotations
@native()
final def isInstanceOf[T0]: Boolean

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

Definition Classes
AnyRef
final def notify(): Unit

Definition Classes
AnyRef
Annotations
@native()
final def notifyAll(): Unit

Definition Classes
AnyRef
Annotations
@native()
val pathPrefix: String
val preferGzipped: Boolean
final def synchronized[T0](arg0: ⇒ T0): T0

Definition Classes
AnyRef
final def wait(): Unit

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

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

Definition Classes
AnyRef
Annotations
@throws( ... ) @native()
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 AnyRef

Value Members

final def !=(arg0: Any): Boolean

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

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

Definition Classes
AnyRef → Any
def clone(): AnyRef

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

Definition Classes
AnyRef
def finalize(): Unit

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

Definition Classes
AnyRef → Any
Annotations
@native()
final def ne(arg0: AnyRef): Boolean

Definition Classes
AnyRef
final def notify(): Unit

Definition Classes
AnyRef
Annotations
@native()
final def notifyAll(): Unit

Definition Classes
AnyRef
Annotations
@native()
final def synchronized[T0](arg0: ⇒ T0): T0

Definition Classes
AnyRef
final def wait(): Unit

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

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

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

Inherited from Any

Value Members

final def asInstanceOf[T0]: T0

Definition Classes
Any
final def isInstanceOf[T0]: Boolean

Definition Classes
Any

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

Value Members

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

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

Value Members

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

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

Value Members

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

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

Value Members

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

Ungrouped

final def !=(arg0: Any): Boolean

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

Definition Classes
AnyRef → Any
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
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()
final def ==(arg0: Any): Boolean

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

Definition Classes
Any
val basePath: String
val blockingExecutionContext: ExecutionContext
val bufferSize: Int
val cacheStrategy: CacheStrategy[F]
def clone(): AnyRef

Attributes
protected[lang]
Definition Classes
AnyRef
Annotations
@throws( ... ) @native()
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
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
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
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
final def eq(arg0: AnyRef): Boolean

Definition Classes
AnyRef
def finalize(): Unit

Attributes
protected[lang]
Definition Classes
AnyRef
Annotations
@throws( classOf[java.lang.Throwable] )
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()
final def getClass(): Class[_]

Definition Classes
AnyRef → Any
Annotations
@native()
final def isInstanceOf[T0]: Boolean

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

Definition Classes
AnyRef
final def notify(): Unit

Definition Classes
AnyRef
Annotations
@native()
final def notifyAll(): Unit

Definition Classes
AnyRef
Annotations
@native()
val pathPrefix: String
val preferGzipped: Boolean
final def synchronized[T0](arg0: ⇒ T0): T0

Definition Classes
AnyRef
final def wait(): Unit

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

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

Definition Classes
AnyRef
Annotations
@throws( ... ) @native()
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

Packages

Config 

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

Instance Constructors

Value Members

Inherited from AnyRef

Value Members

Inherited from Any

Value Members

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

Value Members

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

Value Members

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

Value Members

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

Value Members

Ungrouped

Config