Class: GDBM

Inherits:

Object

Object
GDBM

show all

Includes:: Enumerable

Defined in:: gdbm.c

Overview

Summary

Ruby extension for GNU dbm (gdbm) -- a simple database engine for storing key-value pairs on disk.

Description

GNU dbm is a library for simple databases. A database is a file that stores key-value pairs. Gdbm allows the user to store, retrieve, and delete data by key. It furthermore allows a non-sorted traversal of all key-value pairs. A gdbm database thus provides the same functionality as a hash. As with objects of the Hash class, elements can be accessed with []. Furthermore, GDBM mixes in the Enumerable module, thus providing convenient methods such as #find, #collect, #map, etc.

A process is allowed to open several different databases at the same time. A process can open a database as a "reader" or a "writer". Whereas a reader has only read-access to the database, a writer has read- and write-access. A database can be accessed either by any number of readers or by exactly one writer at the same time.

Examples

Opening/creating a database, and filling it with some entries:

require 'gdbm'

gdbm = GDBM.new("fruitstore.db")
gdbm["ananas"]    = "3"
gdbm["banana"]    = "8"
gdbm["cranberry"] = "4909"
gdbm.close

Reading out a database:

require 'gdbm'

gdbm = GDBM.new("fruitstore.db")
gdbm.each_pair do |key, value|
  print "#{key}: #{value}\n"
end
gdbm.close

produces

banana: 8
ananas: 3
cranberry: 4909

Constant Summary collapse

READER = open database as a reader

INT2FIX(GDBM_READER|RUBY_GDBM_RW_BIT)

WRITER = open database as a writer

INT2FIX(GDBM_WRITER|RUBY_GDBM_RW_BIT)

WRCREAT = open database as a writer; if the database does not exist, create a new one

INT2FIX(GDBM_WRCREAT|RUBY_GDBM_RW_BIT)

NEWDB = open database as a writer; overwrite any existing databases

INT2FIX(GDBM_NEWDB|RUBY_GDBM_RW_BIT)

FAST = flag for #new and #open. this flag is obsolete for gdbm >= 1.8

INT2FIX(GDBM_FAST)

SYNC = flag for #new and #open. only for gdbm >= 1.8

INT2FIX(GDBM_SYNC)

NOLOCK = flag for #new and #open

INT2FIX(GDBM_NOLOCK)

VERSION = version of the gdbm library

rb_str_new2(gdbm_version)

Class Method Summary collapse

.open ⇒ Object

If called without a block, this is synonymous to GDBM::new.

Instance Method Summary collapse

#[](key) ⇒ Object

Retrieves the value corresponding to key.
#[]= ⇒ Object

Associates the value value with the specified key.
#cachesize=(size) ⇒ Object

Sets the size of the internal bucket cache to size.
#clear ⇒ Object

Removes all the key-value pairs within gdbm.
#close ⇒ nil

Closes the associated database file.
#closed? ⇒ Boolean

Returns true if the associated database file has been closed.
#delete(key) ⇒ nil

Removes the key-value-pair with the specified key from this database and returns the corresponding value.
#delete_if ⇒ Object

Deletes every key-value pair from gdbm for which block evaluates to true.
#each_pair {|key, value| ... } ⇒ Object

Executes block for each key in the database, passing the key and the correspoding value as a parameter.
#each_key {|key| ... } ⇒ Object

Executes block for each key in the database, passing the key as a parameter.
#each_pair {|key, value| ... } ⇒ Object

Executes block for each key in the database, passing the key and the correspoding value as a parameter.
#each_value {|value| ... } ⇒ Object

Executes block for each key in the database, passing the corresponding value as a parameter.
#empty? ⇒ Boolean

Returns true if the database is empty.
#fastmode=(boolean) ⇒ Boolean

Turns the database's fast mode on or off.
#fetch(key[, default]) ⇒ Object

Retrieves the value corresponding to key.
#has_key? ⇒ Object

Returns true if the given key k exists within the database.
#has_value? ⇒ Object

Returns true if the given value v exists within the database.
#include? ⇒ Object

Returns true if the given key k exists within the database.
#index ⇒ Object

:nodoc:.
#new(filename, mode = 0666, flags = nil) ⇒ Object constructor

Creates a new GDBM instance by opening a gdbm file named filename.
#invert ⇒ Hash

Returns a hash created by using gdbm's values as keys, and the keys as values.
#key(value) ⇒ Object

Returns the key for a given value.
#key? ⇒ Object

Returns true if the given key k exists within the database.
#keys ⇒ Array

Returns an array of all keys of this database.
#length ⇒ Object

Returns the number of key-value pairs in this database.
#member? ⇒ Object

Returns true if the given key k exists within the database.
#reject {|key, value| ... } ⇒ Hash

Returns a hash copy of gdbm where all key-value pairs from gdbm for which block evaluates to true are removed.
#reject! ⇒ Object

Deletes every key-value pair from gdbm for which block evaluates to true.
#reorganize ⇒ Object

Reorganizes the database file.
#replace(other) ⇒ Object

Replaces the content of gdbm with the key-value pairs of other.
#select {|key, value| ... } ⇒ Array

Returns a new array of all key-value pairs of the database for which block evaluates to true.
#setopt ⇒ Object
#shift ⇒ nil

Removes a key-value-pair from this database and returns it as a two-item array [ key, value ].
#size ⇒ Object

Returns the number of key-value pairs in this database.
#store ⇒ Object

Associates the value value with the specified key.
#sync ⇒ Object

Unless the gdbm object has been opened with the SYNC flag, it is not guarenteed that database modification operations are immediately applied to the database file.
#syncmode=(boolean) ⇒ Boolean

Turns the database's synchronization mode on or off.
#to_a ⇒ Array

Returns an array of all key-value pairs contained in the database.
#to_hash ⇒ Hash

Returns a hash of all key-value pairs contained in the database.
#update(other) ⇒ Object

Adds the key-value pairs of other to gdbm, overwriting entries with duplicate keys with those from other.
#value? ⇒ Object

Returns true if the given value v exists within the database.
#values ⇒ Array

Returns an array of all values of this database.
#values_at(key, ...) ⇒ Array

Returns an array of the values associated with each specified key.

Constructor Details

#new(filename, mode = 0666, flags = nil) ⇒ `Object`

Creates a new GDBM instance by opening a gdbm file named filename. If the file does not exist, a new file with file mode mode will be created. flags may be one of the following:

READER - open as a reader
WRITER - open as a writer
WRCREAT - open as a writer; if the database does not exist, create a new one
NEWDB - open as a writer; overwrite any existing databases

The values WRITER, WRCREAT and NEWDB may be combined with the following values by bitwise or:

SYNC - cause all database operations to be synchronized to the disk
NOLOCK - do not lock the database file

If no flags are specified, the GDBM object will try to open the database file as a writer and will create it if it does not already exist (cf. flag WRCREAT). If this fails (for instance, if another process has already opened the database as a reader), it will try to open the database file as a reader (cf. flag READER).

# File 'gdbm.c'

