RawRest

Type Members

type AsRawRealRpc[Real] = AsRawReal[RawRest, Real]

Definition Classes
RawRpcCompanion
type AsRawRpc[Real] = AsRaw[RawRest, Real]

Definition Classes
RawRpcCompanion
type AsRealRpc[Real] = AsReal[RawRest, Real]

Definition Classes
RawRpcCompanion
type Async[T] = (Callback[T]) ⇒ Unit

The most low-level, raw type representing an asynchronous, possibly side-effecting operation that yields a value of type T as a result.
The most low-level, raw type representing an asynchronous, possibly side-effecting operation that yields a value of type T as a result. Async is a consumer of a callback. When a callback is passed to Async, it should start the operation and ultimately notify the callback about the result. Each time the callback is passed, the entire operation should be repeated, involving all possible side effects. Operation should never be started without the callback being passed (i.e. there should be no observable side effects before a callback is passed). Implementation of Async should also be prepared to accept a callback before the previous one was notified about the result (i.e. it should support concurrent execution).
trait AsyncEffect[F[_]] extends AnyRef

Typeclass which captures the fact that some effect type constructor represents asynchronous computation and can be converted to RawRest.Async.
Typeclass which captures the fact that some effect type constructor represents asynchronous computation and can be converted to RawRest.Async.

Annotations
@implicitNotFound( ... )
type Callback[T] = (com.avsystem.commons.Try[T]) ⇒ Unit

A callback that gets notified when value of type T gets computed or when computation of that value fails.
A callback that gets notified when value of type T gets computed or when computation of that value fails. Callbacks should never throw exceptions. Preferably, they should be simple notifiers that delegate the real work somewhere else, e.g. schedule some handling code on a separate executor (e.g. ExecutionContext).
type HandleRequest = (RestRequest) ⇒ Async[RestResponse]

Raw type of an operation that executes a RestRequest.
Raw type of an operation that executes a RestRequest. The operation should be run every time the resulting Async value is passed a callback. It should not be run before that. Each run may involve side effects, network communication, etc. Runs may be concurrent. Request handlers should never throw exceptions but rather convert them into failing implementation of Async. One way to do this is by wrapping the handler with safeHandle.
type HandleResolvedRequest = (RestRequest, ResolvedCall) ⇒ Async[RestResponse]

Similar to HandleRequest but accepts already resolved path as a second argument.

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
object AsyncEffect
final val GetMethodBodyParam: String("GET methods cannot take @Body parameters")
final val InvalidTraitMessage: String("result type ${T} is not a valid REST API trait, does it have a properly defined companion object?")
final val MissingBodyParam: String("expected exactly one @Body parameter but none was found")
final val NotValidCustomBodyMethod: String("it cannot be translated into an HTTP method with custom body")
final val NotValidFormBodyMethod: String("it cannot be translated into an HTTP method with form body")
final val NotValidGetMethod: String("it cannot be translated into an HTTP GET method")
final val NotValidHttpMethod: String("it cannot be translated into an HTTP method")
final val NotValidPrefixMethod: String("it cannot be translated into a prefix method")
final val PrefixMethodBodyParam: String("prefix methods cannot take @Body parameters")
final val SuperfluousBodyParam: String("expected exactly one @Body parameter but more than one was found")
def asHandleRequest[Real](real: Real)(implicit arg0: AsRawRpc[Real], arg1: RestMetadata[Real]): HandleRequest
final def asInstanceOf[T0]: T0

Definition Classes
Any
def asRaw[Real](real: Real)(implicit asRawRpc: AsRawRpc[Real]): RawRest

Definition Classes
RawRpcCompanion
def asRawRealRpc[Real](implicit asRawReal: AsRawRealRpc[Real]): AsRawRealRpc[Real]

Definition Classes
RawRpcCompanion
def asRawRpc[Real](implicit asRaw: AsRawRpc[Real]): AsRawRpc[Real]

Definition Classes
RawRpcCompanion
def asReal[Real](raw: RawRest)(implicit asRealRpc: AsRealRpc[Real]): Real

