Packages

trait HashApi[F[+_]] extends AnyRef

Linear Supertypes
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. HashApi
  2. AnyRef
  3. Any
Implicitly
  1. by any2stringadd
  2. by StringFormat
  3. by Ensuring
  4. by ArrowAssoc
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. Protected

Abstract Value Members

  1. abstract def hdel(key: Any, field: Any, fields: Any*)(implicit format: Format): F[Resp[Option[Long]]]
  2. abstract def hexists(key: Any, field: Any)(implicit format: Format): F[Resp[Boolean]]
  3. abstract def hget[A](key: Any, field: Any)(implicit format: Format, parse: Parse[A]): F[Resp[Option[A]]]
  4. abstract def hgetall1[K, V](key: Any)(implicit format: Format, parseK: Parse[K], parseV: Parse[V]): F[Resp[Option[Map[K, V]]]]
  5. abstract def hincrby(key: Any, field: Any, value: Long)(implicit format: Format): F[Resp[Option[Long]]]
  6. abstract def hincrbyfloat(key: Any, field: Any, value: Float)(implicit format: Format): F[Resp[Option[Float]]]
  7. abstract def hkeys[A](key: Any)(implicit format: Format, parse: Parse[A]): F[Resp[Option[List[A]]]]
  8. abstract def hlen(key: Any)(implicit format: Format): F[Resp[Option[Long]]]
  9. abstract def hmget[K, V](key: Any, fields: K*)(implicit format: Format, parseV: Parse[V]): F[Resp[Option[Map[K, V]]]]
  10. abstract def hmset(key: Any, map: Iterable[Product2[Any, Any]])(implicit format: Format): F[Resp[Boolean]]

    Sets the specified fields to their respective values in the hash stored at key.

    Sets the specified fields to their respective values in the hash stored at key. This command overwrites any existing fields in the hash. If key does not exist, a new key holding a hash is created.

    map

    from fields to values

    returns

    True if operation completed successfully, False otherwise.

    See also

    HMSET documentation

  11. abstract def hscan[A](key: Any, cursor: Int, pattern: Any = "*", count: Int = 10)(implicit format: Format, parse: Parse[A]): F[Resp[Option[(Option[Int], Option[List[Option[A]]])]]]

    Incrementally iterate hash fields and associated values (since 2.8)

  12. abstract def hset1(key: Any, field: Any, value: Any)(implicit format: Format): F[Resp[Option[Long]]]

    Sets field in the hash stored at key to value.

    Sets field in the hash stored at key to value. If key does not exist, a new key holding a hash is created. If field already exists in the hash, it is overwritten.

    returns

    Some(0) if field is a new field in the hash and value was set, Some(1) if field already exists in the hash and the value was updated.

    See also

    HSET documentation

  13. abstract def hsetnx(key: Any, field: Any, value: Any)(implicit format: Format): F[Resp[Boolean]]

    Sets field in the hash stored at key to value, only if field does not yet exist.

    Sets field in the hash stored at key to value, only if field does not yet exist. If key does not exist, a new key holding a hash is created. If field already exists, this operation has no effect.

    returns

    True if field is a new field in the hash and value was set. False if field exists in the hash and no operation was performed.

    See also

    HSETNX documentation

  14. abstract def hvals[A](key: Any)(implicit format: Format, parse: Parse[A]): F[Resp[Option[List[A]]]]
  15. abstract def hgetall[K, V](key: Any)(implicit format: Format, parseK: Parse[K], parseV: Parse[V]): F[Resp[Option[Map[K, V]]]]
    Annotations
    @deprecated
    Deprecated

    (Since version 3.2) Use the more idiomatic variant hgetall1, which has the returned Map behavior more consistent. See issue https://github.com/debasishg/scala-redis/issues/122

  16. abstract def hset(key: Any, field: Any, value: Any)(implicit format: Format): F[Resp[Boolean]]

    Sets field in the hash stored at key to value.

    Sets field in the hash stored at key to value. If key does not exist, a new key holding a hash is created. If field already exists in the hash, it is overwritten.

    returns

    True if field is a new field in the hash and value was set, False if field already exists in the hash and the value was updated.

    Deprecated

    return value semantics is inconsistent with effredis.HashOperations#hsetnx and effredis.HashOperations#hmset. Use effredis.HashOperations#hset1 instead

    See also

    HSET documentation

Concrete Value Members

  1. final def !=(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  2. final def ##: Int
    Definition Classes
    AnyRef → Any
  3. def +(other: String): String
    Implicit
    This member is added by an implicit conversion from HashApi[F] toany2stringadd[HashApi[F]] performed by method any2stringadd in scala.Predef.
    Definition Classes
    any2stringadd
  4. def ->[B](y: B): (HashApi[F], B)
    Implicit
    This member is added by an implicit conversion from HashApi[F] toArrowAssoc[HashApi[F]] performed by method ArrowAssoc in scala.Predef.
    Definition Classes
    ArrowAssoc
    Annotations
    @inline()
  5. final def ==(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  6. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  7. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.CloneNotSupportedException]) @native() @HotSpotIntrinsicCandidate()
  8. def ensuring(cond: (HashApi[F]) => Boolean, msg: => Any): HashApi[F]
    Implicit
    This member is added by an implicit conversion from HashApi[F] toEnsuring[HashApi[F]] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  9. def ensuring(cond: (HashApi[F]) => Boolean): HashApi[F]
    Implicit
    This member is added by an implicit conversion from HashApi[F] toEnsuring[HashApi[F]] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  10. def ensuring(cond: Boolean, msg: => Any): HashApi[F]
    Implicit
    This member is added by an implicit conversion from HashApi[F] toEnsuring[HashApi[F]] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  11. def ensuring(cond: Boolean): HashApi[F]
    Implicit
    This member is added by an implicit conversion from HashApi[F] toEnsuring[HashApi[F]] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  12. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  13. def equals(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef → Any
  14. def formatted(fmtstr: String): String
    Implicit
    This member is added by an implicit conversion from HashApi[F] toStringFormat[HashApi[F]] performed by method StringFormat in scala.Predef.
    Definition Classes
    StringFormat
    Annotations
    @inline()
  15. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  16. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  17. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  18. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  19. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  20. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  21. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  22. def toString(): String
    Definition Classes
    AnyRef → Any
  23. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  24. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()
  25. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])

Deprecated Value Members

  1. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.Throwable]) @Deprecated
    Deprecated
  2. def [B](y: B): (HashApi[F], B)
    Implicit
    This member is added by an implicit conversion from HashApi[F] toArrowAssoc[HashApi[F]] performed by method ArrowAssoc in scala.Predef.
    Definition Classes
    ArrowAssoc
    Annotations
    @deprecated
    Deprecated

    (Since version 2.13.0) Use -> instead. If you still wish to display it as one character, consider using a font with programming ligatures such as Fira Code.

Inherited from AnyRef

Inherited from Any

Inherited by implicit conversion any2stringadd fromHashApi[F] to any2stringadd[HashApi[F]]

Inherited by implicit conversion StringFormat fromHashApi[F] to StringFormat[HashApi[F]]

Inherited by implicit conversion Ensuring fromHashApi[F] to Ensuring[HashApi[F]]

Inherited by implicit conversion ArrowAssoc fromHashApi[F] to ArrowAssoc[HashApi[F]]

Ungrouped