/*
 * call-seq:
 *      GDBM.new(filename, mode = 0666, flags = nil)
 *
 * Creates a new GDBM instance by opening a gdbm file named _filename_.
 * If the file does not exist, a new file with file mode _mode_ will be
 * created. _flags_ may be one of the following:
 * * *READER*  - open as a reader
 * * *WRITER*  - open as a writer
 * * *WRCREAT* - open as a writer; if the database does not exist, create a new one
 * * *NEWDB*   - open as a writer; overwrite any existing databases
 *
 * The values *WRITER*, *WRCREAT* and *NEWDB* may be combined with the following
 * values by bitwise or:
 * * *SYNC*    - cause all database operations to be synchronized to the disk
 * * *NOLOCK*  - do not lock the database file
 *
 * If no _flags_ are specified, the GDBM object will try to open the database
 * file as a writer and will create it if it does not already exist
 * (cf. flag <tt>WRCREAT</tt>). If this fails (for instance, if another process
 * has already opened the database as a reader), it will try to open the
 * database file as a reader (cf. flag <tt>READER</tt>).
 */
static VALUE
fgdbm_initialize(int argc, VALUE *argv, VALUE obj)
{
    VALUE file, vmode, vflags;
    GDBM_FILE dbm;
    struct dbmdata *dbmp;
    int mode, flags = 0;

    if (rb_scan_args(argc, argv, "12", &file, &vmode, &vflags) == 1) {
        mode = 0666;            /* default value */
    }
    else if (NIL_P(vmode)) {
        mode = -1;              /* return nil if DB does not exist */
    }
    else {
        mode = NUM2INT(vmode);
    }

    if (!NIL_P(vflags))
        flags = NUM2INT(vflags);

    SafeStringValue(file);

    if (flags & RUBY_GDBM_RW_BIT) {
        flags &= ~RUBY_GDBM_RW_BIT;
        dbm = gdbm_open(RSTRING_PTR(file), MY_BLOCK_SIZE,
                        flags, mode, MY_FATAL_FUNC);
    }
    else {
        dbm = 0;
        if (mode >= 0)
            dbm = gdbm_open(RSTRING_PTR(file), MY_BLOCK_SIZE,
                            GDBM_WRCREAT|flags, mode, MY_FATAL_FUNC);
        if (!dbm)
            dbm = gdbm_open(RSTRING_PTR(file), MY_BLOCK_SIZE,
                            GDBM_WRITER|flags, 0, MY_FATAL_FUNC);
        if (!dbm)
            dbm = gdbm_open(RSTRING_PTR(file), MY_BLOCK_SIZE,
                            GDBM_READER|flags, 0, MY_FATAL_FUNC);
    }

    if (!dbm) {
        if (mode == -1) return Qnil;

        if (gdbm_errno == GDBM_FILE_OPEN_ERROR ||
            gdbm_errno == GDBM_CANT_BE_READER ||
            gdbm_errno == GDBM_CANT_BE_WRITER)
            rb_sys_fail(RSTRING_PTR(file));
        else
            rb_raise(rb_eGDBMError, "%s", gdbm_strerror(gdbm_errno));
    }

    dbmp = ALLOC(struct dbmdata);
    free_dbm(DATA_PTR(obj));
    DATA_PTR(obj) = dbmp;
    dbmp->di_dbm = dbm;
    dbmp->di_size = -1;

    return obj;
}

Class Method Details

.open(filename, mode = 0666, flags = nil) ⇒ `Object` .open(filename, mode = 0666, flags = nil) {|gdbm| ... } ⇒ `Object`

If called without a block, this is synonymous to GDBM::new. If a block is given, the new GDBM instance will be passed to the block as a parameter, and the corresponding database file will be closed after the execution of the block code has been finished.

Example for an open call with a block:

require 'gdbm'
GDBM.open("fruitstore.db") do |gdbm|
  gdbm.each_pair do |key, value|
    print "#{key}: #{value}\n"
  end
end

Overloads:

.open(filename, mode = 0666, flags = nil) {|gdbm| ... } ⇒ Object
Yields:
- (gdbm)

# File 'gdbm.c'

/*
 * call-seq:
 *      GDBM.open(filename, mode = 0666, flags = nil)
 *      GDBM.open(filename, mode = 0666, flags = nil) { |gdbm| ... }
 *
 * If called without a block, this is synonymous to GDBM::new.
 * If a block is given, the new GDBM instance will be passed to the block
 * as a parameter, and the corresponding database file will be closed
 * after the execution of the block code has been finished.
 *
 * Example for an open call with a block:
 *
 *   require 'gdbm'
 *   GDBM.open("fruitstore.db") do |gdbm|
 *     gdbm.each_pair do |key, value|
 *       print "#{key}: #{value}\n"
 *     end
 *   end
 */
static VALUE
fgdbm_s_open(int argc, VALUE *argv, VALUE klass)
{
    VALUE obj = Data_Wrap_Struct(klass, 0, free_dbm, 0);

    if (NIL_P(fgdbm_initialize(argc, argv, obj))) {
        return Qnil;
    }

    if (rb_block_given_p()) {
        return rb_ensure(rb_yield, obj, fgdbm_close, obj);
    }

    return obj;
}

Instance Method Details

#[](key) ⇒ `Object`

Retrieves the value corresponding to key.

# File 'gdbm.c'

/*
 * call-seq:
 *      gdbm[key] -> value
 *
 * Retrieves the _value_ corresponding to _key_.
 */
static VALUE
fgdbm_aref(VALUE obj, VALUE keystr)
{
    return rb_gdbm_fetch3(obj, keystr);
}

#[]=(key) ⇒ `Object` #store(key, value) ⇒ `Object`

Associates the value value with the specified key.

# File 'gdbm.c'

/*
 * call-seq:
 *      gdbm[key]= value -> value
 *      gdbm.store(key, value) -> value
 *
 * Associates the value _value_ with the specified _key_.
 */
static VALUE
fgdbm_store(VALUE obj, VALUE keystr, VALUE valstr)
{
    datum key, val;
    struct dbmdata *dbmp;
    GDBM_FILE dbm;

    rb_gdbm_modify(obj);
    StringValue(keystr);
    StringValue(valstr);

    key.dptr = RSTRING_PTR(keystr);
    key.dsize = RSTRING_LEN(keystr);

    val.dptr = RSTRING_PTR(valstr);
    val.dsize = RSTRING_LEN(valstr);

    GetDBM2(obj, dbmp, dbm);
    dbmp->di_size = -1;
    if (gdbm_store(dbm, key, val, GDBM_REPLACE)) {
        if (errno == EPERM) rb_sys_fail(0);
        rb_raise(rb_eGDBMError, "%s", gdbm_strerror(gdbm_errno));
    }

    return valstr;
}

#cachesize=(size) ⇒ `Object`

Sets the size of the internal bucket cache to size.

# File 'gdbm.c'

/*
 * call-seq:
 *     gdbm.cachesize = size -> size
 *
 * Sets the size of the internal bucket cache to _size_.
 */
