trait AclCommands[F[_]] extends AclManagement[F] with AclUserManagement[F]

Redis ACL commands (ACL ...).

Note: replies that are decoded into structured results (aclGetUser, aclLog) are read as UTF-8 text and therefore assume the connection uses a string-decoding codec. On a connection whose value codec produces non-string values (e.g. Array[Byte]), those two commands fail with an AclError.DecodingFailure rather than returning a partial result.

Source
acl.scala
Linear Supertypes
AclUserManagement[F], AclManagement[F], AnyRef, Any
Known Subclasses
RedisCommands
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. AclCommands
  2. AclUserManagement
  3. AclManagement
  4. AnyRef
  5. 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 aclCat(category: AclCategory): F[Set[String]]

    ACL CAT <category> — the command names in the given category (lowercase).

    ACL CAT <category> — the command names in the given category (lowercase).

    Definition Classes
    AclManagement
  2. abstract def aclCat: F[Set[AclCategory]]

    ACL CAT — the available command categories.

    ACL CAT — the available command categories.

    Definition Classes
    AclManagement
  3. abstract def aclDelUser(username: String, usernames: String*): F[Long]

    ACL DELUSER <username...> — delete the given users, returning the number actually deleted.

    ACL DELUSER <username...> — delete the given users, returning the number actually deleted.

    Definition Classes
    AclUserManagement
  4. abstract def aclGenPass(bits: Int): F[String]

    ACL GENPASS <bits> — a pseudorandom password with the given number of bits of entropy.

    ACL GENPASS <bits> — a pseudorandom password with the given number of bits of entropy.

    Definition Classes
    AclManagement
  5. abstract def aclGenPass: F[String]

    ACL GENPASS — a 256-bit pseudorandom password as a 64-char hex string.

    ACL GENPASS — a 256-bit pseudorandom password as a 64-char hex string.

    Definition Classes
    AclManagement
  6. abstract def aclGetUser(username: String): F[Option[AclUser]]

    ACL GETUSER <username> — the user's rules, or None if the user does not exist.

    ACL GETUSER <username> — the user's rules, or None if the user does not exist.

    Definition Classes
    AclUserManagement
  7. abstract def aclList: F[List[String]]

    ACL LIST — all configured users in the ACL-rules text format.

    ACL LIST — all configured users in the ACL-rules text format.

    Definition Classes
    AclManagement
  8. abstract def aclLoad: F[Unit]

    ACL LOAD — reload the ACLs from the configured ACL file.

    ACL LOAD — reload the ACLs from the configured ACL file.

    Definition Classes
    AclManagement
  9. abstract def aclLog(count: Int): F[List[Map[String, String]]]

    ACL LOG <count> — the most recent count ACL security events.

    ACL LOG <count> — the most recent count ACL security events.

    Definition Classes
    AclManagement
  10. abstract def aclLog: F[List[Map[String, String]]]

    ACL LOG — recent ACL security events, each as a field/value map.

    ACL LOG — recent ACL security events, each as a field/value map.

    Definition Classes
    AclManagement
  11. abstract def aclLogReset: F[Unit]

    ACL LOG RESET — clear the ACL log.

    ACL LOG RESET — clear the ACL log.

    Definition Classes
    AclManagement
  12. abstract def aclSave: F[Unit]

    ACL SAVE — save the current ACLs to the configured ACL file.

    ACL SAVE — save the current ACLs to the configured ACL file.

    Definition Classes
    AclManagement
  13. abstract def aclSetUser(username: String, rules: List[AclSetUserRule]): F[Unit]

    ACL SETUSER <username> <rules...> — create or modify a user, applying rules in order.

    ACL SETUSER <username> <rules...> — create or modify a user, applying rules in order.

    Definition Classes
    AclUserManagement
  14. abstract def aclUsers: F[List[String]]

    ACL USERS — the usernames of all configured users.

    ACL USERS — the usernames of all configured users.

    Definition Classes
    AclUserManagement
  15. abstract def aclWhoAmI: F[String]

    ACL WHOAMI — the username of the current connection.

    ACL WHOAMI — the username of the current connection.

    Definition Classes
    AclManagement

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 AclCommands[F] toany2stringadd[AclCommands[F]] performed by method any2stringadd in scala.Predef.
    Definition Classes
    any2stringadd
  4. def ->[B](y: B): (AclCommands[F], B)
    Implicit
    This member is added by an implicit conversion from AclCommands[F] toArrowAssoc[AclCommands[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]) @IntrinsicCandidate() @native()
  8. def ensuring(cond: (AclCommands[F]) => Boolean, msg: => Any): AclCommands[F]
    Implicit
    This member is added by an implicit conversion from AclCommands[F] toEnsuring[AclCommands[F]] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  9. def ensuring(cond: (AclCommands[F]) => Boolean): AclCommands[F]
    Implicit
    This member is added by an implicit conversion from AclCommands[F] toEnsuring[AclCommands[F]] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  10. def ensuring(cond: Boolean, msg: => Any): AclCommands[F]
    Implicit
    This member is added by an implicit conversion from AclCommands[F] toEnsuring[AclCommands[F]] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  11. def ensuring(cond: Boolean): AclCommands[F]
    Implicit
    This member is added by an implicit conversion from AclCommands[F] toEnsuring[AclCommands[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. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @IntrinsicCandidate() @native()
  15. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @IntrinsicCandidate() @native()
  16. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  17. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  18. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @IntrinsicCandidate() @native()
  19. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @IntrinsicCandidate() @native()
  20. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  21. def toString(): String
    Definition Classes
    AnyRef → Any
  22. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  23. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  24. 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

    (Since version 9)

  2. def formatted(fmtstr: String): String
    Implicit
    This member is added by an implicit conversion from AclCommands[F] toStringFormat[AclCommands[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 of value.formatted(formatString), or use the f"" string interpolator. In Java 15 and later, formatted resolves to the new method in String which has reversed parameters.

  3. def →[B](y: B): (AclCommands[F], B)
    Implicit
    This member is added by an implicit conversion from AclCommands[F] toArrowAssoc[AclCommands[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 AclUserManagement[F]

Inherited from AclManagement[F]

Inherited from AnyRef

Inherited from Any

Inherited by implicit conversion any2stringadd fromAclCommands[F] to any2stringadd[AclCommands[F]]

Inherited by implicit conversion StringFormat fromAclCommands[F] to StringFormat[AclCommands[F]]

Inherited by implicit conversion Ensuring fromAclCommands[F] to Ensuring[AclCommands[F]]

Inherited by implicit conversion ArrowAssoc fromAclCommands[F] to ArrowAssoc[AclCommands[F]]

Ungrouped