rbs 2.0.0 → 2.2.2

data/stdlib/pstore/0/pstore.rbs

@@ -1,3 +1,4 @@
+# <!-- rdoc-file=lib/pstore.rb -->
 # PStore implements a file based persistence mechanism based on a Hash.  User
 # code can store hierarchies of Ruby objects (values) into the data store file
 # by name (keys).  An object hierarchy may be just a single object.  User code
@@ -82,6 +83,10 @@
 class PStore
   public
 
+  # <!--
+  #   rdoc-file=lib/pstore.rb
+  #   - [](name)
+  # -->
   # Retrieves a value from the PStore file data, by *name*.  The hierarchy of Ruby
   # objects stored under that root *name* will be returned.
   #
@@ -90,6 +95,10 @@ class PStore
   #
   def []: (untyped name) -> untyped
 
+  # <!--
+  #   rdoc-file=lib/pstore.rb
+  #   - []=(name, value)
+  # -->
   # Stores an individual Ruby object or a hierarchy of Ruby objects in the data
   # store file under the root *name*.  Assigning to a *name* already in the data
   # store clobbers the old data.
@@ -111,6 +120,10 @@ class PStore
   #
   def []=: (untyped name, untyped value) -> untyped
 
+  # <!--
+  #   rdoc-file=lib/pstore.rb
+  #   - abort()
+  # -->
   # Ends the current PStore#transaction, discarding any changes to the data store.
   #
   # ## Example:
@@ -132,6 +145,10 @@ class PStore
   #
   def abort: () -> untyped
 
+  # <!--
+  #   rdoc-file=lib/pstore.rb
+  #   - commit()
+  # -->
   # Ends the current PStore#transaction, committing any changes to the data store
   # immediately.
   #
@@ -155,6 +172,10 @@ class PStore
   #
   def commit: () -> nil
 
+  # <!--
+  #   rdoc-file=lib/pstore.rb
+  #   - delete(name)
+  # -->
   # Removes an object hierarchy from the data store, by *name*.
   #
   # **WARNING**:  This method is only valid in a PStore#transaction and it cannot
@@ -162,6 +183,10 @@ class PStore
   #
   def delete: (untyped name) -> untyped
 
+  # <!--
+  #   rdoc-file=lib/pstore.rb
+  #   - fetch(name, default=PStore::Error)
+  # -->
   # This method is just like PStore#[], save that you may also provide a *default*
   # value for the object.  In the event the specified *name* is not found in the
   # data store, your *default* will be returned instead.  If you do not specify a
@@ -172,10 +197,18 @@ class PStore
   #
   def fetch: (untyped name, ?untyped default) -> untyped
 
+  # <!--
+  #   rdoc-file=lib/pstore.rb
+  #   - path()
+  # -->
   # Returns the path to the data store file.
   #
   def path: () -> untyped
 
+  # <!--
+  #   rdoc-file=lib/pstore.rb
+  #   - root?(name)
+  # -->
   # Returns true if the supplied *name* is currently in the data store.
   #
   # **WARNING**:  This method is only valid in a PStore#transaction.  It will
@@ -183,6 +216,10 @@ class PStore
   #
   def root?: (untyped name) -> bool
 
+  # <!--
+  #   rdoc-file=lib/pstore.rb
+  #   - roots()
+  # -->
   # Returns the names of all object hierarchies currently in the store.
   #
   # **WARNING**:  This method is only valid in a PStore#transaction.  It will
@@ -190,6 +227,10 @@ class PStore
   #
   def roots: () -> Array[untyped]
 
+  # <!--
+  #   rdoc-file=lib/pstore.rb
+  #   - transaction(read_only = false) { |pstore| ... }
+  # -->
   # Opens a new transaction for the data store.  Code executed inside a block
   # passed to this method may read and write data to and from the data store file.
   #
@@ -207,6 +248,7 @@ class PStore
   #
   def transaction: (?untyped read_only) -> untyped
 
+  # <!-- rdoc-file=lib/pstore.rb -->
   # Whether PStore should do its best to prevent file corruptions, even when under
   # unlikely-to-occur error conditions such as out-of-space conditions and other
   # unusual OS filesystem errors. Setting this flag comes at the price in the form
@@ -218,25 +260,57 @@ class PStore
   #
   def ultra_safe: () -> untyped
 
