Class: Cinch::Storage

Inherits:
Object
  • Object
show all
Includes:
Enumerable
Defined in:
lib/cinch/storage.rb,
lib/cinch/storage/null.rb,
lib/cinch/storage/yaml.rb

Overview

Note:

The interface of this class isn’t fixed yet. You shouldn’t use it yet.

Direct Known Subclasses

Null, YAML

Defined Under Namespace

Classes: Null, YAML

Instance Method Summary (collapse)

Constructor Details

- (Storage) initialize(options, plugin)

A new instance of Storage

Parameters:

  • options (Hash)
  • plugin (Plugin)


9
10
# File 'lib/cinch/storage.rb', line 9

def initialize(options, plugin)
end

Instance Method Details

- (Object?) [](key)

Parameters:

  • key (Object)

Returns:

  • (Object, nil)


14
15
# File 'lib/cinch/storage.rb', line 14

def [](key)
end

- (value) []=(key, value)

Parameters:

  • key (Object)
  • value (Object)

Returns:

  • (value)


20
21
# File 'lib/cinch/storage.rb', line 20

def []=(key, value)
end

- (Object?) delete(key)

The deleted object

Parameters:

  • key (Object)

Returns:

  • (Object, nil)

    The deleted object



49
50
# File 'lib/cinch/storage.rb', line 49

def delete(key)
end

- (self) delete_if

Returns:

  • (self)


53
54
55
# File 'lib/cinch/storage.rb', line 53

def delete_if
  self
end

- (self) each

Returns:

  • (self)


24
25
26
# File 'lib/cinch/storage.rb', line 24

def each
  self
end

- (self) each_key

Returns:

  • (self)


29
30
31
# File 'lib/cinch/storage.rb', line 29

def each_key
  self
end

- (self) each_value

Returns:

  • (self)


34
35
36
# File 'lib/cinch/storage.rb', line 34

def each_value
  self
end

- (Boolean) has_key?(key) Also known as: include?, key?, member?

Parameters:

  • key (Object)

Returns:

  • (Boolean)


40
41
42
# File 'lib/cinch/storage.rb', line 40

def has_key?(key)
  false
end

- (Object) save



57
58
# File 'lib/cinch/storage.rb', line 57

def save
end

- (Object) unload



60
61
# File 'lib/cinch/storage.rb', line 60

def unload
end