protocol

Type Members

1. trait AllBListP extends BListP with BListPExtra

   

2. trait AllHashP extends HashP with HashPExtra

   

3. trait AllHyperLogLogP extends HyperLogLogP with HyperLogLogPExtra

   

4. trait AllKeyP extends KeyP with KeyPExtra

   

5. trait AllListP extends ListP with ListPExtra

   

6. trait AllSetP extends SetP with SetPExtra

   

7. trait AllSortedSetP extends SortedSetP with SortedSetPExtra

   

8. trait AllStringP extends StringP with StringPExtra

   

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

   Example:

   1. 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 the final vals RESPBuilders.nilArray

   ,

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

10. trait BListP extends AnyRef

    

11. trait BListPExtra extends AnyRef

    

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

    Example:

    1. 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 the final vals RESPBuilders.nullBulk

    See also

    Show

13. final case class CompleteFrame(bits: BitVector) extends RESPFrame with NonEmptyRESPFrame with Product with Serializable

    

14. trait ConnectionP extends AnyRef

    

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

    Example:

    1. import laserdisc.protocol.RESP._
       val error: Error = err("some error message")

16. trait HashP extends AnyRef

    

17. trait HashPExtra extends AnyRef

    

18. trait HyperLogLogP extends AnyRef

    

19. trait HyperLogLogPExtra extends AnyRef

    

20. final case class IncompleteFrame(partial: BitVector, bitsToComplete: Long) extends RESPFrame with NonEmptyRESPFrame with Product with Serializable

    

21. final class Integer extends RESP

    

    RESP Integers

    RESP Integers

    These can be constructed by using the RESPBuilders#int method

    Example:

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

22. trait KeyP extends AnyRef

    

23. trait KeyPExtra extends AnyRef

    

24. final class LenientStringCodec extends Codec[String]

    

25. trait ListP extends AnyRef

    

26. trait ListPExtra extends AnyRef

    

27. trait LowPriorityRESPParamWrite extends LowestPriorityRESPParamWrite

    

28. trait LowPriorityReadInstances extends LowerPriorityReadInstances

    

29. trait LowPriorityShowInstances extends AnyRef

    

30. sealed trait LowerPriorityReadInstances extends AnyRef

    

31. sealed trait LowestPriorityRESPParamWrite extends AnyRef

    

32. final case class MoreThanOneFrame(invertedComplete: List[CompleteFrame], remainder: BitVector) extends RESPFrame with NonEmptyRESPFrame with Product with Serializable

    

33. sealed trait NilArray extends Array

    

34. 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).

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

36. sealed trait NullBulkString extends BulkString

    

37. sealed trait Protocol extends Request with Response

    

38. sealed trait ProtocolCodec[A] extends Any

    

39. trait PublishP extends AnyRef

    

40. sealed trait RESP extends Serializable

    

    Redis Protocol Specification

    Redis Protocol Specification

    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

    RESPCodecs

    RESPBuilders

41. sealed trait RESPBuilders extends AnyRef

    

42. sealed trait RESPCodecs extends BitVectorSyntax

    

43. sealed trait RESPFrame extends Product with Serializable with EitherSyntax with BitVectorSyntax

    

44. sealed trait RESPFunctions extends AnyRef

    

45. trait RESPParamWrite[A] extends AnyRef

    

    Annotations

    @implicitNotFound( ... )

46. trait RESPRead[A] extends AnyRef

    

    Annotations

    @implicitNotFound( ... )

47. trait Read[A, B] extends AnyRef

    

    Annotations

    @implicitNotFound( ... )

48. sealed trait Request extends AnyRef

    

49. sealed trait Response extends AnyRef

    

50. trait ServerP extends AnyRef

    

51. trait SetP extends AnyRef

    

52. trait SetPExtra extends AnyRef

    

53. trait Show[A] extends AnyRef

    

    Annotations

    @implicitNotFound( ... )

54. final class SimpleString extends RESP

    

    RESP Simple Strings

    RESP Simple Strings

    These can be constructed by using the RESPBuilders#str method

    Example:

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

55. trait SortedSetP extends AnyRef

    

56. trait SortedSetPExtra extends AnyRef

    

57. trait StringP extends AnyRef

    

58. trait StringPExtra extends AnyRef