t

effredis

GeoOperations

trait GeoOperations[F[+_]] extends GeoApi[F]

Self Type
GeoOperations[F] with Redis[F, _]
Linear Supertypes
Known Subclasses
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. GeoOperations
  2. GeoApi
  3. AnyRef
  4. 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. implicit abstract def conc: Concurrent[F]
  2. implicit abstract def ctx: ContextShift[F]

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 GeoOperations[F] toany2stringadd[GeoOperations[F]] performed by method any2stringadd in scala.Predef.
    Definition Classes
    any2stringadd
  4. def ->[B](y: B): (GeoOperations[F], B)
    Implicit
    This member is added by an implicit conversion from GeoOperations[F] toArrowAssoc[GeoOperations[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: (GeoOperations[F]) => Boolean, msg: => Any): GeoOperations[F]
    Implicit
    This member is added by an implicit conversion from GeoOperations[F] toEnsuring[GeoOperations[F]] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  9. def ensuring(cond: (GeoOperations[F]) => Boolean): GeoOperations[F]
    Implicit
    This member is added by an implicit conversion from GeoOperations[F] toEnsuring[GeoOperations[F]] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  10. def ensuring(cond: Boolean, msg: => Any): GeoOperations[F]
    Implicit
    This member is added by an implicit conversion from GeoOperations[F] toEnsuring[GeoOperations[F]] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  11. def ensuring(cond: Boolean): GeoOperations[F]
    Implicit
    This member is added by an implicit conversion from GeoOperations[F] toEnsuring[GeoOperations[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 GeoOperations[F] toStringFormat[GeoOperations[F]] performed by method StringFormat in scala.Predef.
    Definition Classes
    StringFormat
    Annotations
    @inline()
  15. def geoadd(key: Any, members: Iterable[Product3[Any, Any, Any]]): F[Resp[Option[Int]]]

    Add the given members in the key geo sorted set

    Add the given members in the key geo sorted set

    key

    The geo sorted set

    members

    The members to be added. Format is (longitude, latitude, member)

    returns

    The number of elements added to the index. Repeated elements are not added.

    Definition Classes
    GeoOperationsGeoApi
  16. def geodist(key: Any, m1: Any, m2: Any, unit: Option[Any]): F[Resp[Option[String]]]
    Definition Classes
    GeoOperationsGeoApi
  17. def geohash[A](key: Any, members: Iterable[Any])(implicit format: Format, parse: Parse[A]): F[Resp[Option[List[Option[A]]]]]

    Get the geohash for each member in the key geo index.

    Get the geohash for each member in the key geo index.

    returns

    The geohash of each queried member.

    Definition Classes
    GeoOperationsGeoApi
  18. def geopos[A](key: Any, members: Iterable[Any])(implicit format: Format, parse: Parse[A]): F[Resp[Option[List[Option[List[Option[A]]]]]]]

    Retrieve the position of the members in the key geo sorted set.

    Retrieve the position of the members in the key geo sorted set. Note that if a member is not part of the set, None will be returned for this element.

    returns

    the coordinates of the input members in the same order.

    Definition Classes
    GeoOperationsGeoApi
  19. def georadius(key: Any, longitude: Any, latitude: Any, radius: Any, unit: Any, withCoord: Boolean, withDist: Boolean, withHash: Boolean, count: Option[Int], sort: Option[Any], store: Option[Any], storeDist: Option[Any]): F[Resp[Option[List[Option[GeoRadiusMember]]]]]

    Search for members around an origin point in the key geo sorted set

    Search for members around an origin point in the key geo sorted set

    key

    The geo index we are searching in

    longitude

    The base longitude for distance computation

    latitude

    The base latitude for distance computation

    radius

    The radius of the circle we want to search in

    unit

    The unit of the radius. Can be m (meters), km (kilometers), mi (miles), ft (feet)

    withCoord

    If true, the coordinate of the found members will be returned in the result

    withDist

    If true, the distance between the origin and the found members will be returned in the result

    withHash

    If true, the hash of the found members will be returned in the result

    count

    Max number of expected results

    sort

    The sorting strategy. If empty, order is not guaranteed. Can be ASC (ascending) or DESC (descending)

    store

    The Redis store we want to write the result in

    storeDist

    The redis storedist we want to write the result in

    returns

    The found members as GeoRadiusMember instances

    Definition Classes
    GeoOperationsGeoApi
  20. def georadiusbymember[A](key: Any, member: Any, radius: Any, unit: Any, withCoord: Boolean, withDist: Boolean, withHash: Boolean, count: Option[Int], sort: Option[Any], store: Option[Any], storeDist: Option[Any])(implicit format: Format, parse: Parse[A]): F[Resp[Option[List[Option[GeoRadiusMember]]]]]

    Search for members around a specific memberin the key geo sorted set

    Search for members around a specific memberin the key geo sorted set

    key

    The geo index we are searching in

    member

    The member we are searching around

    radius

    The radius of the circle we want to search in

    unit

    The unit of the radius. Can be m (meters), km (kilometers), mi (miles), ft (feet)

    withCoord

    If true, the coordinate of the found members will be returned in the result

    withDist

    If true, the distance between the origin and the found members will be returned in the result

    withHash

    If true, the hash of the found members will be returned in the result

    count

    Max number of expected results

    sort

    The sorting strategy. If empty, order is not guaranteed. Can be ASC (ascending) or DESC (descending)

    store

    The Redis store we want to write the result in

    storeDist

    The redis storedist we want to write the result in

    returns

    The found members as GeoRadiusMember instances

    Definition Classes
    GeoOperationsGeoApi
  21. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  22. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  23. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  24. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  25. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  26. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  27. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  28. def toString(): String
    Definition Classes
    AnyRef → Any
  29. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  30. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()
  31. 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): (GeoOperations[F], B)
    Implicit
    This member is added by an implicit conversion from GeoOperations[F] toArrowAssoc[GeoOperations[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 GeoApi[F]

Inherited from AnyRef

Inherited from Any

Inherited by implicit conversion any2stringadd fromGeoOperations[F] to any2stringadd[GeoOperations[F]]

Inherited by implicit conversion StringFormat fromGeoOperations[F] to StringFormat[GeoOperations[F]]

Inherited by implicit conversion Ensuring fromGeoOperations[F] to Ensuring[GeoOperations[F]]

Inherited by implicit conversion ArrowAssoc fromGeoOperations[F] to ArrowAssoc[GeoOperations[F]]

Ungrouped