static VALUE
fgdbm_set_cachesize(VALUE obj, VALUE val)
{
    struct dbmdata *dbmp;
    GDBM_FILE dbm;
    int optval;

    GetDBM2(obj, dbmp, dbm);
    optval = FIX2INT(val);
    if (gdbm_setopt(dbm, GDBM_CACHESIZE, &optval, sizeof(optval)) == -1) {
        rb_raise(rb_eGDBMError, "%s", gdbm_strerror(gdbm_errno));
    }
    return val;
}

#clear ⇒ `Object`

Removes all the key-value pairs within gdbm.

# File 'gdbm.c'

/*
 * call-seq:
 *      gdbm.clear -> gdbm
 *
 * Removes all the key-value pairs within _gdbm_.
 */
static VALUE
fgdbm_clear(VALUE obj)
{
    datum key, nextkey;
    struct dbmdata *dbmp;
    GDBM_FILE dbm;

    rb_gdbm_modify(obj);
    GetDBM2(obj, dbmp, dbm);
    dbmp->di_size = -1;

#if 0
    while (key = gdbm_firstkey(dbm), key.dptr) {
        if (gdbm_delete(dbm, key)) {
            free(key.dptr);
            rb_raise(rb_eGDBMError, "%s", gdbm_strerror(gdbm_errno));
        }
        free(key.dptr);
    }
#else
    while (key = gdbm_firstkey(dbm), key.dptr) {
        for (; key.dptr; key = nextkey) {
            nextkey = gdbm_nextkey(dbm, key);
            if (gdbm_delete(dbm, key)) {
                free(key.dptr);
                if (nextkey.dptr) free(nextkey.dptr);
                rb_raise(rb_eGDBMError, "%s", gdbm_strerror(gdbm_errno));
            }
            free(key.dptr);
        }
    }
#endif
    dbmp->di_size = 0;

    return obj;
}

#close ⇒ `nil`

Closes the associated database file.

Returns:

(nil)

# File 'gdbm.c'

/*
 * call-seq:
 *     gdbm.close -> nil
 *
 * Closes the associated database file.
 */
static VALUE
fgdbm_close(VALUE obj)
{
    struct dbmdata *dbmp;

    GetDBM(obj, dbmp);
    gdbm_close(dbmp->di_dbm);
    dbmp->di_dbm = 0;

    return Qnil;
}

#closed? ⇒ `Boolean`

Returns true if the associated database file has been closed.

Returns:

(Boolean)

# File 'gdbm.c'

/*
 * call-seq:
 *     gdbm.closed?  -> true or false
 *
 * Returns true if the associated database file has been closed.
 */
static VALUE
fgdbm_closed(VALUE obj)
{
    struct dbmdata *dbmp;

    Data_Get_Struct(obj, struct dbmdata, dbmp);
    if (dbmp == 0)
        return Qtrue;
    if (dbmp->di_dbm == 0)
        return Qtrue;

    return Qfalse;
}

#delete(key) ⇒ `nil`

Removes the key-value-pair with the specified key from this database and returns the corresponding value. Returns nil if the database is empty.

Returns:

(nil)

# File 'gdbm.c'

/*
 * call-seq:
 *      gdbm.delete(key) -> value or nil
 *
 * Removes the key-value-pair with the specified _key_ from this database and
 * returns the corresponding _value_. Returns nil if the database is empty.
 */
static VALUE
fgdbm_delete(VALUE obj, VALUE keystr)
{
    VALUE valstr;

    valstr = fgdbm_fetch(obj, keystr, Qnil);
    rb_gdbm_delete(obj, keystr);
    return valstr;
}

#delete_if {|key, value| ... } ⇒ `Object` #reject! {|key, value| ... } ⇒ `Object`

Deletes every key-value pair from gdbm for which block evaluates to true.

Overloads:

#delete_if {|key, value| ... } ⇒ Object
Yields:
- (key, value)
#reject! {|key, value| ... } ⇒ Object
Yields:
- (key, value)

# File 'gdbm.c'

/*
 * call-seq:
 *      gdbm.delete_if { |key, value| block } -> gdbm
 *      gdbm.reject! { |key, value| block } -> gdbm
 *
 * Deletes every key-value pair from _gdbm_ for which _block_ evaluates to true.
 */
static VALUE
fgdbm_delete_if(VALUE obj)
{
    struct dbmdata *dbmp;
    GDBM_FILE dbm;
    VALUE keystr, valstr;
    VALUE ret, ary = rb_ary_new();
    int i, status = 0, n;

    rb_gdbm_modify(obj);
    GetDBM2(obj, dbmp, dbm);
    n = dbmp->di_size;
    dbmp->di_size = -1;

    for (keystr = rb_gdbm_firstkey(dbm); RTEST(keystr);
         keystr = rb_gdbm_nextkey(dbm, keystr)) {

        valstr = rb_gdbm_fetch2(dbm, keystr);
        ret = rb_protect(rb_yield, rb_assoc_new(keystr, valstr), &status);
        if (status != 0) break;
        if (RTEST(ret)) rb_ary_push(ary, keystr);
        GetDBM2(obj, dbmp, dbm);
    }

    for (i = 0; i < RARRAY_LEN(ary); i++)
        rb_gdbm_delete(obj, RARRAY_PTR(ary)[i]);
    if (status) rb_jump_tag(status);
    if (n > 0) dbmp->di_size = n - RARRAY_LEN(ary);

    return obj;
}

#each_pair {|key, value| ... } ⇒ `Object`

Executes block for each key in the database, passing the key and the correspoding value as a parameter.

Yields:

(key, value)

# File 'gdbm.c'

/*
 * call-seq:
 *      gdbm.each_pair { |key, value| block } -> gdbm
 *
 * Executes _block_ for each key in the database, passing the _key_ and the
 * correspoding _value_ as a parameter.
 */
static VALUE
fgdbm_each_pair(VALUE obj)
{
    GDBM_FILE dbm;
    struct dbmdata *dbmp;
    VALUE keystr;

    RETURN_ENUMERATOR(obj, 0, 0);

    GetDBM2(obj, dbmp, dbm);
    for (keystr = rb_gdbm_firstkey(dbm); RTEST(keystr);
         keystr = rb_gdbm_nextkey(dbm, keystr)) {

        rb_yield(rb_assoc_new(keystr, rb_gdbm_fetch2(dbm, keystr)));
        GetDBM2(obj, dbmp, dbm);
    }

    return obj;
}

#each_key {|key| ... } ⇒ `Object`

Executes block for each key in the database, passing the key as a parameter.

Yields:

(key)

# File 'gdbm.c'

/*
 * call-seq:
 *      gdbm.each_key { |key| block } -> gdbm
 *
 * Executes _block_ for each key in the database, passing the
 * _key_ as a parameter.
 */
static VALUE
fgdbm_each_key(VALUE obj)
{
    struct dbmdata *dbmp;
    GDBM_FILE dbm;
    VALUE keystr;

    RETURN_ENUMERATOR(obj, 0, 0);

    GetDBM2(obj, dbmp, dbm);
    for (keystr = rb_gdbm_firstkey(dbm); RTEST(keystr);
         keystr = rb_gdbm_nextkey(dbm, keystr)) {

        rb_yield(keystr);
        GetDBM2(obj, dbmp, dbm);
    }
    return obj;
}

