class RedisClientPartiallyApplied[F[_]] extends AnyRef
- Source
- RedisClient.scala
Linear Supertypes
Ordering
- Alphabetic
- By Inheritance
Inherited
- RedisClientPartiallyApplied
- AnyRef
- Any
Implicitly
- by any2stringadd
- by StringFormat
- by Ensuring
- by ArrowAssoc
- Hide All
- Show All
Visibility
- Public
- Protected
Instance Constructors
Value Members
- final def !=(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
- final def ##: Int
- Definition Classes
- AnyRef → Any
- def +(other: String): String
- Implicit
- This member is added by an implicit conversion from RedisClientPartiallyApplied[F] toany2stringadd[RedisClientPartiallyApplied[F]] performed by method any2stringadd in scala.Predef.
- Definition Classes
- any2stringadd
- def ->[B](y: B): (RedisClientPartiallyApplied[F], B)
- Implicit
- This member is added by an implicit conversion from RedisClientPartiallyApplied[F] toArrowAssoc[RedisClientPartiallyApplied[F]] performed by method ArrowAssoc in scala.Predef.
- Definition Classes
- ArrowAssoc
- Annotations
- @inline()
- final def ==(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
- final def asInstanceOf[T0]: T0
- Definition Classes
- Any
- def clone(): AnyRef
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.CloneNotSupportedException]) @IntrinsicCandidate() @native()
- def custom(uri: => RedisURI, opts: ClientOptions, config: Redis4CatsConfig = Redis4CatsConfig()): Resource[F, RedisClient]
Creates a RedisClient with the supplied options from a validated URI.
Creates a RedisClient with the supplied options from a validated URI.
Example:
for { uri <- Resource.eval(RedisURI.make[F]("redis://localhost")) ops <- Resource.eval(Sync[F].delay(ClientOptions.create())) // configure timeouts, etc cli <- RedisClient[IO].custom(uri, ops) } yield cli
Additionally, it can take a dev.profunktor.redis4cats.config.Redis4CatsConfig to configure the shutdown timeouts, for example. However, you don't need to worry about this in most cases.
RedisClient[IO].custom(uri, ops, Redis4CatsConfig())
If not supplied, sane defaults will be used.
- def ensuring(cond: (RedisClientPartiallyApplied[F]) => Boolean, msg: => Any): RedisClientPartiallyApplied[F]
- Implicit
- This member is added by an implicit conversion from RedisClientPartiallyApplied[F] toEnsuring[RedisClientPartiallyApplied[F]] performed by method Ensuring in scala.Predef.
- Definition Classes
- Ensuring
- def ensuring(cond: (RedisClientPartiallyApplied[F]) => Boolean): RedisClientPartiallyApplied[F]
- Implicit
- This member is added by an implicit conversion from RedisClientPartiallyApplied[F] toEnsuring[RedisClientPartiallyApplied[F]] performed by method Ensuring in scala.Predef.
- Definition Classes
- Ensuring
- def ensuring(cond: Boolean, msg: => Any): RedisClientPartiallyApplied[F]
- Implicit
- This member is added by an implicit conversion from RedisClientPartiallyApplied[F] toEnsuring[RedisClientPartiallyApplied[F]] performed by method Ensuring in scala.Predef.
- Definition Classes
- Ensuring
- def ensuring(cond: Boolean): RedisClientPartiallyApplied[F]
- Implicit
- This member is added by an implicit conversion from RedisClientPartiallyApplied[F] toEnsuring[RedisClientPartiallyApplied[F]] performed by method Ensuring in scala.Predef.
- Definition Classes
- Ensuring
- final def eq(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
- def equals(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef → Any
- implicit val fl: FutureLift[F]
- def from(strUri: => String)(implicit F: Sync[F]): Resource[F, RedisClient]
Creates a RedisClient with default options.
- def fromUri(uri: => RedisURI)(implicit F: Sync[F]): Resource[F, RedisClient]
Creates a RedisClient with default options from a validated URI.
Creates a RedisClient with default options from a validated URI.
Example:
for { uri <- Resource.eval(RedisURI.make[F]("redis://localhost")) cli <- RedisClient[IO].fromUri(uri) } yield cli
You may prefer to use from instead, which takes a raw string.
- final def getClass(): Class[_ <: AnyRef]
- Definition Classes
- AnyRef → Any
- Annotations
- @IntrinsicCandidate() @native()
- def hashCode(): Int
- Definition Classes
- AnyRef → Any
- Annotations
- @IntrinsicCandidate() @native()
- final def isInstanceOf[T0]: Boolean
- Definition Classes
- Any
- implicit val log: Log[F]
- final def ne(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
- final def notify(): Unit
- Definition Classes
- AnyRef
- Annotations
- @IntrinsicCandidate() @native()
- final def notifyAll(): Unit
- Definition Classes
- AnyRef
- Annotations
- @IntrinsicCandidate() @native()
- final def synchronized[T0](arg0: => T0): T0
- Definition Classes
- AnyRef
- def toString(): String
- Definition Classes
- AnyRef → Any
- final def wait(arg0: Long, arg1: Int): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException])
- final def wait(arg0: Long): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException])
- final def wait(): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException])
- def withOptions(strUri: => String, opts: ClientOptions): Resource[F, RedisClient]
Creates a RedisClient with the supplied options.
Creates a RedisClient with the supplied options.
Example:
for { ops <- Resource.eval(Sync[F].delay(ClientOptions.create())) // configure timeouts, etc cli <- RedisClient[IO].withOptions("redis://localhost", ops) } yield cli
Deprecated Value Members
- def finalize(): Unit
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.Throwable]) @Deprecated
- Deprecated
(Since version 9)
- def formatted(fmtstr: String): String
- Implicit
- This member is added by an implicit conversion from RedisClientPartiallyApplied[F] toStringFormat[RedisClientPartiallyApplied[F]] performed by method StringFormat in scala.Predef.
- Definition Classes
- StringFormat
- Annotations
- @deprecated @inline()
- Deprecated
(Since version 2.12.16) Use
formatString.format(value)instead ofvalue.formatted(formatString), or use thef""string interpolator. In Java 15 and later,formattedresolves to the new method in String which has reversed parameters.
- def →[B](y: B): (RedisClientPartiallyApplied[F], B)
- Implicit
- This member is added by an implicit conversion from RedisClientPartiallyApplied[F] toArrowAssoc[RedisClientPartiallyApplied[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.
This is the API documentation for the Redis4Cats library.