+  # <!-- rdoc-file=lib/pstore.rb -->
+  # Whether PStore should do its best to prevent file corruptions, even when under
+  # unlikely-to-occur error conditions such as out-of-space conditions and other
+  # unusual OS filesystem errors. Setting this flag comes at the price in the form
+  # of a performance loss.
+  #
+  # This flag only has effect on platforms on which file renames are atomic (e.g.
+  # all POSIX platforms: Linux, MacOS X, FreeBSD, etc). The default value is
+  # false.
+  #
   def ultra_safe=: (untyped) -> untyped
 
   private
 
   def dump: (untyped table) -> untyped
 
+  # <!--
+  #   rdoc-file=lib/pstore.rb
+  #   - empty_marshal_checksum()
+  # -->
+  #
   def empty_marshal_checksum: () -> untyped
 
+  # <!--
+  #   rdoc-file=lib/pstore.rb
+  #   - empty_marshal_data()
+  # -->
+  #
   def empty_marshal_data: () -> untyped
 
+  # <!--
+  #   rdoc-file=lib/pstore.rb
+  #   - in_transaction()
+  # -->
   # Raises PStore::Error if the calling code is not in a PStore#transaction.
   #
   def in_transaction: () -> untyped
 
+  # <!--
+  #   rdoc-file=lib/pstore.rb
+  #   - in_transaction_wr()
+  # -->
   # Raises PStore::Error if the calling code is not in a PStore#transaction or if
   # the code is in a read-only PStore#transaction.
   #
   def in_transaction_wr: () -> untyped
 
+  # <!--
+  #   rdoc-file=lib/pstore.rb
+  #   - new(file, thread_safe = false)
+  # -->
   # To construct a PStore object, pass in the *file* path where you would like the
   # data to be stored.
   #
@@ -247,14 +321,27 @@ class PStore
 
   def load: (untyped content) -> untyped
 
+  # <!--
+  #   rdoc-file=lib/pstore.rb
+  #   - load_data(file, read_only)
+  # -->
   # Load the given PStore file. If `read_only` is true, the unmarshalled Hash will
   # be returned. If `read_only` is false, a 3-tuple will be returned: the
   # unmarshalled Hash, a checksum of the data, and the size of the data.
   #
   def load_data: (untyped file, untyped read_only) -> untyped
 
+  # <!--
+  #   rdoc-file=lib/pstore.rb
+  #   - on_windows?()
+  # -->
+  #
   def on_windows?: () -> bool
 
+  # <!--
+  #   rdoc-file=lib/pstore.rb
+  #   - open_and_lock_file(filename, read_only)
+  # -->
   # Open the specified filename (either in read-only mode or in read-write mode)
   # and lock it for reading or writing.
   #
@@ -265,10 +352,25 @@ class PStore
   #
   def open_and_lock_file: (untyped filename, untyped read_only) -> untyped
 
+  # <!--
+  #   rdoc-file=lib/pstore.rb
+  #   - save_data(original_checksum, original_file_size, file)
+  # -->
+  #
   def save_data: (untyped original_checksum, untyped original_file_size, untyped file) -> untyped
 
+  # <!--
+  #   rdoc-file=lib/pstore.rb
+  #   - save_data_with_atomic_file_rename_strategy(data, file)
+  # -->
+  #
   def save_data_with_atomic_file_rename_strategy: (untyped data, untyped file) -> untyped
 
+  # <!--
+  #   rdoc-file=lib/pstore.rb
+  #   - save_data_with_fast_strategy(data, file)
+  # -->
+  #
   def save_data_with_fast_strategy: (untyped data, untyped file) -> untyped
 end
 

data/stdlib/pty/0/pty.rbs

@@ -1,5 +1,6 @@
+# <!-- rdoc-file=ext/pty/pty.c -->
 # Creates and manages pseudo terminals (PTYs).  See also
-# http://en.wikipedia.org/wiki/Pseudo_terminal
+# https://en.wikipedia.org/wiki/Pseudo_terminal
 #
 # PTY allows you to allocate new terminals using ::open or ::spawn a new
 # terminal with a specific command.
@@ -42,18 +43,23 @@
 #
 # ## License
 #
-#     C) Copyright 1998 by Akinori Ito.
+# (c) Copyright 1998 by Akinori Ito.
 #
