Class: Yoda::Store::Adapters::Base Abstract

Inherits:
Object
  • Object
show all
Defined in:
lib/yoda/store/adapters/base.rb

Overview

This class is abstract.

Direct Known Subclasses

GdbmAdapter, LazyAdapter, MemoryAdapter

Class Method Summary collapse

Instance Method Summary collapse

Class Method Details

.for(path) ⇒ Object

This method is abstract.


7
8
9
# File 'lib/yoda/store/adapters/base.rb', line 7

def self.for(path)
  fail NotImplementedError
end

.typeObject

This method is abstract.


12
13
14
# File 'lib/yoda/store/adapters/base.rb', line 12

def self.type
  fail NotImplementedError
end

Instance Method Details

#batch_write(data, bar) ⇒ Object

This method is abstract.

Parameters:

  • data (Enumerator<(String, Object)>)
  • bar (#increment, nil)


92
93
94
# File 'lib/yoda/store/adapters/base.rb', line 92

def batch_write(data, bar)
  fail NotImplementedError
end

#clearvoid

This method is abstract.

This method returns an undefined value.

Clear all contents in the database.



66
67
68
# File 'lib/yoda/store/adapters/base.rb', line 66

def clear
  fail NotImplementedError
end

#delete(address) ⇒ void

This method is abstract.

This method returns an undefined value.

Parameters:

  • address (String, Symbol)


34
35
36
# File 'lib/yoda/store/adapters/base.rb', line 34

def delete(address)
  fail NotImplementedError
end

#empty?Boolean

This method is abstract.

Returns:

  • (Boolean)


72
73
74
# File 'lib/yoda/store/adapters/base.rb', line 72

def empty?
  fail NotImplementedError
end

#exist?(address) ⇒ Boolean

This method is abstract.

Parameters:

  • address (String, Symbol)

Returns:

  • (Boolean)


41
42
43
# File 'lib/yoda/store/adapters/base.rb', line 41

def exist?(address)
  fail NotImplementedError
end

#get(address) ⇒ Object?

This method is abstract.

Parameters:

  • address (String, Symbol)

Returns:

  • (Object, nil)


19
20
21
# File 'lib/yoda/store/adapters/base.rb', line 19

def get(address)
  fail NotImplementedError
end

#inspectString

Returns:

  • (String)


97
98
99
# File 'lib/yoda/store/adapters/base.rb', line 97

def inspect
  "#<#{self.class.name}: #{self.class.type}>"
end

#keysInteger

This method is abstract.

Returns:

  • (Integer)


47
48
49
# File 'lib/yoda/store/adapters/base.rb', line 47

def keys
  fail NotImplementedError
end

#namespace(name) ⇒ Base

This method is abstract.

Parameters:

  • name (String, Symbol)

Returns:



79
80
81
# File 'lib/yoda/store/adapters/base.rb', line 79

def namespace(name)
  fail NotImplementedError
end

#persistable?Boolean

This method is abstract.

Returns:

  • (Boolean)


85
86
87
# File 'lib/yoda/store/adapters/base.rb', line 85

def persistable?
  fail NotImplementedError
end

#put(address, object) ⇒ void

This method is abstract.

This method returns an undefined value.

Parameters:

  • address (String, Symbol)
  • object (Object)


27
28
29
# File 'lib/yoda/store/adapters/base.rb', line 27

def put(address, object)
  fail NotImplementedError
end

#statsObject

This method is abstract.

Returns:

  • (Object)


53
54
55
# File 'lib/yoda/store/adapters/base.rb', line 53

def stats
  fail NotImplementedError
end

#syncvoid

This method is abstract.

This method returns an undefined value.



59
60
61
# File 'lib/yoda/store/adapters/base.rb', line 59

def sync
  fail NotImplementedError
end