Class: Familia::StringKey

Inherits:
DataType show all
Defined in:
lib/familia/data_type/types/stringkey.rb

Direct Known Subclasses

Counter, Lock

Instance Attribute Summary collapse

Attributes included from Settings

#current_key_version, #default_expiration, #delim, #encryption_keys, #encryption_personalization, #logical_database, #prefix, #suffix, #transaction_mode

Instance Method Summary collapse

Methods included from Features::Autoloader

autoload_files, included, normalize_to_config_name

Methods included from DataType::Serialization

#deserialize_value, #deserialize_values, #deserialize_values_with_nil, #serialize_value

Methods included from DataType::DatabaseCommands

#current_expiration, #delete!, #echo, #exists?, #expire, #expireat, #move, #persist, #rename, #renamenx, #type

Methods included from DataType::Connection

#dbclient, #dbkey, #direct_access

Methods included from Settings

#configure, #default_suffix, #pipeline_mode, #pipeline_mode=

Methods included from Base

add_feature, #as_json, #expired?, #expires?, find_feature, #generate_id, #to_json, #ttl, #update_expiration, #uuid

Constructor Details

This class inherits a constructor from Familia::DataType

Instance Attribute Details

#features_enabled ⇒ Object (readonly) Originally defined in module Features

Returns the value of attribute features_enabled.

#logical_database(val = nil) ⇒ Object Originally defined in module DataType::ClassMethods

#parent ⇒ Object Originally defined in module DataType::ClassMethods

Returns the value of attribute parent.

#prefix ⇒ Object Originally defined in module DataType::ClassMethods

Returns the value of attribute prefix.

#suffix ⇒ Object Originally defined in module DataType::ClassMethods

Returns the value of attribute suffix.

#uri(val = nil) ⇒ Object Originally defined in module DataType::ClassMethods

Returns the value of attribute uri.

Instance Method Details

#append(val) ⇒ Object Also known as: << 



79
80
81
82
83
 
# File 'lib/familia/data_type/types/stringkey.rb', line 79

def append(val)
  ret = dbclient.append dbkey, val
  update_expiration
  ret
end

#char_count ⇒ Integer Also known as: size, length

Returns the number of elements in the list

Returns:

  • (Integer) —

    number of elements



9
10
11
 
# File 'lib/familia/data_type/types/stringkey.rb', line 9

def char_count
  to_s.size
end

#decrement ⇒ Object Also known as: decr 



65
66
67
68
69
 
# File 'lib/familia/data_type/types/stringkey.rb', line 65

def decrement
  ret = dbclient.decr dbkey
  update_expiration
  ret
end

#decrementby(val) ⇒ Object Also known as: decrby 



72
73
74
75
76
 
# File 'lib/familia/data_type/types/stringkey.rb', line 72

def decrementby(val)
  ret = dbclient.decrby dbkey, val.to_i
  update_expiration
  ret
end

#del ⇒ Object 



112
113
114
115
 
# File 'lib/familia/data_type/types/stringkey.rb', line 112

def del
  ret = dbclient.del dbkey
  ret.positive?
end

#empty? ⇒ Boolean

Returns:

  • (Boolean) 


15
16
17
 
# File 'lib/familia/data_type/types/stringkey.rb', line 15

def empty?
  char_count.zero?
end

#getbit(offset) ⇒ Object 



86
87
88
 
# File 'lib/familia/data_type/types/stringkey.rb', line 86

def getbit(offset)
  dbclient.getbit dbkey, offset
end

#getrange(spoint, epoint) ⇒ Object 



96
97
98
 
# File 'lib/familia/data_type/types/stringkey.rb', line 96

def getrange(spoint, epoint)
  dbclient.getrange dbkey, spoint, epoint
end

#getset(val) ⇒ Object 



106
107
108
109
110
 
# File 'lib/familia/data_type/types/stringkey.rb', line 106

def getset(val)
  ret = dbclient.getset dbkey, val
  update_expiration
  ret
end

#increment ⇒ Object Also known as: incr 



51
52
53
54
55
 
# File 'lib/familia/data_type/types/stringkey.rb', line 51

def increment
  ret = dbclient.incr(dbkey)
  update_expiration
  ret
end

#incrementby(val) ⇒ Object Also known as: incrby 



58
59
60
61
62
 
# File 'lib/familia/data_type/types/stringkey.rb', line 58

def incrementby(val)
  ret = dbclient.incrby(dbkey, val.to_i)
  update_expiration
  ret
end

#init ⇒ Object 



5
 
# File 'lib/familia/data_type/types/stringkey.rb', line 5

def init; end

#setbit(offset, val) ⇒ Object 



90
91
92
93
94
 
# File 'lib/familia/data_type/types/stringkey.rb', line 90

def setbit(offset, val)
  ret = dbclient.setbit dbkey, offset, val
  update_expiration
  ret
end

#setnx(val) ⇒ Object 



45
46
47
48
49
 
# File 'lib/familia/data_type/types/stringkey.rb', line 45

def setnx(val)
  ret = dbclient.setnx(dbkey, serialize_value(val))
  update_expiration
  ret
end

#setrange(offset, val) ⇒ Object 



100
101
102
103
104
 
# File 'lib/familia/data_type/types/stringkey.rb', line 100

def setrange(offset, val)
  ret = dbclient.setrange dbkey, offset, val
  update_expiration
  ret
end

#to_i ⇒ Object 



33
34
35
 
# File 'lib/familia/data_type/types/stringkey.rb', line 33

def to_i
  value.to_i
end

#to_s ⇒ Object 



27
28
29
30
31
 
# File 'lib/familia/data_type/types/stringkey.rb', line 27

def to_s
  return super if value.to_s.empty?

  value.to_s
end

#value ⇒ Object Also known as: content, get 



19
20
21
22
23
 
# File 'lib/familia/data_type/types/stringkey.rb', line 19

def value
  echo :value, Familia.pretty_stack(limit: 1) if Familia.debug
  dbclient.setnx dbkey, @opts[:default] if @opts[:default]
  deserialize_value dbclient.get(dbkey)
end

#value=(val) ⇒ Object Also known as: replace, set 



37
38
39
40
41
 
# File 'lib/familia/data_type/types/stringkey.rb', line 37

def value=(val)
  ret = dbclient.set(dbkey, serialize_value(val))
  update_expiration
  ret
end