rbs 2.0.0 → 2.1.0

data/stdlib/dbm/0/dbm.rbs

@@ -1,7 +1,8 @@
+# <!-- rdoc-file=ext/dbm/dbm.c -->
 # ## Introduction
 #
 # The DBM class provides a wrapper to a Unix-style
-# [dbm](http://en.wikipedia.org/wiki/Dbm) or Database Manager library.
+# [dbm](https://en.wikipedia.org/wiki/Dbm) or Database Manager library.
 #
 # Dbm databases do not have tables or columns; they are simple key-value data
 # stores, like a Ruby Hash except not resident in RAM. Keys and values must be
@@ -13,8 +14,8 @@
 # *   The original ndbm library is released in 4.3BSD. It is based on dbm
 #     library in Unix Version 7 but has different API to support multiple
 #     databases in a process.
-# *   [Berkeley DB](http://en.wikipedia.org/wiki/Berkeley_DB) versions 1 thru 6,
-#     also known as BDB and Sleepycat DB, now owned by Oracle Corporation.
+# *   [Berkeley DB](https://en.wikipedia.org/wiki/Berkeley_DB) versions 1 thru
+#     6, also known as BDB and Sleepycat DB, now owned by Oracle Corporation.
 # *   Berkeley DB 1.x, still found in 4.4BSD derivatives (FreeBSD, OpenBSD,
 #     etc).
 # *   [gdbm](http://www.gnu.org/software/gdbm/), the GNU implementation of dbm.
@@ -61,8 +62,13 @@
 #     puts db['822']
 #
 class DBM
-  include Enumerable[[String, String]]
+  include Enumerable[[ String, String ]]
 
+  # <!--
+  #   rdoc-file=ext/dbm/dbm.c
+  #   - DBM.open(filename[, mode[, flags]]) -> dbm
+  #   - DBM.open(filename[, mode[, flags]]) {|dbm| block}
+  # -->
   # Open a dbm database and yields it if a block is given. See also `DBM.new`.
   #
   def self.open: (String filename, ?Integer mode, ?Integer flags) -> DBM
@@ -70,113 +76,205 @@ class DBM
 
   public
 
+  # <!--
+  #   rdoc-file=ext/dbm/dbm.c
+  #   - dbm[key] -> string value or nil
+  # -->
   # Return a value from the database by locating the key string provided.  If the
   # key is not found, returns nil.
   #
   def []: (String) -> String?
 
+  # <!--
+  #   rdoc-file=ext/dbm/dbm.c
+  #   - dbm.store(key, value) -> value
+  #   - dbm[key] = value
+  # -->
   # Stores the specified string value in the database, indexed via the string key
   # provided.
   #
   def []=: (String, String) -> String
 
+  # <!--
+  #   rdoc-file=ext/dbm/dbm.c
+  #   - dbm.clear
+  # -->
   # Deletes all data from the database.
   #
   def clear: () -> self
 
+  # <!--
+  #   rdoc-file=ext/dbm/dbm.c
+  #   - dbm.close
+  # -->
   # Closes the database.
   #
   def close: () -> void
 
+  # <!--
+  #   rdoc-file=ext/dbm/dbm.c
+  #   - dbm.closed? -> true or false
+  # -->
   # Returns true if the database is closed, false otherwise.
   #
   def closed?: () -> bool
 
+  # <!--
+  #   rdoc-file=ext/dbm/dbm.c
+  #   - dbm.delete(key)
+  # -->
   # Deletes an entry from the database.
   #
   def delete: (String) -> void
 
+  # <!--
+  #   rdoc-file=ext/dbm/dbm.c
+  #   - dbm.reject! {|key, value| block} -> self
+  #   - dbm.delete_if {|key, value| block} -> self
+  # -->
   # Deletes all entries for which the code block returns true. Returns self.
   #
   def delete_if: () { (String) -> boolish } -> self
 
+  # <!--
+  #   rdoc-file=ext/dbm/dbm.c
+  #   - dbm.each_pair {|key,value| block} -> self
+  # -->
   # Calls the block once for each [key, value] pair in the database. Returns self.
   #
-  def each: () { ([String, String]) -> void } -> self
-          | () -> Enumerator[[String, String], self]
+  def each: () { ([ String, String ]) -> void } -> self
+          | () -> Enumerator[[ String, String ], self]
 
+  # <!--
+  #   rdoc-file=ext/dbm/dbm.c
+  #   - dbm.each_key {|key| block} -> self
+  # -->
   # Calls the block once for each key string in the database. Returns self.
   #
-  def each_key: { (String) -> void } -> self
+  def each_key: () { (String) -> void } -> self
               | () -> Enumerator[String, self]
 
