package protocol
- Alphabetic
- Public
- All
Type Members
- trait AllBListP extends BListP with BListPExtra
- trait AllHashP extends HashP with HashPExtra
- trait AllHyperLogLogP extends HyperLogLogP with HyperLogLogPExtra
- trait AllKeyP extends KeyP with KeyPExtra
- trait AllListP extends ListP with ListPExtra
- trait AllSetP extends SetP with SetPExtra
- trait AllSortedSetP extends SortedSetP with SortedSetPExtra
- trait AllStringP extends StringP with StringPExtra
-
sealed
trait
Array extends RESP
RESP Arrays
RESP Arrays
There can be 2 cases:
nil
arrays, where the length is -1 and no array element is present- actual (non-nil) arrays, where the length is >= 0
Non-nil Arrays can be constructed using the RESPBuilders#arr(xs: Seq[RESP]) method.
import laserdisc.protocol.RESP._ val nonNilArray: NonNilArray = arr(Vector(str("hello"), str("world"))) val guaranteedNonEmptyArray: NonNilArray = arr(str("hello"), str("world")) val emptyArray: NonNilArray = arr(Vector.empty) val nilArray: NilArray = nilArray
- Note
A forwarder for
,nil
is present too and represented using thefinal val
s RESPBuilders.nilArrayRESPBuilders#arr(one: RESP, rest: RESP*) is an overload which supports the creation of guaranteed non-empty sequences only. This is achieved through the usage of one fixed parameter followed by a var-arg of the same
Example: - trait BListP extends AnyRef
- trait BListPExtra extends AnyRef
-
sealed
trait
BulkString extends RESP
RESP Bulk Strings
RESP Bulk Strings
There can be 2 cases:
null
bulk strings, where the length is -1 and no actual underlying string is present- actual (non-null) bulk strings, where the length is >= 0
Non-null BulkStrings can be constructed using the RESPBuilders#bulk method
import laserdisc.protocol.RESP._ val nonNullBulkString: NonNullBulkString = bulk("some string") val nullBulkString: NullBulkString = nullBulk
- Note
A forwarder for
null
BulkStrings is present too and represented using thefinal val
s RESPBuilders.nullBulk- See also
Example: - trait ConnectionP extends AnyRef
-
final
class
Error extends LaserDiscRuntimeError with RESP
RESP Errors
RESP Errors
RESP Errors are also scala.RuntimeExceptions, although where possible they will not contain stacktrace data
These can be constructed by using the RESPBuilders#err method
import laserdisc.protocol.RESP._ val error: Error = err("some error message")
Example: - trait HashP extends AnyRef
- trait HashPExtra extends AnyRef
- trait HyperLogLogP extends AnyRef
- trait HyperLogLogPExtra extends AnyRef
-
final
class
Integer extends RESP
RESP Integers
RESP Integers
These can be constructed by using the RESPBuilders#int method
import laserdisc.protocol.RESP._ val integer: Integer = int(42)
- Note
Sometimes the values 0 and 1 are used to represent boolean values. In this case 0 corresponds to False while 1 to True, respectively.
Example: - trait KeyP extends AnyRef
- trait KeyPExtra extends AnyRef
- final class LenientStringCodec extends Codec[String]
- trait ListP extends AnyRef
- trait ListPExtra extends AnyRef
- trait LowPriorityRESPParamWrite extends LowestPriorityRESPParamWrite
- trait LowPriorityReadInstances extends LowerPriorityReadInstances
- trait LowPriorityShowInstances extends AnyRef
- sealed trait LowerPriorityReadInstances extends AnyRef
- sealed trait LowestPriorityRESPParamWrite extends AnyRef
- sealed trait NilArray extends Array
-
final
class
NonNilArray extends Array
This is the special case of a non-nil RESP Array
This is the special case of a non-nil RESP Array
These can be constructed by using the RESPBuilders#arr(xs: Seq[RESP]) method
or
by resorting to the overloaded RESPBuilders#arr(one: RESP, rest: RESP*) method which expects one parameter to be supplied followed by a (possibly empty) sequence of RESPs (vararg).
-
final
class
NonNullBulkString extends BulkString
This is the special case of a non-null RESP BulkString
This is the special case of a non-null RESP BulkString
These can be constructed by using the RESPBuilders#bulk method
- sealed trait NullBulkString extends BulkString
- sealed trait Protocol extends Request with Response
- sealed trait ProtocolCodec[A] extends Any
- trait PublishP extends AnyRef
-
sealed
trait
RESP extends Serializable
This sealed trait represents the entire Redis Serialization Protocol algebra
Concrete instances of this trait must be created using this trait's companion object's methods, were scodec.Codecs for each are also defined
- See also
- trait RESPBuilders extends AnyRef
- trait RESPCodecs extends AnyRef
-
trait
RESPParamWrite[A] extends AnyRef
- Annotations
- @implicitNotFound( ... )
-
trait
RESPRead[A] extends AnyRef
- Annotations
- @implicitNotFound( ... )
-
trait
Read[A, B] extends AnyRef
- Annotations
- @implicitNotFound( ... )
- sealed trait Request extends AnyRef
- sealed trait Response extends AnyRef
- trait ServerP extends AnyRef
- trait SetP extends AnyRef
- trait SetPExtra extends AnyRef
-
trait
Show[A] extends AnyRef
- Annotations
- @implicitNotFound( ... )
-
final
class
SimpleString extends RESP
RESP Simple Strings
RESP Simple Strings
These can be constructed by using the RESPBuilders#str method
import laserdisc.protocol.RESP._ val simpleString: SimpleString = str("some string")
- Note
Sometimes the value "OK" is used to represent a successful acknowledgement/processing of a command.
Example: - trait SortedSetP extends AnyRef
- trait SortedSetPExtra extends AnyRef
- trait StringP extends AnyRef
- trait StringPExtra extends AnyRef
Value Members
- object Error extends Serializable
- object Integer extends Serializable
- object KeyP
- object ListP
- object NilArray extends NilArray with Product with Serializable
- object NonNilArray extends Serializable
- object NonNullBulkString extends Serializable
- object NullBulkString extends NullBulkString with Product with Serializable
- object Protocol
- object RESP extends RESPBuilders with RESPCodecs with Serializable
- object RESPParamWrite extends LowPriorityRESPParamWrite
- object RESPRead
- object Read extends LowPriorityReadInstances
- object ServerP
- object Show extends LowPriorityShowInstances
- object SimpleString extends Serializable
- object SortedSetP
- object StringP