/man/redisLRange.Rd

http://github.com/bwlewis/rredis · Unknown · 41 lines · 41 code · 0 blank · 0 comment · 0 complexity · 69b1f9b8f0c2cbd0b52a7d5abe5e005c MD5 · raw file

  1. \name{redisLRange}
  2. \alias{redisLRange}
  3. \title{Copy values from a list.}
  4. \description{Return the elements of a list between the start and end
  5. indices, inclusively.
  6. }
  7. \usage{
  8. redisLRange(key, start, end, ...)
  9. }
  10. \arguments{
  11. \item{key}{A key corresponding to a list. }
  12. \item{start}{The beginning index from which to read list elements. }
  13. \item{end}{The ending index.}
  14. \item{...}{ Optional additional arguments. Specify \code{raw=TRUE} to skip de-serialization of the data.}
  15. }
  16. \details{
  17. List indices begin with 0. If the start or end indices are beyond the bounds
  18. of the list, return the list elements up to the index bounds.
  19. }
  20. \value{An indexed list containing the returned values. An error will be
  21. thrown if the specified key does not correspond to a list or if the key
  22. can't be found.
  23. }
  24. \references{
  25. http://redis.io/commands
  26. }
  27. \author{
  28. B. W. Lewis
  29. }
  30. \seealso{
  31. \code{\link{redisLPop}}
  32. }
  33. \examples{
  34. \dontrun{
  35. redisConnect()
  36. redisLPush('x',1)
  37. redisLPush('x',2)
  38. redisLPush('x',3)
  39. redisLRange('x',0,2)
  40. }
  41. }