#each_pair {|key, value| ... } ⇒ `Object`

Executes block for each key in the database, passing the key and the correspoding value as a parameter.

Yields:

(key, value)

# File 'gdbm.c'

/*
 * call-seq:
 *      gdbm.each_pair { |key, value| block } -> gdbm
 *
 * Executes _block_ for each key in the database, passing the _key_ and the
 * correspoding _value_ as a parameter.
 */
static VALUE
fgdbm_each_pair(VALUE obj)
{
    GDBM_FILE dbm;
    struct dbmdata *dbmp;
    VALUE keystr;

    RETURN_ENUMERATOR(obj, 0, 0);

    GetDBM2(obj, dbmp, dbm);
    for (keystr = rb_gdbm_firstkey(dbm); RTEST(keystr);
         keystr = rb_gdbm_nextkey(dbm, keystr)) {

        rb_yield(rb_assoc_new(keystr, rb_gdbm_fetch2(dbm, keystr)));
        GetDBM2(obj, dbmp, dbm);
    }

    return obj;
}

#each_value {|value| ... } ⇒ `Object`

Executes block for each key in the database, passing the corresponding value as a parameter.

Yields:

(value)

# File 'gdbm.c'

/*
 * call-seq:
 *      gdbm.each_value { |value| block } -> gdbm
 *
 * Executes _block_ for each key in the database, passing the corresponding
 * _value_ as a parameter.
 */
static VALUE
fgdbm_each_value(VALUE obj)
{
    struct dbmdata *dbmp;
    GDBM_FILE dbm;
    VALUE keystr;

    RETURN_ENUMERATOR(obj, 0, 0);

    GetDBM2(obj, dbmp, dbm);
    for (keystr = rb_gdbm_firstkey(dbm); RTEST(keystr);
         keystr = rb_gdbm_nextkey(dbm, keystr)) {

        rb_yield(rb_gdbm_fetch2(dbm, keystr));
        GetDBM2(obj, dbmp, dbm);
    }
    return obj;
}

#empty? ⇒ `Boolean`

Returns true if the database is empty.

Returns:

(Boolean)

# File 'gdbm.c'

/*
 * call-seq:
 *      gdbm.empty? -> true or false
 *
 * Returns true if the database is empty.
 */
static VALUE
fgdbm_empty_p(VALUE obj)
{
    datum key;
    struct dbmdata *dbmp;
    GDBM_FILE dbm;

    GetDBM(obj, dbmp);
    if (dbmp->di_size < 0) {
        dbm = dbmp->di_dbm;

        key = gdbm_firstkey(dbm);
        if (key.dptr) {
            free(key.dptr);
            return Qfalse;
        }
        return Qtrue;
    }

    if (dbmp->di_size == 0) return Qtrue;
    return Qfalse;
}

#fastmode=(boolean) ⇒ `Boolean`

Turns the database's fast mode on or off. If fast mode is turned on, gdbm does not wait for writes to be flushed to the disk before continuing.

This option is obsolete for gdbm >= 1.8 since fast mode is turned on by default. See also: #syncmode=

Returns:

(Boolean)

# File 'gdbm.c'

/*
 * call-seq:
 *     gdbm.fastmode = boolean -> boolean
 *
 * Turns the database's fast mode on or off. If fast mode is turned on, gdbm
 * does not wait for writes to be flushed to the disk before continuing.
 *
 * This option is obsolete for gdbm >= 1.8 since fast mode is turned on by
 * default. See also: #syncmode=
 */
static VALUE
fgdbm_set_fastmode(VALUE obj, VALUE val)
{
    struct dbmdata *dbmp;
    GDBM_FILE dbm;
    int optval;

    GetDBM2(obj, dbmp, dbm);
    optval = 0;
    if (RTEST(val))
        optval = 1;

    if (gdbm_setopt(dbm, GDBM_FASTMODE, &optval, sizeof(optval)) == -1) {
        rb_raise(rb_eGDBMError, "%s", gdbm_strerror(gdbm_errno));
    }
    return val;
}

#fetch(key[, default]) ⇒ `Object`

Retrieves the value corresponding to key. If there is no value associated with key, default will be returned instead.

# File 'gdbm.c'

/*
 * call-seq:
 *      gdbm.fetch(key [, default]) -> value
 *
 * Retrieves the _value_ corresponding to _key_. If there is no value
 * associated with _key_, _default_ will be returned instead.
 */
static VALUE
fgdbm_fetch_m(int argc, VALUE *argv, VALUE obj)
{
    VALUE keystr, valstr, ifnone;

    rb_scan_args(argc, argv, "11", &keystr, &ifnone);
    valstr = fgdbm_fetch(obj, keystr, ifnone);
    if (argc == 1 && !rb_block_given_p() && NIL_P(valstr))
        rb_raise(rb_eIndexError, "key not found");

    return valstr;
}

#has_key?(k) ⇒ `Boolean` #key?(k) ⇒ `Boolean`

Returns true if the given key k exists within the database. Returns false otherwise.

Overloads:

#has_key?(k) ⇒ Boolean
Returns:
- (Boolean)
#key?(k) ⇒ Boolean
Returns:
- (Boolean)

# File 'gdbm.c'

/*
 * call-seq:
 *      gdbm.has_key?(k) -> true or false
 *      gdbm.key?(k) -> true or false
 *
 * Returns true if the given key _k_ exists within the database.
 * Returns false otherwise.
 */
static VALUE
fgdbm_has_key(VALUE obj, VALUE keystr)
{
    datum key;
    struct dbmdata *dbmp;
    GDBM_FILE dbm;

    StringValue(keystr);
    key.dptr = RSTRING_PTR(keystr);
    key.dsize = RSTRING_LEN(keystr);

    GetDBM2(obj, dbmp, dbm);
    if (gdbm_exists(dbm, key))
        return Qtrue;
    return Qfalse;
}

#has_value?(v) ⇒ `Boolean` #value?(v) ⇒ `Boolean`

Returns true if the given value v exists within the database. Returns false otherwise.

Overloads:

#has_value?(v) ⇒ Boolean
Returns:
- (Boolean)
#value?(v) ⇒ Boolean
Returns:
- (Boolean)

# File 'gdbm.c'

/*
 * call-seq:
 *      gdbm.has_value?(v) -> true or false
 *      gdbm.value?(v) -> true or false
 *
 * Returns true if the given value _v_ exists within the database.
 * Returns false otherwise.
 */
static VALUE
fgdbm_has_value(VALUE obj, VALUE valstr)
{
    struct dbmdata *dbmp;
    GDBM_FILE dbm;
    VALUE keystr, valstr2;

    StringValue(valstr);
    GetDBM2(obj, dbmp, dbm);
    for (keystr = rb_gdbm_firstkey(dbm); RTEST(keystr);
         keystr = rb_gdbm_nextkey(dbm, keystr)) {

        valstr2 = rb_gdbm_fetch2(dbm, keystr);

        if (!NIL_P(valstr2) &&
            RSTRING_LEN(valstr) == RSTRING_LEN(valstr2) &&
            memcmp(RSTRING_PTR(valstr), RSTRING_PTR(valstr2),
                   RSTRING_LEN(valstr)) == 0) {
            return Qtrue;
        }
    }
    return Qfalse;
}