-#     This software may be redistributed freely for this purpose, in full
-#     or in part, provided that this entire copyright notice is included
-#     on any copies of this software and applications and derivations thereof.
+# This software may be redistributed freely for this purpose, in full or in
+# part, provided that this entire copyright notice is included on any copies of
+# this software and applications and derivations thereof.
 #
-#     This software is provided on an "as is" basis, without warranty of any
-#     kind, either expressed or implied, as to any matter including, but not
-#     limited to warranty of fitness of purpose, or merchantability, or
-#     results obtained from use of this software.
+# This software is provided on an "as is" basis, without warranty of any kind,
+# either expressed or implied, as to any matter including, but not limited to
+# warranty of fitness of purpose, or merchantability, or results obtained from
+# use of this software.
 #
 module PTY
+  # <!--
+  #   rdoc-file=ext/pty/pty.c
+  #   - PTY.check(pid, raise = false) => Process::Status or nil
+  #   - PTY.check(pid, true)          => nil or raises PTY::ChildExited
+  # -->
   # Checks the status of the child process specified by `pid`. Returns `nil` if
   # the process is still alive.
   #
@@ -68,12 +74,47 @@ module PTY
   #
   def self.check: (Integer pid, ?boolish raise) -> Process::Status?
 
+  # <!--
+  #   rdoc-file=ext/pty/pty.c
+  #   - PTY.spawn(command_line)  { |r, w, pid| ... }
+  #   - PTY.spawn(command_line)  => [r, w, pid]
+  #   - PTY.spawn(command, arguments, ...)  { |r, w, pid| ... }
+  #   - PTY.spawn(command, arguments, ...)  => [r, w, pid]
+  # -->
+  # Spawns the specified command on a newly allocated pty. You can also use the
+  # alias ::getpty.
+  #
+  # The command's controlling tty is set to the slave device of the pty and its
+  # standard input/output/error is redirected to the slave device.
+  #
+  # `command` and `command_line` are the full commands to run, given a String. Any
+  # additional `arguments` will be passed to the command.
+  #
+  # ### Return values
+  #
+  # In the non-block form this returns an array of size three, `[r, w, pid]`.
+  #
+  # In the block form these same values will be yielded to the block:
+  #
+  # `r`
+  # :   A readable IO that contains the command's standard output and standard
+  #     error
+  # `w`
+  # :   A writable IO that is the command's standard input
+  # `pid`
+  # :   The process identifier for the command.
+  #
   alias self.getpty self.spawn
 
+  # <!--
+  #   rdoc-file=ext/pty/pty.c
+  #   - PTY.open => [master_io, slave_file]
+  #   - PTY.open {|(master_io, slave_file)| ... } => block value
+  # -->
   # Allocates a pty (pseudo-terminal).
   #
-  # In the block form, yields two arguments `master_io, slave_file` and the value
-  # of the block is returned from `open`.
+  # In the block form, yields an array of two elements (`master_io, slave_file`)
+  # and the value of the block is returned from `open`.
   #
   # The IO and File are both closed after the block completes if they haven't been
   # already closed.
@@ -103,11 +144,19 @@ module PTY
   #     require 'io/console'
   #     PTY.open {|m, s|
   #       s.raw!
-  #       ...
+  #       # ...
   #     }
+  #
   def self.open: () -> [ IO, File ]
-               | [A] () { ([ IO , File ]) -> A } -> A
+               | [A] () { ([ IO, File ]) -> A } -> A
 
+  # <!--
+  #   rdoc-file=ext/pty/pty.c
+  #   - PTY.spawn(command_line)  { |r, w, pid| ... }
+  #   - PTY.spawn(command_line)  => [r, w, pid]
+  #   - PTY.spawn(command, arguments, ...)  { |r, w, pid| ... }
+  #   - PTY.spawn(command, arguments, ...)  => [r, w, pid]
+  # -->
   # Spawns the specified command on a newly allocated pty. You can also use the
   # alias ::getpty.
   #
@@ -130,6 +179,7 @@ module PTY
   # :   A writable IO that is the command's standard input
   # `pid`
   # :   The process identifier for the command.
+  #
   def self.spawn: (*String command) -> [ IO, IO, Integer ]
-                | (*String command) {([ IO , IO , Integer ]) -> void } -> void
+                | (*String command) { ([ IO, IO, Integer ]) -> void } -> void
 end