Definition Classes
RawRpcCompanion
def asRealRpc[Real](implicit asReal: AsRealRpc[Real]): AsRealRpc[Real]

Definition Classes
RawRpcCompanion
def clone(): AnyRef

Attributes
protected[java.lang]
Definition Classes
AnyRef
Annotations
@HotSpotIntrinsicCandidate() @throws( ... )
def contraTransformCallback[A, B](callback: Callback[B])(f: (com.avsystem.commons.Try[A]) ⇒ com.avsystem.commons.Try[B]): Callback[A]
def contramapCallback[A, B](callback: Callback[B])(f: (A) ⇒ B): Callback[A]
final def eq(arg0: AnyRef): Boolean

Definition Classes
AnyRef
def equals(arg0: Any): Boolean

Definition Classes
AnyRef → Any
def failingAsync[T](cause: Throwable): Async[T]
def fromHandleRequest[Real](handleRequest: HandleRequest)(implicit arg0: AsRealRpc[Real], arg1: RestMetadata[Real]): Real
final def getClass(): Class[_]

Definition Classes
AnyRef → Any
Annotations
@HotSpotIntrinsicCandidate()
def hashCode(): Int

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

Definition Classes
Any
def mapAsync[A, B](async: Async[A])(f: (A) ⇒ B): Async[B]
macro def materializeApiAsRaw[Real]: AsRawRpc[Real]

Definition Classes
RawRpcCompanion
macro def materializeAsRaw[Real]: AsRawRpc[Real]

Definition Classes
RawRpcCompanion
macro def materializeAsRawReal[Real]: AsRawRealRpc[Real]

Definition Classes
RawRpcCompanion
macro def materializeAsReal[Real]: AsRealRpc[Real]

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

Definition Classes
AnyRef
final def notify(): Unit

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

Definition Classes
AnyRef
Annotations
@HotSpotIntrinsicCandidate()
implicit def rawRestAsRawNotFound[T]: ImplicitNotFound[AsRaw[RawRest, T]]

Annotations
@implicitNotFound( InvalidTraitMessage )
implicit def rawRestAsRealNotFound[T]: ImplicitNotFound[AsReal[RawRest, T]]

Annotations
@implicitNotFound( InvalidTraitMessage )
def readyAsync[T](result: com.avsystem.commons.Try[T]): Async[T]
def resolveAndHandle(metadata: RestMetadata[_])(handleResolved: HandleResolvedRequest): HandleRequest
def safeAsync[T](async: ⇒ Async[T]): Async[T]
def safeHandle(handleRequest: HandleRequest): HandleRequest

Ensures that all possible exceptions thrown by a request handler are not propagated but converted into an instance of Async that notifies its callbacks about the failure.
def successfulAsync[T](value: T): Async[T]
final def synchronized[T0](arg0: ⇒ T0): T0

Definition Classes
AnyRef
def toString(): String

Definition Classes
AnyRef → Any
def transformAsync[A, B](async: Async[A])(f: (com.avsystem.commons.Try[A]) ⇒ com.avsystem.commons.Try[B]): Async[B]
final def wait(arg0: Long, arg1: Int): Unit

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

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

Definition Classes
AnyRef
Annotations
@throws( ... )

Deprecated Value Members

def finalize(): Unit

Attributes
protected[java.lang]
Definition Classes
AnyRef
Annotations
@Deprecated @deprecated @throws( classOf[java.lang.Throwable] )
Deprecated
(Since version ) see corresponding Javadoc for more information.

Related Docs: trait RawRest | package raw

object RawRest extends RawRpcCompanion[RawRest]

Type Members

type AsRawRealRpc[Real] = AsRawReal[RawRest, Real]

type AsRawRpc[Real] = AsRaw[RawRest, Real]

type AsRealRpc[Real] = AsReal[RawRest, Real]

type Async[T] = (Callback[T]) ⇒ Unit

trait AsyncEffect[F[_]] extends AnyRef

type Callback[T] = (com.avsystem.commons.Try[T]) ⇒ Unit

type HandleRequest = (RestRequest) ⇒ Async[RestResponse]

type HandleResolvedRequest = (RestRequest, ResolvedCall) ⇒ Async[RestResponse]