#has_key?(k) ⇒ `Boolean` #key?(k) ⇒ `Boolean`

Returns true if the given key k exists within the database. Returns false otherwise.

Overloads:

#has_key?(k) ⇒ Boolean
Returns:
- (Boolean)
#key?(k) ⇒ Boolean
Returns:
- (Boolean)

# File 'gdbm.c'

/*
 * call-seq:
 *      gdbm.has_key?(k) -> true or false
 *      gdbm.key?(k) -> true or false
 *
 * Returns true if the given key _k_ exists within the database.
 * Returns false otherwise.
 */
static VALUE
fgdbm_has_key(VALUE obj, VALUE keystr)
{
    datum key;
    struct dbmdata *dbmp;
    GDBM_FILE dbm;

    StringValue(keystr);
    key.dptr = RSTRING_PTR(keystr);
    key.dsize = RSTRING_LEN(keystr);

    GetDBM2(obj, dbmp, dbm);
    if (gdbm_exists(dbm, key))
        return Qtrue;
    return Qfalse;
}

#index ⇒ `Object`

:nodoc:

# File 'gdbm.c'

/* :nodoc: */
static VALUE
fgdbm_index(VALUE obj, VALUE value)
{
    rb_warn("GDBM#index is deprecated; use GDBM#key");
    return fgdbm_key(obj, value);
}

#invert ⇒ `Hash`

Returns a hash created by using gdbm's values as keys, and the keys as values.

Returns:

(Hash)

# File 'gdbm.c'

/*
 * call-seq:
 *     gdbm.invert  -> hash
 *
 * Returns a hash created by using _gdbm_'s values as keys, and the keys
 * as values.
 */
static VALUE
fgdbm_invert(VALUE obj)
{
    struct dbmdata *dbmp;
    GDBM_FILE dbm;
    VALUE keystr, valstr;
    VALUE hash = rb_hash_new();

    GetDBM2(obj, dbmp, dbm);
    for (keystr = rb_gdbm_firstkey(dbm); RTEST(keystr);
         keystr = rb_gdbm_nextkey(dbm, keystr)) {
        valstr = rb_gdbm_fetch2(dbm, keystr);

        rb_hash_aset(hash, valstr, keystr);
    }
    return hash;
}

#key(value) ⇒ `Object`

Returns the key for a given value. If several keys may map to the same value, the key that is found first will be returned.

# File 'gdbm.c'

/*
 * call-seq:
 *      gdbm.key(value) -> key
 *
 * Returns the _key_ for a given _value_. If several keys may map to the
 * same value, the key that is found first will be returned.
 */
static VALUE
fgdbm_key(VALUE obj, VALUE valstr)
{
    struct dbmdata *dbmp;
    GDBM_FILE dbm;
    VALUE keystr, valstr2;

    StringValue(valstr);
    GetDBM2(obj, dbmp, dbm);
    for (keystr = rb_gdbm_firstkey(dbm); RTEST(keystr);
         keystr = rb_gdbm_nextkey(dbm, keystr)) {

        valstr2 = rb_gdbm_fetch2(dbm, keystr);
        if (!NIL_P(valstr2) &&
            RSTRING_LEN(valstr) == RSTRING_LEN(valstr2) &&
            memcmp(RSTRING_PTR(valstr), RSTRING_PTR(valstr2),
                   RSTRING_LEN(valstr)) == 0) {
            return keystr;
        }
    }
    return Qnil;
}

#has_key?(k) ⇒ `Boolean` #key?(k) ⇒ `Boolean`

Returns true if the given key k exists within the database. Returns false otherwise.

Overloads:

#has_key?(k) ⇒ Boolean
Returns:
- (Boolean)
#key?(k) ⇒ Boolean
Returns:
- (Boolean)

# File 'gdbm.c'

/*
 * call-seq:
 *      gdbm.has_key?(k) -> true or false
 *      gdbm.key?(k) -> true or false
 *
 * Returns true if the given key _k_ exists within the database.
 * Returns false otherwise.
 */
static VALUE
fgdbm_has_key(VALUE obj, VALUE keystr)
{
    datum key;
    struct dbmdata *dbmp;
    GDBM_FILE dbm;

    StringValue(keystr);
    key.dptr = RSTRING_PTR(keystr);
    key.dsize = RSTRING_LEN(keystr);

    GetDBM2(obj, dbmp, dbm);
    if (gdbm_exists(dbm, key))
        return Qtrue;
    return Qfalse;
}

#keys ⇒ `Array`

Returns an array of all keys of this database.

Returns:

(Array)

# File 'gdbm.c'

/*
 * call-seq:
 *      gdbm.keys -> array
 *
 * Returns an array of all keys of this database.
 */
static VALUE
fgdbm_keys(VALUE obj)
{
    struct dbmdata *dbmp;
    GDBM_FILE dbm;
    VALUE keystr, ary;

    GetDBM2(obj, dbmp, dbm);
    ary = rb_ary_new();
    for (keystr = rb_gdbm_firstkey(dbm); RTEST(keystr);
         keystr = rb_gdbm_nextkey(dbm, keystr)) {

        rb_ary_push(ary, keystr);
    }

    return ary;
}

#length ⇒ `Fixnum` #size ⇒ `Fixnum`

Returns the number of key-value pairs in this database.

Overloads:

#length ⇒ Fixnum
Returns:
- (Fixnum)
#size ⇒ Fixnum
Returns:
- (Fixnum)

# File 'gdbm.c'

/*
 * call-seq:
 *      gdbm.length -> fixnum
 *      gdbm.size -> fixnum
 *
 * Returns the number of key-value pairs in this database.
 */
static VALUE
fgdbm_length(VALUE obj)
{
    datum key, nextkey;
    struct dbmdata *dbmp;
    GDBM_FILE dbm;
    int i = 0;

    GetDBM2(obj, dbmp, dbm);
    if (dbmp->di_size > 0) return INT2FIX(dbmp->di_size);

    for (key = gdbm_firstkey(dbm); key.dptr; key = nextkey) {
        nextkey = gdbm_nextkey(dbm, key);
        free(key.dptr);
        i++;
    }
    dbmp->di_size = i;

    return INT2FIX(i);
}

#has_key?(k) ⇒ `Boolean` #key?(k) ⇒ `Boolean`

Returns true if the given key k exists within the database. Returns false otherwise.

Overloads:

#has_key?(k) ⇒ Boolean
Returns:
- (Boolean)
#key?(k) ⇒ Boolean
Returns:
- (Boolean)

# File 'gdbm.c'

/*
 * call-seq:
 *      gdbm.has_key?(k) -> true or false
 *      gdbm.key?(k) -> true or false
 *
 * Returns true if the given key _k_ exists within the database.
 * Returns false otherwise.
 */
