trait TapirStaticContentEndpoints extends AnyRef
Static content endpoints, including files and resources.
- Alphabetic
- By Inheritance
- TapirStaticContentEndpoints
- AnyRef
- Any
- Hide All
- Show All
- Public
- Protected
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
- final def asInstanceOf[T0]: T0
- Definition Classes
- Any
- def clone(): AnyRef
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.CloneNotSupportedException]) @native() @HotSpotIntrinsicCandidate()
- final def eq(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
- def equals(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef → Any
- def fileGetServerEndpoint[F[_]](path: EndpointInput[Unit])(systemPath: String): ServerEndpoint[Any, F]
A server endpoint, which exposes a single file from local storage found at
systemPath
, using the givenpath
.A server endpoint, which exposes a single file from local storage found at
systemPath
, using the givenpath
.fileGetServerEndpoint("static" / "hello.html")("/home/app/static/data.html")
- def fileServerEndpoints[F[_]](prefix: EndpointInput[Unit])(systemPath: String): List[ServerEndpoint[Any, F]]
Create pair of endpoints (head, get) for particular file
- def filesGetEndpoint(prefix: EndpointInput[Unit]): PublicEndpoint[StaticInput, StaticErrorOutput, StaticOutput[FileRange], Any]
- def filesGetServerEndpoint[F[_]](prefix: EndpointInput[Unit])(systemPath: String): ServerEndpoint[Any, F]
A server endpoint, which exposes files from local storage found at
systemPath
, using the givenprefix
.A server endpoint, which exposes files from local storage found at
systemPath
, using the givenprefix
. Typically, the prefix is a path, but it can also contain other inputs. For example:filesGetServerEndpoint("static" / "files")("/home/app/static")
A request to
/static/files/css/styles.css
will try to read the/home/app/static/css/styles.css
file. - def filesHeadServerEndpoint[F[_]](prefix: EndpointInput[Unit])(systemPath: String): ServerEndpoint[Any, F]
A server endpoint, used to verify if sever supports range requests for file under particular path Additionally it verify file existence and returns its size
- final def getClass(): Class[_ <: AnyRef]
- Definition Classes
- AnyRef → Any
- Annotations
- @native() @HotSpotIntrinsicCandidate()
- def hashCode(): Int
- Definition Classes
- AnyRef → Any
- Annotations
- @native() @HotSpotIntrinsicCandidate()
- 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() @HotSpotIntrinsicCandidate()
- final def notifyAll(): Unit
- Definition Classes
- AnyRef
- Annotations
- @native() @HotSpotIntrinsicCandidate()
- def resourceGetServerEndpoint[F[_]](prefix: EndpointInput[Unit])(classLoader: ClassLoader, resourcePath: String, useGzippedIfAvailable: Boolean = false): ServerEndpoint[Any, F]
A server endpoint, which exposes a single resource available from the given
classLoader
atresourcePath
, using the givenpath
.A server endpoint, which exposes a single resource available from the given
classLoader
atresourcePath
, using the givenpath
.resourceGetServerEndpoint("static" / "hello.html")(classOf[App].getClassLoader, "app/data.html")
- def resourcesGetEndpoint(prefix: EndpointInput[Unit]): PublicEndpoint[StaticInput, StaticErrorOutput, StaticOutput[InputStream], Any]
- def resourcesGetServerEndpoint[F[_]](prefix: EndpointInput[Unit])(classLoader: ClassLoader, resourcePrefix: String, useGzippedIfAvailable: Boolean = false): ServerEndpoint[Any, F]
A server endpoint, which exposes resources available from the given
classLoader
, using the givenprefix
.A server endpoint, which exposes resources available from the given
classLoader
, using the givenprefix
. Typically, the prefix is a path, but it can also contain other inputs. For example:resourcesGetServerEndpoint("static" / "files")(classOf[App].getClassLoader, "app")
A request to
/static/files/css/styles.css
will try to read the/app/css/styles.css
resource. - final def synchronized[T0](arg0: => T0): T0
- Definition Classes
- AnyRef
- def toString(): String
- Definition Classes
- AnyRef → Any
- final def wait(arg0: Long, arg1: Int): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException])
- final def wait(arg0: Long): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException]) @native()
- final def wait(): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException])
Deprecated Value Members
- def finalize(): Unit
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.Throwable]) @Deprecated
- Deprecated