lspace
.
services
.
rest
.
endpoints
LibrarianApi
Related Docs:
object LibrarianApi
|
package endpoints
trait
LibrarianApi
extends
ExecutionApi
Linear Supertypes
ExecutionApi
,
Api
,
EndpointModule
[
IO
],
AnyRef
,
Any
Ordering
Alphabetic
By Inheritance
Inherited
LibrarianApi
ExecutionApi
Api
EndpointModule
AnyRef
Any
Hide All
Show All
Visibility
Public
All
Type Members
abstract
type
Json
Abstract Value Members
implicit abstract
def
activeContext
:
ActiveContext
implicit abstract
def
baseDecoder
:
Aux
[
Json
]
implicit abstract
def
baseEncoder
:
Aux
[
Json
]
abstract
def
graph
:
Graph
Concrete 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
ask
:
Endpoint
[
IO
,
Boolean
]
Definition Classes
LibrarianApi
→
ExecutionApi
def
binaryBody
(
implicit
F:
Sync
[
IO
]
)
:
Endpoint
[
IO
,
Array
[
Byte
]]
Definition Classes
EndpointModule
def
binaryBodyOption
(
implicit
F:
Sync
[
IO
]
)
:
Endpoint
[
IO
,
Option
[
Array
[
Byte
]]]
Definition Classes
EndpointModule
def
binaryBodyStream
[
S
[
_
[
_
]
,
_
]
]
(
implicit
F:
Sync
[
IO
]
,
LR:
LiftReader
[
S
,
IO
]
)
:
Endpoint
[
IO
,
S
[
IO
,
Array
[
Byte
]]]
Definition Classes
EndpointModule
def
body
[
A
,
CT
]
(
implicit
arg0:
ClassTag
[
A
]
,
D:
Dispatchable
[
A
,
CT
]
,
F:
Sync
[
IO
]
)
:
Endpoint
[
IO
,
A
]
Definition Classes
EndpointModule
def
bodyOption
[
A
,
CT
]
(
implicit
arg0:
ClassTag
[
A
]
,
F:
Sync
[
IO
]
,
D:
Dispatchable
[
A
,
CT
]
)
:
Endpoint
[
IO
,
Option
[
A
]]
Definition Classes
EndpointModule
def
bodyStream
[
S
[
_
[
_
]
,
_
]
,
A
,
CT <:
String
]
(
implicit
F:
Sync
[
IO
]
,
LR:
LiftReader
[
S
,
IO
]
,
A:
Aux
[
S
,
IO
,
A
,
CT
]
)
:
Endpoint
[
IO
,
S
[
IO
,
A
]]
Definition Classes
EndpointModule
def
classpathAsset
(
path:
String
)
(
implicit
F:
Sync
[
IO
]
,
S:
ContextShift
[
IO
]
)
:
Endpoint
[
IO
,
Buf
]
Definition Classes
EndpointModule
def
clone
()
:
AnyRef
Attributes
protected[
java.lang
]
Definition Classes
AnyRef
Annotations
@throws
(
...
)
def
compiled
:
Compiled
[
IO
]
def
const
[
A
]
(
a:
A
)
(
implicit
F:
Applicative
[
IO
]
)
:
Endpoint
[
IO
,
A
]
Definition Classes
EndpointModule
def
cookie
(
name:
String
)
(
implicit
F:
Sync
[
IO
]
)
:
Endpoint
[
IO
,
Cookie
]
Definition Classes
EndpointModule
def
cookieOption
(
name:
String
)
(
implicit
F:
Sync
[
IO
]
)
:
Endpoint
[
IO
,
Option
[
Cookie
]]
Definition Classes
EndpointModule
implicit
lazy val
decoder
:
Aux
[
Json
]
def
delete
[
A
]
(
e:
Endpoint
[
IO
,
A
]
)
:
Mappable
[
IO
,
A
]
Definition Classes
EndpointModule
def
empty
[
A
]
:
Endpoint
[
IO
,
A
]
Definition Classes
EndpointModule
implicit
lazy val
encoder
:
Encoder
final
def
eq
(
arg0:
AnyRef
)
:
Boolean
Definition Classes
AnyRef
def
equals
(
arg0:
Any
)
:
Boolean
Definition Classes
AnyRef → Any
def
filesystemAsset
(
path:
String
)
(
implicit
F:
Sync
[
IO
]
,
S:
ContextShift
[
IO
]
)
:
Endpoint
[
IO
,
Buf
]
Definition Classes
EndpointModule
def
finalize
()
:
Unit
Attributes
protected[
java.lang
]
Definition Classes
AnyRef
Annotations
@throws
(
classOf[java.lang.Throwable]
)
def
fromFile
(
file:
File
)
(
implicit
F:
Sync
[
IO
]
,
S:
ContextShift
[
IO
]
)
:
Endpoint
[
IO
,
Buf
]
Definition Classes
EndpointModule
def
fromInputStream
(
stream:
cats.effect.Resource
[
IO
,
InputStream
]
)
(
implicit
F:
Sync
[
IO
]
,
S:
ContextShift
[
IO
]
)
:
Endpoint
[
IO
,
Buf
]
Definition Classes
EndpointModule
def
get
[
A
]
(
e:
Endpoint
[
IO
,
A
]
)
:
Mappable
[
IO
,
A
]
Definition Classes
EndpointModule
final
def
getClass
()
:
Class
[_]
Definition Classes
AnyRef → Any
def
hashCode
()
:
Int
Definition Classes
AnyRef → Any
def
head
[
A
]
(
e:
Endpoint
[
IO
,
A
]
)
:
Mappable
[
IO
,
A
]
Definition Classes
EndpointModule
def
header
[
A
]
(
name:
String
)
(
implicit
arg0:
DecodeEntity
[
A
]
,
arg1:
ClassTag
[
A
]
,
F:
Sync
[
IO
]
)
:
Endpoint
[
IO
,
A
]
Definition Classes
EndpointModule
def
headerOption
[
A
]
(
name:
String
)
(
implicit
arg0:
DecodeEntity
[
A
]
,
arg1:
ClassTag
[
A
]
,
F:
Sync
[
IO
]
)
:
Endpoint
[
IO
,
Option
[
A
]]
Definition Classes
EndpointModule
final
def
isInstanceOf
[
T0
]
:
Boolean
Definition Classes
Any
def
jsonBody
[
A
]
(
implicit
arg0:
io.finch.Decode.Json
[
A
]
,
arg1:
ClassTag
[
A
]
,
F:
Sync
[
IO
]
)
:
Endpoint
[
IO
,
A
]
Definition Classes
EndpointModule
def
jsonBodyOption
[
A
]
(
implicit
arg0:
io.finch.Decode.Json
[
A
]
,
arg1:
ClassTag
[
A
]
,
F:
Sync
[
IO
]
)
:
Endpoint
[
IO
,
Option
[
A
]]
Definition Classes
EndpointModule
def
jsonBodyStream
[
S
[
_
[
_
]
,
_
]
,
A
]
(
implicit
F:
Sync
[
IO
]
,
LR:
LiftReader
[
S
,
IO
]
,
A:
Aux
[
S
,
IO
,
A
,
io.finch.Application.Json
]
)
:
Endpoint
[
IO
,
S
[
IO
,
A
]]
Definition Classes
EndpointModule
def
lift
[
A
]
(
a: ⇒
A
)
(
implicit
F:
Sync
[
IO
]
)
:
Endpoint
[
IO
,
A
]
Definition Classes
EndpointModule
def
liftAsync
[
A
]
(
fa: ⇒
IO
[
A
]
)
(
implicit
F:
Sync
[
IO
]
)
:
Endpoint
[
IO
,
A
]
Definition Classes
EndpointModule
def
liftOutput
[
A
]
(
oa: ⇒
Output
[
A
]
)
(
implicit
F:
Sync
[
IO
]
)
:
Endpoint
[
IO
,
A
]
Definition Classes
EndpointModule
def
liftOutputAsync
[
A
]
(
foa: ⇒
IO
[
Output
[
A
]]
)
(
implicit
F:
Sync
[
IO
]
)
:
Endpoint
[
IO
,
A
]
Definition Classes
EndpointModule
def
multipartAttribute
[
A
]
(
name:
String
)
(
implicit
arg0:
DecodeEntity
[
A
]
,
arg1:
ClassTag
[
A
]
,
F:
Sync
[
IO
]
)
:
Endpoint
[
IO
,
A
]
Definition Classes
EndpointModule
def
multipartAttributeOption
[
A
]
(
name:
String
)
(
implicit
arg0:
DecodeEntity
[
A
]
,
arg1:
ClassTag
[
A
]
,
F:
Sync
[
IO
]
)
:
Endpoint
[
IO
,
Option
[
A
]]
Definition Classes
EndpointModule
def
multipartAttributes
[
A
]
(
name:
String
)
(
implicit
arg0:
DecodeEntity
[
A
]
,
arg1:
ClassTag
[
A
]
,
F:
Sync
[
IO
]
)
:
Endpoint
[
IO
,
List
[
A
]]
Definition Classes
EndpointModule
def
multipartAttributesNel
[
A
]
(
name:
String
)
(
implicit
arg0:
DecodeEntity
[
A
]
,
arg1:
ClassTag
[
A
]
,
F:
Sync
[
IO
]
)
:
Endpoint
[
IO
,
NonEmptyList
[
A
]]
Definition Classes
EndpointModule
def
multipartFileUpload
(
name:
String
)
(
implicit
F:
Sync
[
IO
]
)
:
Endpoint
[
IO
,
FileUpload
]
Definition Classes
EndpointModule
def
multipartFileUploadOption
(
name:
String
)
(
implicit
F:
Sync
[
IO
]
)
:
Endpoint
[
IO
,
Option
[
FileUpload
]]
Definition Classes
EndpointModule
def
multipartFileUploads
(
name:
String
)
(
implicit
F:
Sync
[
IO
]
)
:
Endpoint
[
IO
,
List
[
FileUpload
]]
Definition Classes
EndpointModule
def
multipartFileUploadsNel
(
name:
String
)
(
implicit
F:
Sync
[
IO
]
)
:
Endpoint
[
IO
,
NonEmptyList
[
FileUpload
]]
Definition Classes
EndpointModule
def
mutate
:
Endpoint
[
IO
,
Unit
]
Definition Classes
LibrarianApi
→
ExecutionApi
final
def
ne
(
arg0:
AnyRef
)
:
Boolean
Definition Classes
AnyRef
final
def
notify
()
:
Unit
Definition Classes
AnyRef
final
def
notifyAll
()
:
Unit
Definition Classes
AnyRef
def
options
[
A
]
(
e:
Endpoint
[
IO
,
A
]
)
:
Mappable
[
IO
,
A
]
Definition Classes
EndpointModule
def
param
[
A
]
(
name:
String
)
(
implicit
arg0:
DecodeEntity
[
A
]
,
arg1:
ClassTag
[
A
]
,
F:
Sync
[
IO
]
)
:
Endpoint
[
IO
,
A
]
Definition Classes
EndpointModule
def
paramOption
[
A
]
(
name:
String
)
(
implicit
arg0:
DecodeEntity
[
A
]
,
arg1:
ClassTag
[
A
]
,
F:
Sync
[
IO
]
)
:
Endpoint
[
IO
,
Option
[
A
]]
Definition Classes
EndpointModule
def
params
[
A
]
(
name:
String
)
(
implicit
arg0:
DecodeEntity
[
A
]
,
arg1:
ClassTag
[
A
]
,
F:
Sync
[
IO
]
)
:
Endpoint
[
IO
,
List
[
A
]]
Definition Classes
EndpointModule
def
paramsNel
[
A
]
(
name:
String
)
(
implicit
arg0:
DecodeEntity
[
A
]
,
arg1:
ClassTag
[
A
]
,
F:
Sync
[
IO
]
)
:
Endpoint
[
IO
,
NonEmptyList
[
A
]]
Definition Classes
EndpointModule
def
patch
[
A
]
(
e:
Endpoint
[
IO
,
A
]
)
:
Mappable
[
IO
,
A
]
Definition Classes
EndpointModule
implicit
def
path
(
s:
String
)
(
implicit
F:
Sync
[
IO
]
)
:
Endpoint
[
IO
,
HNil
]
Definition Classes
EndpointModule
def
path
[
A
]
(
implicit
arg0:
DecodePath
[
A
]
,
arg1:
ClassTag
[
A
]
,
F:
Sync
[
IO
]
)
:
Endpoint
[
IO
,
A
]
Definition Classes
EndpointModule
def
pathAny
(
implicit
F:
Applicative
[
IO
]
)
:
Endpoint
[
IO
,
HNil
]
Definition Classes
EndpointModule
def
pathEmpty
(
implicit
F:
Applicative
[
IO
]
)
:
Endpoint
[
IO
,
HNil
]
Definition Classes
EndpointModule
def
paths
[
A
]
(
implicit
arg0:
DecodePath
[
A
]
,
arg1:
ClassTag
[
A
]
,
F:
Sync
[
IO
]
)
:
Endpoint
[
IO
,
List
[
A
]]
Definition Classes
EndpointModule
def
post
[
A
]
(
e:
Endpoint
[
IO
,
A
]
)
:
Mappable
[
IO
,
A
]
Definition Classes
EndpointModule
def
put
[
A
]
(
e:
Endpoint
[
IO
,
A
]
)
:
Mappable
[
IO
,
A
]
Definition Classes
EndpointModule
def
query
:
Endpoint
[
IO
,
ContextedT
[
Collection
[
Any
,
ClassType
[
Any
]]]]
Definition Classes
LibrarianApi
→
ExecutionApi
def
raw
:
Endpoint
[
IO
,
:+:
[
ContextedT
[
Collection
[
Any
,
structure.ClassType
[
Any
]]],
:+:
[
Stream
[
IO
,
ContextedT
[
Collection
[
Any
,
structure.ClassType
[
Any
]]]],
CNil
]]]
def
root
(
implicit
F:
Sync
[
IO
]
)
:
Endpoint
[
IO
,
Request
]
Definition Classes
EndpointModule
def
streamingQuery
:
Endpoint
[
IO
,
Stream
[
IO
,
ContextedT
[
Collection
[
Any
,
ClassType
[
Any
]]]]]
def
stringBody
(
implicit
F:
Sync
[
IO
]
)
:
Endpoint
[
IO
,
String
]
Definition Classes
EndpointModule
def
stringBodyOption
(
implicit
F:
Sync
[
IO
]
)
:
Endpoint
[
IO
,
Option
[
String
]]
Definition Classes
EndpointModule
def
stringBodyStream
[
S
[
_
[
_
]
,
_
]
]
(
implicit
F:
Sync
[
IO
]
,
LR:
LiftReader
[
S
,
IO
]
)
:
Endpoint
[
IO
,
S
[
IO
,
String
]]
Definition Classes
EndpointModule
def
subscribe
:
Endpoint
[
IO
,
List
[
Node
]]
Definition Classes
LibrarianApi
→
ExecutionApi
final
def
synchronized
[
T0
]
(
arg0: ⇒
T0
)
:
T0
Definition Classes
AnyRef
def
textBody
[
A
]
(
implicit
arg0:
Text
[
A
]
,
arg1:
ClassTag
[
A
]
,
F:
Sync
[
IO
]
)
:
Endpoint
[
IO
,
A
]
Definition Classes
EndpointModule
def
textBodyOption
[
A
]
(
implicit
arg0:
Text
[
A
]
,
arg1:
ClassTag
[
A
]
,
F:
Sync
[
IO
]
)
:
Endpoint
[
IO
,
Option
[
A
]]
Definition Classes
EndpointModule
def
textBodyStream
[
S
[
_
[
_
]
,
_
]
,
A
]
(
implicit
F:
Sync
[
IO
]
,
LR:
LiftReader
[
S
,
IO
]
,
A:
Aux
[
S
,
IO
,
A
,
Plain
]
)
:
Endpoint
[
IO
,
S
[
IO
,
A
]]
Definition Classes
EndpointModule
def
toString
()
:
String
Definition Classes
AnyRef → Any
def
trace
[
A
]
(
e:
Endpoint
[
IO
,
A
]
)
:
Mappable
[
IO
,
A
]
Definition Classes
EndpointModule
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
(
...
)
def
zero
(
implicit
F:
Applicative
[
IO
]
)
:
Endpoint
[
IO
,
HNil
]
Definition Classes
EndpointModule
Inherited from
ExecutionApi
Inherited from
Api
Inherited from
EndpointModule
[
IO
]
Inherited from
AnyRef
Inherited from
Any
Ungrouped