static VALUE
fgdbm_has_key(VALUE obj, VALUE keystr)
{
    datum key;
    struct dbmdata *dbmp;
    GDBM_FILE dbm;

    StringValue(keystr);
    key.dptr = RSTRING_PTR(keystr);
    key.dsize = RSTRING_LEN(keystr);

    GetDBM2(obj, dbmp, dbm);
    if (gdbm_exists(dbm, key))
        return Qtrue;
    return Qfalse;
}

#reject {|key, value| ... } ⇒ `Hash`

Returns a hash copy of gdbm where all key-value pairs from gdbm for which block evaluates to true are removed. See also: #delete_if

Yields:

(key, value)

Returns:

(Hash)

# File 'gdbm.c'

/*
 * call-seq:
 *      gdbm.reject { |key, value| block } -> hash
 *
 * Returns a hash copy of _gdbm_ where all key-value pairs from _gdbm_ for
 * which _block_ evaluates to true are removed. See also: #delete_if
 */
static VALUE
fgdbm_reject(VALUE obj)
{
    return rb_hash_delete_if(fgdbm_to_hash(obj));
}

#delete_if {|key, value| ... } ⇒ `Object` #reject! {|key, value| ... } ⇒ `Object`

Deletes every key-value pair from gdbm for which block evaluates to true.

Overloads:

#delete_if {|key, value| ... } ⇒ Object
Yields:
- (key, value)
#reject! {|key, value| ... } ⇒ Object
Yields:
- (key, value)

# File 'gdbm.c'

/*
 * call-seq:
 *      gdbm.delete_if { |key, value| block } -> gdbm
 *      gdbm.reject! { |key, value| block } -> gdbm
 *
 * Deletes every key-value pair from _gdbm_ for which _block_ evaluates to true.
 */
static VALUE
fgdbm_delete_if(VALUE obj)
{
    struct dbmdata *dbmp;
    GDBM_FILE dbm;
    VALUE keystr, valstr;
    VALUE ret, ary = rb_ary_new();
    int i, status = 0, n;

    rb_gdbm_modify(obj);
    GetDBM2(obj, dbmp, dbm);
    n = dbmp->di_size;
    dbmp->di_size = -1;

    for (keystr = rb_gdbm_firstkey(dbm); RTEST(keystr);
         keystr = rb_gdbm_nextkey(dbm, keystr)) {

        valstr = rb_gdbm_fetch2(dbm, keystr);
        ret = rb_protect(rb_yield, rb_assoc_new(keystr, valstr), &status);
        if (status != 0) break;
        if (RTEST(ret)) rb_ary_push(ary, keystr);
        GetDBM2(obj, dbmp, dbm);
    }

    for (i = 0; i < RARRAY_LEN(ary); i++)
        rb_gdbm_delete(obj, RARRAY_PTR(ary)[i]);
    if (status) rb_jump_tag(status);
    if (n > 0) dbmp->di_size = n - RARRAY_LEN(ary);

    return obj;
}

#reorganize ⇒ `Object`

Reorganizes the database file. This operation removes reserved space of elements that have already been deleted. It is only useful after a lot of deletions in the database.

# File 'gdbm.c'

/*
 * call-seq:
 *     gdbm.reorganize -> gdbm
 *
 * Reorganizes the database file. This operation removes reserved space of
 * elements that have already been deleted. It is only useful after a lot of
 * deletions in the database.
 */
static VALUE
fgdbm_reorganize(VALUE obj)
{
    struct dbmdata *dbmp;
    GDBM_FILE dbm;

    rb_gdbm_modify(obj);
    GetDBM2(obj, dbmp, dbm);
    gdbm_reorganize(dbm);
    return obj;
}

#replace(other) ⇒ `Object`

Replaces the content of gdbm with the key-value pairs of other. other must have an each_pair method.

# File 'gdbm.c'

/*
 * call-seq:
 *     gdbm.replace(other) -> gdbm
 *
 * Replaces the content of _gdbm_ with the key-value pairs of _other_.
 * _other_ must have an each_pair method.
 */
static VALUE
fgdbm_replace(VALUE obj, VALUE other)
{
    fgdbm_clear(obj);
    rb_block_call(other, rb_intern("each_pair"), 0, 0, update_i, obj);
    return obj;
}

#select {|key, value| ... } ⇒ `Array`

Returns a new array of all key-value pairs of the database for which block evaluates to true.

Yields:

(key, value)

Returns:

(Array)

# File 'gdbm.c'

/*
 * call-seq:
 *      gdbm.select { |key, value| block } -> array
 *
 * Returns a new array of all key-value pairs of the database for which _block_
 * evaluates to true.
 */
static VALUE
fgdbm_select(VALUE obj)
{
    VALUE new = rb_ary_new();
    GDBM_FILE dbm;
    struct dbmdata *dbmp;
    VALUE keystr;

    GetDBM2(obj, dbmp, dbm);
    for (keystr = rb_gdbm_firstkey(dbm); RTEST(keystr);
         keystr = rb_gdbm_nextkey(dbm, keystr)) {
        VALUE assoc = rb_assoc_new(keystr, rb_gdbm_fetch2(dbm, keystr));
        VALUE v = rb_yield(assoc);

        if (RTEST(v)) {
            rb_ary_push(new, assoc);
        }
        GetDBM2(obj, dbmp, dbm);
    }

    return new;
}

#setopt ⇒ `Object`

#shift ⇒ `nil`

Removes a key-value-pair from this database and returns it as a two-item array [ key, value ]. Returns nil if the database is empty.

Returns:

(nil)

# File 'gdbm.c'

/*
 * call-seq:
 *      gdbm.shift -> (key, value) or nil
 *
 * Removes a key-value-pair from this database and returns it as a
 * two-item array [ _key_, _value_ ]. Returns nil if the database is empty.
 */
static VALUE
fgdbm_shift(VALUE obj)
{
    struct dbmdata *dbmp;
    GDBM_FILE dbm;
    VALUE keystr, valstr;

    rb_gdbm_modify(obj);
    GetDBM2(obj, dbmp, dbm);
    keystr = rb_gdbm_firstkey(dbm);
    if (NIL_P(keystr)) return Qnil;
    valstr = rb_gdbm_fetch2(dbm, keystr);
    rb_gdbm_delete(obj, keystr);

    return rb_assoc_new(keystr, valstr);
}

#length ⇒ `Fixnum` #size ⇒ `Fixnum`

Returns the number of key-value pairs in this database.

Overloads:

#length ⇒ Fixnum
Returns:
- (Fixnum)
#size ⇒ Fixnum
Returns:
- (Fixnum)

# File 'gdbm.c'

/*
 * call-seq:
 *      gdbm.length -> fixnum
 *      gdbm.size -> fixnum
 *
 * Returns the number of key-value pairs in this database.
 */