Value Members

final def !=(arg0: Any): Boolean

final def ##(): Int

final def ==(arg0: Any): Boolean

object AsyncEffect

final val GetMethodBodyParam: String("GET methods cannot take @Body parameters")

final val InvalidTraitMessage: String("result type ${T} is not a valid REST API trait, does it have a properly defined companion object?")

final val MissingBodyParam: String("expected exactly one @Body parameter but none was found")

final val NotValidCustomBodyMethod: String("it cannot be translated into an HTTP method with custom body")

final val NotValidFormBodyMethod: String("it cannot be translated into an HTTP method with form body")

final val NotValidGetMethod: String("it cannot be translated into an HTTP GET method")

final val NotValidHttpMethod: String("it cannot be translated into an HTTP method")

final val NotValidPrefixMethod: String("it cannot be translated into a prefix method")

final val PrefixMethodBodyParam: String("prefix methods cannot take @Body parameters")

final val SuperfluousBodyParam: String("expected exactly one @Body parameter but more than one was found")

def asHandleRequest[Real](real: Real)(implicit arg0: AsRawRpc[Real], arg1: RestMetadata[Real]): HandleRequest

final def asInstanceOf[T0]: T0

def asRaw[Real](real: Real)(implicit asRawRpc: AsRawRpc[Real]): RawRest

def asRawRealRpc[Real](implicit asRawReal: AsRawRealRpc[Real]): AsRawRealRpc[Real]

def asRawRpc[Real](implicit asRaw: AsRawRpc[Real]): AsRawRpc[Real]

def asReal[Real](raw: RawRest)(implicit asRealRpc: AsRealRpc[Real]): Real

def asRealRpc[Real](implicit asReal: AsRealRpc[Real]): AsRealRpc[Real]

def clone(): AnyRef

def contraTransformCallback[A, B](callback: Callback[B])(f: (com.avsystem.commons.Try[A]) ⇒ com.avsystem.commons.Try[B]): Callback[A]

def contramapCallback[A, B](callback: Callback[B])(f: (A) ⇒ B): Callback[A]

final def eq(arg0: AnyRef): Boolean

def equals(arg0: Any): Boolean

def failingAsync[T](cause: Throwable): Async[T]

def fromHandleRequest[Real](handleRequest: HandleRequest)(implicit arg0: AsRealRpc[Real], arg1: RestMetadata[Real]): Real

final def getClass(): Class[_]

def hashCode(): Int

final def isInstanceOf[T0]: Boolean

def mapAsync[A, B](async: Async[A])(f: (A) ⇒ B): Async[B]

macro def materializeApiAsRaw[Real]: AsRawRpc[Real]

macro def materializeAsRaw[Real]: AsRawRpc[Real]

macro def materializeAsRawReal[Real]: AsRawRealRpc[Real]

macro def materializeAsReal[Real]: AsRealRpc[Real]

final def ne(arg0: AnyRef): Boolean

final def notify(): Unit

final def notifyAll(): Unit

implicit def rawRestAsRawNotFound[T]: ImplicitNotFound[AsRaw[RawRest, T]]

implicit def rawRestAsRealNotFound[T]: ImplicitNotFound[AsReal[RawRest, T]]

def readyAsync[T](result: com.avsystem.commons.Try[T]): Async[T]

def resolveAndHandle(metadata: RestMetadata[_])(handleResolved: HandleResolvedRequest): HandleRequest

def safeAsync[T](async: ⇒ Async[T]): Async[T]

def safeHandle(handleRequest: HandleRequest): HandleRequest

def successfulAsync[T](value: T): Async[T]

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

def toString(): String

def transformAsync[A, B](async: Async[A])(f: (com.avsystem.commons.Try[A]) ⇒ com.avsystem.commons.Try[B]): Async[B]

final def wait(arg0: Long, arg1: Int): Unit

final def wait(arg0: Long): Unit

final def wait(): Unit

Deprecated Value Members

def finalize(): Unit

Inherited from RawRpcCompanion[RawRest]

Inherited from AnyRef

Inherited from Any

Ungrouped