+  # <!-- rdoc-file=ext/dbm/dbm.c -->
   # Calls the block once for each [key, value] pair in the database. Returns self.
   #
-  def each_pair: () { ([String, String]) -> void } -> self
-               | () -> Enumerator[[String, String], self]
+  def each_pair: () { ([ String, String ]) -> void } -> self
+               | () -> Enumerator[[ String, String ], self]
 
+  # <!--
+  #   rdoc-file=ext/dbm/dbm.c
+  #   - dbm.each_value {|value| block} -> self
+  # -->
   # Calls the block once for each value string in the database. Returns self.
   #
   def each_value: () { (String) -> void } -> self
                 | () -> Enumerator[String, self]
 
+  # <!--
+  #   rdoc-file=ext/dbm/dbm.c
+  #   - dbm.empty?
+  # -->
   # Returns true if the database is empty, false otherwise.
   #
   def empty?: () -> bool
 
+  # <!--
+  #   rdoc-file=ext/dbm/dbm.c
+  #   - dbm.fetch(key[, ifnone]) -> value
+  # -->
   # Return a value from the database by locating the key string provided.  If the
   # key is not found, returns `ifnone`. If `ifnone` is not given, raises
   # IndexError.
   #
   def fetch: (String key, ?String ifnone) -> String
 
+  # <!-- rdoc-file=ext/dbm/dbm.c -->
   # Returns true if the database contains the specified key, false otherwise.
   #
   def has_key?: (String) -> bool
 
+  # <!--
+  #   rdoc-file=ext/dbm/dbm.c
+  #   - dbm.has_value?(value) -> boolean
+  #   - dbm.value?(value) -> boolean
+  # -->
   # Returns true if the database contains the specified string value, false
   # otherwise.
   #
   def has_value?: () -> bool
 
+  # <!--
+  #   rdoc-file=ext/dbm/dbm.c
+  #   - dbm.include?(key) -> boolean
+  #   - dbm.has_key?(key) -> boolean
+  #   - dbm.member?(key) -> boolean
+  #   - dbm.key?(key) -> boolean
+  # -->
   # Returns true if the database contains the specified key, false otherwise.
   #
   def include?: (String) -> bool
 
+  # <!--
+  #   rdoc-file=ext/dbm/dbm.c
+  #   - dbm.invert -> hash
+  # -->
   # Returns a Hash (not a DBM database) created by using each value in the
   # database as a key, with the corresponding key as its value.
   #
   def invert: () -> Hash[String, String]
 
+  # <!--
+  #   rdoc-file=ext/dbm/dbm.c
+  #   - dbm.key(value) -> string
+  # -->
   # Returns the key for the specified value.
   #
   def key: (String) -> String?
 
+  # <!-- rdoc-file=ext/dbm/dbm.c -->
   # Returns true if the database contains the specified key, false otherwise.
   #
   def key?: (String) -> bool
 
+  # <!--
+  #   rdoc-file=ext/dbm/dbm.c
+  #   - dbm.keys -> array
+  # -->
   # Returns an array of all the string keys in the database.
   #
   def keys: () -> Array[String]
 
+  # <!--
+  #   rdoc-file=ext/dbm/dbm.c
+  #   - dbm.length -> integer
+  #   - dbm.size -> integer
+  # -->
   # Returns the number of entries in the database.
   #
   def length: () -> Integer
 
+  # <!-- rdoc-file=ext/dbm/dbm.c -->
   # Returns true if the database contains the specified key, false otherwise.
   #
   def member?: (String) -> bool
 
+  # <!--
+  #   rdoc-file=ext/dbm/dbm.c
+  #   - dbm.reject {|key,value| block} -> Hash
+  # -->
   # Converts the contents of the database to an in-memory Hash, then calls
   # Hash#reject with the specified code block, returning a new Hash.
   #
   def reject: () { (String, String) -> boolish } -> Hash[String, String]
 
+  # <!-- rdoc-file=ext/dbm/dbm.c -->
   # Deletes all entries for which the code block returns true. Returns self.
   #
   def reject!: () { (String, String) -> boolish } -> self
 
+  # <!--
+  #   rdoc-file=ext/dbm/dbm.c
+  #   - dbm.replace(obj)
+  # -->
   # Replaces the contents of the database with the contents of the specified
   # object. Takes any object which implements the each_pair method, including Hash
   # and DBM objects.
@@ -184,63 +282,98 @@ class DBM
   def replace: (_ReplaceSource) -> ::DBM
 
   interface _ReplaceSource
-    def each_pair: () { ([String, String]) -> void } -> void
+    def each_pair: () { ([ String, String ]) -> void } -> void
   end
 