static VALUE
fgdbm_length(VALUE obj)
{
    datum key, nextkey;
    struct dbmdata *dbmp;
    GDBM_FILE dbm;
    int i = 0;

    GetDBM2(obj, dbmp, dbm);
    if (dbmp->di_size > 0) return INT2FIX(dbmp->di_size);

    for (key = gdbm_firstkey(dbm); key.dptr; key = nextkey) {
        nextkey = gdbm_nextkey(dbm, key);
        free(key.dptr);
        i++;
    }
    dbmp->di_size = i;

    return INT2FIX(i);
}

#[]=(key) ⇒ `Object` #store(key, value) ⇒ `Object`

Associates the value value with the specified key.

# File 'gdbm.c'

/*
 * call-seq:
 *      gdbm[key]= value -> value
 *      gdbm.store(key, value) -> value
 *
 * Associates the value _value_ with the specified _key_.
 */
static VALUE
fgdbm_store(VALUE obj, VALUE keystr, VALUE valstr)
{
    datum key, val;
    struct dbmdata *dbmp;
    GDBM_FILE dbm;

    rb_gdbm_modify(obj);
    StringValue(keystr);
    StringValue(valstr);

    key.dptr = RSTRING_PTR(keystr);
    key.dsize = RSTRING_LEN(keystr);

    val.dptr = RSTRING_PTR(valstr);
    val.dsize = RSTRING_LEN(valstr);

    GetDBM2(obj, dbmp, dbm);
    dbmp->di_size = -1;
    if (gdbm_store(dbm, key, val, GDBM_REPLACE)) {
        if (errno == EPERM) rb_sys_fail(0);
        rb_raise(rb_eGDBMError, "%s", gdbm_strerror(gdbm_errno));
    }

    return valstr;
}

#sync ⇒ `Object`

Unless the gdbm object has been opened with the SYNC flag, it is not guarenteed that database modification operations are immediately applied to the database file. This method ensures that all recent modifications to the database are written to the file. Blocks until all writing operations to the disk have been finished.

# File 'gdbm.c'

/*
 * call-seq:
 *     gdbm.sync -> gdbm
 *
 * Unless the _gdbm_ object has been opened with the *SYNC* flag, it is not
 * guarenteed that database modification operations are immediately applied to
 * the database file. This method ensures that all recent modifications
 * to the database are written to the file. Blocks until all writing operations
 * to the disk have been finished.
 */
static VALUE
fgdbm_sync(VALUE obj)
{
    struct dbmdata *dbmp;
    GDBM_FILE dbm;

    rb_gdbm_modify(obj);
    GetDBM2(obj, dbmp, dbm);
    gdbm_sync(dbm);
    return obj;
}

#syncmode=(boolean) ⇒ `Boolean`

Turns the database's synchronization mode on or off. If the synchronization mode is turned on, the database's in-memory state will be synchronized to disk after every database modification operation. If the synchronization mode is turned off, GDBM does not wait for writes to be flushed to the disk before continuing.

This option is only available for gdbm >= 1.8 where syncmode is turned off by default. See also: #fastmode=

Returns:

(Boolean)

# File 'gdbm.c'

/*
 * call-seq:
 *     gdbm.syncmode = boolean -> boolean
 *
 * Turns the database's synchronization mode on or off. If the synchronization
 * mode is turned on, the database's in-memory state will be synchronized to
 * disk after every database modification operation. If the synchronization
 * mode is turned off, GDBM does not wait for writes to be flushed to the disk
 * before continuing.
 *
 * This option is only available for gdbm >= 1.8 where syncmode is turned off
 * by default. See also: #fastmode=
 */
static VALUE
fgdbm_set_syncmode(VALUE obj, VALUE val)
{
#if !defined(GDBM_SYNCMODE)
    fgdbm_set_fastmode(obj, RTEST(val) ? Qfalse : Qtrue);
    return val;
#else
    struct dbmdata *dbmp;
    GDBM_FILE dbm;
    int optval;

    GetDBM2(obj, dbmp, dbm);
    optval = 0;
    if (RTEST(val))
        optval = 1;

    if (gdbm_setopt(dbm, GDBM_FASTMODE, &optval, sizeof(optval)) == -1) {
        rb_raise(rb_eGDBMError, "%s", gdbm_strerror(gdbm_errno));
    }
    return val;
#endif
}

#to_a ⇒ `Array`

Returns an array of all key-value pairs contained in the database.

Returns:

(Array)

# File 'gdbm.c'

/*
 * call-seq:
 *     gdbm.to_a -> array
 *
 * Returns an array of all key-value pairs contained in the database.
 */
static VALUE
fgdbm_to_a(VALUE obj)
{
    struct dbmdata *dbmp;
    GDBM_FILE dbm;
    VALUE keystr, ary;

    GetDBM2(obj, dbmp, dbm);
    ary = rb_ary_new();
    for (keystr = rb_gdbm_firstkey(dbm); RTEST(keystr);
         keystr = rb_gdbm_nextkey(dbm, keystr)) {

        rb_ary_push(ary, rb_assoc_new(keystr, rb_gdbm_fetch2(dbm, keystr)));
    }

    return ary;
}

#to_hash ⇒ `Hash`

Returns a hash of all key-value pairs contained in the database.

Returns:

(Hash)

# File 'gdbm.c'

/*
 * call-seq:
 *     gdbm.to_hash -> hash
 *
 * Returns a hash of all key-value pairs contained in the database.
 */
static VALUE
fgdbm_to_hash(VALUE obj)
{
    struct dbmdata *dbmp;
    GDBM_FILE dbm;
    VALUE keystr, hash;

    GetDBM2(obj, dbmp, dbm);
    hash = rb_hash_new();
    for (keystr = rb_gdbm_firstkey(dbm); RTEST(keystr);
         keystr = rb_gdbm_nextkey(dbm, keystr)) {

        rb_hash_aset(hash, keystr, rb_gdbm_fetch2(dbm, keystr));
    }

    return hash;
}

#update(other) ⇒ `Object`

Adds the key-value pairs of other to gdbm, overwriting entries with duplicate keys with those from other. other must have an each_pair method.

# File 'gdbm.c'

/*
 * call-seq:
 *     gdbm.update(other) -> gdbm
 *
 * Adds the key-value pairs of _other_ to _gdbm_, overwriting entries with
 * duplicate keys with those from _other_. _other_ must have an each_pair
 * method.
 */
static VALUE
fgdbm_update(VALUE obj, VALUE other)
{
    rb_block_call(other, rb_intern("each_pair"), 0, 0, update_i, obj);
    return obj;
}

#has_value?(v) ⇒ `Boolean` #value?(v) ⇒ `Boolean`

Returns true if the given value v exists within the database. Returns false otherwise.

Overloads:

#has_value?(v) ⇒ Boolean
Returns:
- (Boolean)
#value?(v) ⇒ Boolean
Returns:
- (Boolean)

# File 'gdbm.c'

/*
 * call-seq:
 *      gdbm.has_value?(v) -> true or false
 *      gdbm.value?(v) -> true or false
 *
 * Returns true if the given value _v_ exists within the database.
 * Returns false otherwise.
 */
static VALUE
fgdbm_has_value(VALUE obj, VALUE valstr)
{
    struct dbmdata *dbmp;
    GDBM_FILE dbm;
    VALUE keystr, valstr2;

    StringValue(valstr);
    GetDBM2(obj, dbmp, dbm);
    for (keystr = rb_gdbm_firstkey(dbm); RTEST(keystr);
         keystr = rb_gdbm_nextkey(dbm, keystr)) {

        valstr2 = rb_gdbm_fetch2(dbm, keystr);

        if (!NIL_P(valstr2) &&
            RSTRING_LEN(valstr) == RSTRING_LEN(valstr2) &&
            memcmp(RSTRING_PTR(valstr), RSTRING_PTR(valstr2),
                   RSTRING_LEN(valstr)) == 0) {
            return Qtrue;
        }
    }
    return Qfalse;
}

#values ⇒ `Array`

Returns an array of all values of this database.

Returns:

(Array)

# File 'gdbm.c'

/*
 * call-seq:
 *      gdbm.values -> array
 *
 * Returns an array of all values of this database.
 */
static VALUE
fgdbm_values(VALUE obj)
{
    datum key, nextkey;
    struct dbmdata *dbmp;
    GDBM_FILE dbm;
    VALUE valstr, ary;

    GetDBM2(obj, dbmp, dbm);
    ary = rb_ary_new();
    for (key = gdbm_firstkey(dbm); key.dptr; key = nextkey) {
        nextkey = gdbm_nextkey(dbm, key);
        valstr = rb_gdbm_fetch(dbm, key);
        free(key.dptr);
        rb_ary_push(ary, valstr);
    }

    return ary;
}

#values_at(key, ...) ⇒ `Array`

Returns an array of the values associated with each specified key.

Returns:

(Array)

# File 'gdbm.c'

/*
 * call-seq:
 *      gdbm.values_at(key, ...) -> array
 *
 * Returns an array of the values associated with each specified _key_.
 */
static VALUE
fgdbm_values_at(int argc, VALUE *argv, VALUE obj)
{
    VALUE new = rb_ary_new2(argc);
    int i;

    for (i=0; i<argc; i++) {
        rb_ary_push(new, rb_gdbm_fetch3(obj, argv[i]));
    }

    return new;
}

Class: GDBM

Overview

Summary

Description

Examples

Links

Constant Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#new(filename, mode = 0666, flags = nil) ⇒ Object

Class Method Details

.open(filename, mode = 0666, flags = nil) ⇒ Object .open(filename, mode = 0666, flags = nil) {|gdbm| ... } ⇒ Object

Instance Method Details

#[](key) ⇒ Object

#[]=(key) ⇒ Object #store(key, value) ⇒ Object

#cachesize=(size) ⇒ Object

#clear ⇒ Object

#close ⇒ nil

#closed? ⇒ Boolean

#delete(key) ⇒ nil

#delete_if {|key, value| ... } ⇒ Object #reject! {|key, value| ... } ⇒ Object

#each_pair {|key, value| ... } ⇒ Object

#each_key {|key| ... } ⇒ Object

#each_pair {|key, value| ... } ⇒ Object

#each_value {|value| ... } ⇒ Object

#empty? ⇒ Boolean

#fastmode=(boolean) ⇒ Boolean

#fetch(key[, default]) ⇒ Object

#has_key?(k) ⇒ Boolean #key?(k) ⇒ Boolean

#has_value?(v) ⇒ Boolean #value?(v) ⇒ Boolean

#has_key?(k) ⇒ Boolean #key?(k) ⇒ Boolean

#index ⇒ Object

#invert ⇒ Hash

#key(value) ⇒ Object

#has_key?(k) ⇒ Boolean #key?(k) ⇒ Boolean

#keys ⇒ Array

#length ⇒ Fixnum #size ⇒ Fixnum

#has_key?(k) ⇒ Boolean #key?(k) ⇒ Boolean

#reject {|key, value| ... } ⇒ Hash

#delete_if {|key, value| ... } ⇒ Object #reject! {|key, value| ... } ⇒ Object

#reorganize ⇒ Object

#replace(other) ⇒ Object

#select {|key, value| ... } ⇒ Array

#setopt ⇒ Object

#shift ⇒ nil

#length ⇒ Fixnum #size ⇒ Fixnum

#[]=(key) ⇒ Object #store(key, value) ⇒ Object

#sync ⇒ Object

#syncmode=(boolean) ⇒ Boolean

#to_a ⇒ Array

#to_hash ⇒ Hash

#update(other) ⇒ Object

#has_value?(v) ⇒ Boolean #value?(v) ⇒ Boolean

#values ⇒ Array

#values_at(key, ...) ⇒ Array

#new(filename, mode = 0666, flags = nil) ⇒ `Object`

.open(filename, mode = 0666, flags = nil) ⇒ `Object` .open(filename, mode = 0666, flags = nil) {|gdbm| ... } ⇒ `Object`

#[](key) ⇒ `Object`

#[]=(key) ⇒ `Object` #store(key, value) ⇒ `Object`

#cachesize=(size) ⇒ `Object`

#clear ⇒ `Object`

#close ⇒ `nil`

#closed? ⇒ `Boolean`

#delete(key) ⇒ `nil`

#delete_if {|key, value| ... } ⇒ `Object` #reject! {|key, value| ... } ⇒ `Object`

#each_pair {|key, value| ... } ⇒ `Object`

#each_key {|key| ... } ⇒ `Object`

#each_pair {|key, value| ... } ⇒ `Object`

#each_value {|value| ... } ⇒ `Object`

#empty? ⇒ `Boolean`

#fastmode=(boolean) ⇒ `Boolean`

#fetch(key[, default]) ⇒ `Object`

#has_key?(k) ⇒ `Boolean` #key?(k) ⇒ `Boolean`

#has_value?(v) ⇒ `Boolean` #value?(v) ⇒ `Boolean`

#has_key?(k) ⇒ `Boolean` #key?(k) ⇒ `Boolean`

#index ⇒ `Object`

#invert ⇒ `Hash`

#key(value) ⇒ `Object`

#has_key?(k) ⇒ `Boolean` #key?(k) ⇒ `Boolean`

#keys ⇒ `Array`

#length ⇒ `Fixnum` #size ⇒ `Fixnum`

#has_key?(k) ⇒ `Boolean` #key?(k) ⇒ `Boolean`

#reject {|key, value| ... } ⇒ `Hash`

#delete_if {|key, value| ... } ⇒ `Object` #reject! {|key, value| ... } ⇒ `Object`

#reorganize ⇒ `Object`

#replace(other) ⇒ `Object`

#select {|key, value| ... } ⇒ `Array`

#setopt ⇒ `Object`

#shift ⇒ `nil`

#length ⇒ `Fixnum` #size ⇒ `Fixnum`

#[]=(key) ⇒ `Object` #store(key, value) ⇒ `Object`

#sync ⇒ `Object`

#syncmode=(boolean) ⇒ `Boolean`

#to_a ⇒ `Array`

#to_hash ⇒ `Hash`

#update(other) ⇒ `Object`

#has_value?(v) ⇒ `Boolean` #value?(v) ⇒ `Boolean`

#values ⇒ `Array`

#values_at(key, ...) ⇒ `Array`