+  # <!--
+  #   rdoc-file=ext/dbm/dbm.c
+  #   - dbm.select {|key, value| block} -> array
+  # -->
   # Returns a new array consisting of the [key, value] pairs for which the code
   # block returns true.
   #
-  def select: () { ([String, String]) -> boolish } -> Array[[String, String]]
+  def select: () { ([ String, String ]) -> boolish } -> Array[[ String, String ]]
 
+  # <!--
+  #   rdoc-file=ext/dbm/dbm.c
+  #   - dbm.shift() -> [key, value]
+  # -->
   # Removes a [key, value] pair from the database, and returns it. If the database
   # is empty, returns nil. The order in which values are removed/returned is not
   # guaranteed.
   #
-  def shift: () -> [String, String]?
+  def shift: () -> [ String, String ]?
 
+  # <!-- rdoc-file=ext/dbm/dbm.c -->
   # Returns the number of entries in the database.
   #
   def size: () -> Integer
 
+  # <!-- rdoc-file=ext/dbm/dbm.c -->
   # Stores the specified string value in the database, indexed via the string key
   # provided.
   #
   def store: (String, String) -> String
 
+  # <!--
+  #   rdoc-file=ext/dbm/dbm.c
+  #   - dbm.to_a -> array
+  # -->
   # Converts the contents of the database to an array of [key, value] arrays, and
   # returns it.
   #
-  def to_a: () -> Array[[String, String]]
+  def to_a: () -> Array[[ String, String ]]
 
+  # <!--
+  #   rdoc-file=ext/dbm/dbm.c
+  #   - dbm.to_hash -> hash
+  # -->
   # Converts the contents of the database to an in-memory Hash object, and returns
   # it.
   #
   def to_hash: () -> Hash[String, String]
 
+  # <!--
+  #   rdoc-file=ext/dbm/dbm.c
+  #   - dbm.update(obj)
+  # -->
   # Updates the database with multiple values from the specified object. Takes any
   # object which implements the each_pair method, including Hash and DBM objects.
   #
   def update: (_UpdateSource) -> ::DBM
 
   interface _UpdateSource
-    def each_pair: () { ([String, String]) -> void } -> void
+    def each_pair: () { ([ String, String ]) -> void } -> void
   end
 
+  # <!-- rdoc-file=ext/dbm/dbm.c -->
   # Returns true if the database contains the specified string value, false
   # otherwise.
   #
   def value?: (String) -> bool
 
+  # <!--
+  #   rdoc-file=ext/dbm/dbm.c
+  #   - dbm.values -> array
+  # -->
   # Returns an array of all the string values in the database.
   #
   def values: () -> Array[String]
 
+  # <!--
+  #   rdoc-file=ext/dbm/dbm.c
+  #   - dbm.values_at(key, ...) -> Array
+  # -->
   # Returns an array containing the values associated with the given keys.
   #
   def values_at: (*String) -> Array[String]
 
   private
 
+  # <!--
+  #   rdoc-file=ext/dbm/dbm.c
+  #   - DBM.new(filename[, mode[, flags]]) -> dbm
+  # -->
   # Open a dbm database with the specified name, which can include a directory
   # path. Any file extensions needed will be supplied automatically by the dbm
   # library. For example, Berkeley DB appends '.db', and GNU gdbm uses two
@@ -253,17 +386,19 @@ class DBM
   def initialize: (String filename, ?Integer mode, ?Integer flags) -> void
 end
 
+# <!-- rdoc-file=ext/dbm/dbm.c -->
 # Indicates that dbm_open() should open the database in read/write mode, create
 # it if it does not already exist, and delete all contents if it does already
 # exist.
 #
 DBM::NEWDB: Integer
 
+# <!-- rdoc-file=ext/dbm/dbm.c -->
 # Indicates that dbm_open() should open the database in read-only mode
 #
-#
 DBM::READER: Integer
 
+# <!-- rdoc-file=ext/dbm/dbm.c -->
 # Identifies ndbm library version.
 #
 # Examples:
@@ -274,15 +409,15 @@ DBM::READER: Integer
 # *   "GDBM version 1.8.3. 10/15/2002 (built Jul  1 2011 12:32:45)"
 # *   "QDBM 1.8.78"
 #
-#
 DBM::VERSION: String
 
+# <!-- rdoc-file=ext/dbm/dbm.c -->
 # Indicates that dbm_open() should open the database in read/write mode, and
 # create it if it does not already exist
 #
 DBM::WRCREAT: Integer
 
+# <!-- rdoc-file=ext/dbm/dbm.c -->
 # Indicates that dbm_open() should open the database in read/write mode
 #
-#
 DBM::WRITER: Integer