rbs 4.0.0.dev.4 → 4.0.0

data/stdlib/securerandom/0/securerandom.rbs

@@ -29,34 +29,21 @@
 # *   uuid
 #
 # These methods are usable as class methods of SecureRandom such as
-# `SecureRandom.hex`.
+# <code>SecureRandom.hex</code>.
 #
 # If a secure random number generator is not available, `NotImplementedError` is
 # raised.
 #
 module SecureRandom
-  extend Random::Formatter
-
   # <!--
   #   rdoc-file=lib/securerandom.rb
-  #   - alphanumeric(n = nil, chars: ALPHANUMERIC)
+  #   - bytes(n)
   # -->
-  # Compatibility methods for Ruby 3.2, we can remove this after dropping to
-  # support Ruby 3.2
+  # Returns a random binary string containing `size` bytes.
   #
-  def self.alphanumeric: (?Integer?) -> String
-
-  def self.base64: (?Integer?) -> String
-
-  def self.hex: (?Integer?) -> String
-
-  def self.random_bytes: (?Integer?) -> String
-
-  def self.random_number: () -> Float
-                        | (Integer) -> Integer
-                        | (Numeric) -> Numeric
-
-  def self.urlsafe_base64: (?Integer?, ?bool?) -> String
+  # See Random.bytes
+  #
+  def self.bytes: (Integer) -> String
 
-  def self.uuid: () -> String
+  extend Random::Formatter
 end

data/stdlib/shellwords/0/shellwords.rbs

@@ -4,8 +4,8 @@
 # This module manipulates strings according to the word parsing rules of the
 # UNIX Bourne shell.
 #
-# The `shellwords()` function was originally a port of shellwords.pl, but
-# modified to conform to [the Shell & Utilities volume of the IEEE Std
+# The <code>shellwords()</code> function was originally a port of shellwords.pl,
+# but modified to conform to [the Shell & Utilities volume of the IEEE Std
 # 1003.1-2008, 2016
 # Edition](http://pubs.opengroup.org/onlinepubs/9699919799/utilities/contents.ht
 # ml)

data/stdlib/singleton/0/singleton.rbs

@@ -128,4 +128,7 @@ module Singleton
   end
 end
 
+# <!-- rdoc-file=lib/singleton.rb -->
+# The version string
+#
 Singleton::VERSION: String

data/stdlib/socket/0/addrinfo.rbs

@@ -634,13 +634,13 @@ class Addrinfo
   # sockaddr as generated by Socket.sockaddr_in or Socket.unpack_sockaddr_un.
   #
   # sockaddr examples:
-  # *   `["AF_INET", 46102, "localhost.localdomain", "127.0.0.1"]`
-  # *   `["AF_INET6", 42304, "ip6-localhost", "::1"]`
-  # *   `["AF_UNIX", "/tmp/sock"]`
-  # *   `Socket.sockaddr_in("smtp", "2001:DB8::1")`
-  # *   `Socket.sockaddr_in(80, "172.18.22.42")`
-  # *   `Socket.sockaddr_in(80, "www.ruby-lang.org")`
-  # *   `Socket.sockaddr_un("/tmp/sock")`
+  # *   <code>["AF_INET", 46102, "localhost.localdomain", "127.0.0.1"]</code>
+  # *   <code>["AF_INET6", 42304, "ip6-localhost", "::1"]</code>
+  # *   <code>["AF_UNIX", "/tmp/sock"]</code>
+  # *   <code>Socket.sockaddr_in("smtp", "2001:DB8::1")</code>
+  # *   <code>Socket.sockaddr_in(80, "172.18.22.42")</code>
+  # *   <code>Socket.sockaddr_in(80, "www.ruby-lang.org")</code>
+  # *   <code>Socket.sockaddr_un("/tmp/sock")</code>
   #
   # In an AF_INET/AF_INET6 sockaddr array, the 4th element, numeric IP address, is
   # used to construct socket address in the Addrinfo instance. If the 3rd element,

data/stdlib/socket/0/basic_socket.rbs

@@ -325,7 +325,7 @@ class BasicSocket < IO
   #
   # By specifying a keyword argument *exception* to `false`, you can indicate that
   # recv_nonblock should not raise an IO::WaitReadable exception, but return the
-  # symbol `:wait_readable` instead.
+  # symbol <code>:wait_readable</code> instead.
   #
   # ### See
   # *   Socket#recvfrom
@@ -399,7 +399,7 @@ class BasicSocket < IO
   #
   # By specifying a keyword argument *exception* to `false`, you can indicate that
   # recvmsg_nonblock should not raise an IO::WaitReadable exception, but return
-  # the symbol `:wait_readable` instead.
+  # the symbol <code>:wait_readable</code> instead.
   #
   def recvmsg_nonblock: (?Integer dlen, ?Integer flags, ?Integer clen, ?exception: boolish, ?scm_rights: boolish) -> ([ String, Addrinfo, Integer?, Array[Socket::AncillaryData] ] | :wait_readable)
 
@@ -487,7 +487,7 @@ class BasicSocket < IO
   #
   # By specifying a keyword argument *exception* to `false`, you can indicate that
   # sendmsg_nonblock should not raise an IO::WaitWritable exception, but return
-  # the symbol `:wait_writable` instead.
+  # the symbol <code>:wait_writable</code> instead.
   #
   def sendmsg_nonblock: (String mesg, ?Integer flags, ?Addrinfo | String dest_sockaddr, *Socket::AncillaryData controls, ?exception: boolish) -> (Integer | :wait_writable)
 

data/stdlib/socket/0/ip_socket.rbs

@@ -22,10 +22,11 @@ class IPSocket < BasicSocket
   # Returns the local address as an array which contains address_family, port,
   # hostname and numeric_address.
   #
-  # If `reverse_lookup` is `true` or `:hostname`, hostname is obtained from
-  # numeric_address using reverse lookup. Or if it is `false`, or `:numeric`,
-  # hostname is the same as numeric_address. Or if it is `nil` or omitted, obeys
-  # to `ipsocket.do_not_reverse_lookup`. See `Socket.getaddrinfo` also.
+  # If `reverse_lookup` is `true` or <code>:hostname</code>, hostname is obtained
+  # from numeric_address using reverse lookup. Or if it is `false`, or
+  # <code>:numeric</code>, hostname is the same as numeric_address. Or if it is
+  # `nil` or omitted, obeys to <code>ipsocket.do_not_reverse_lookup</code>. See
+  # <code>Socket.getaddrinfo</code> also.
   #
   #     TCPSocket.open("www.ruby-lang.org", 80) {|sock|
   #       p sock.addr #=> ["AF_INET", 49429, "hal", "192.168.0.128"]
@@ -53,10 +54,11 @@ class IPSocket < BasicSocket
   # hostname and numeric_address. It is defined for connection oriented socket
   # such as TCPSocket.
   #
-  # If `reverse_lookup` is `true` or `:hostname`, hostname is obtained from
-  # numeric_address using reverse lookup. Or if it is `false`, or `:numeric`,
-  # hostname is the same as numeric_address. Or if it is `nil` or omitted, obeys
-  # to `ipsocket.do_not_reverse_lookup`. See `Socket.getaddrinfo` also.
+  # If `reverse_lookup` is `true` or <code>:hostname</code>, hostname is obtained
+  # from numeric_address using reverse lookup. Or if it is `false`, or
+  # <code>:numeric</code>, hostname is the same as numeric_address. Or if it is
+  # `nil` or omitted, obeys to <code>ipsocket.do_not_reverse_lookup</code>. See
+  # <code>Socket.getaddrinfo</code> also.
   #
   #     TCPSocket.open("www.ruby-lang.org", 80) {|sock|
   #       p sock.peeraddr #=> ["AF_INET", 80, "carbon.ruby-lang.org", "221.186.184.68"]

data/stdlib/socket/0/socket.rbs

@@ -16,20 +16,21 @@
 #
 # Sockets have their own vocabulary:
 #
-# **domain:** The family of protocols:
+# <strong>domain:</strong> The family of protocols:
 # *   Socket::PF_INET
 # *   Socket::PF_INET6
 # *   Socket::PF_UNIX
 # *   etc.
 #
-# **type:** The type of communications between the two endpoints, typically
+# <strong>type:</strong> The type of communications between the two endpoints,
+# typically
 # *   Socket::SOCK_STREAM
 # *   Socket::SOCK_DGRAM.
 #
-# **protocol:** Typically *zero*. This may be used to identify a variant of a
-# protocol.
+# <strong>protocol:</strong> Typically *zero*. This may be used to identify a
+# variant of a protocol.
 #
-# **hostname:** The identifier of a network interface:
+# <strong>hostname:</strong> The identifier of a network interface:
 # *   a string (hostname, IPv4 or IPv6 address or `broadcast` which specifies a
 #     broadcast address)
 # *   a zero-length string which specifies INADDR_ANY
@@ -484,10 +485,17 @@ class Socket < BasicSocket
   #     The `connect_timeout` specifies the timeout in seconds from the start of
   #     the connection attempt to the last candidate.
   #     By default, all connection attempts continue until the timeout occurs.
-  #     When `fast_fallback:false` is explicitly specified,
+  #     When <code>fast_fallback:false</code> is explicitly specified,
   #     a timeout is set for each connection attempt and any connection attempt
   #     that exceeds its timeout will be canceled.
   #
+  # :open_timeout
+  # :   Specifies the timeout in seconds from the start of the method execution.
+  #     If this timeout is reached while there are still addresses that have not
+  #     yet been attempted for connection, no further attempts will be made.
+  #     If this option is specified together with other timeout options, an
+  #     `ArgumentError` will be raised.
+  #
   # :fast_fallback
   # :   Enables the Happy Eyeballs Version 2 algorithm (enabled by default).
   #
@@ -504,7 +512,9 @@ class Socket < BasicSocket
   #     }
   #
   def self.tcp: (String host, Integer port, ?String local_host, ?Integer local_port, ?resolv_timeout: Time::_Timeout, ?connect_timeout: Time::_Timeout) -> instance
-              | (String host, Integer port, ?String local_host, ?Integer local_port, ?resolv_timeout: Time::_Timeout, ?connect_timeout: Time::_Timeout) { (instance) -> void } -> void
+              | (String host, Integer port, ?String local_host, ?Integer local_port, ?open_timeout: Time::_Timeout) -> instance
+              | [T] (String host, Integer port, ?String local_host, ?Integer local_port, ?resolv_timeout: Time::_Timeout, ?connect_timeout: Time::_Timeout) { (instance) -> T } -> T
+              | [T] (String host, Integer port, ?String local_host, ?Integer local_port, ?open_timeout: Time::_Timeout) { (instance) -> T } -> T
 
   # <!--
   #   rdoc-file=ext/socket/lib/socket.rb
@@ -836,7 +846,7 @@ class Socket < BasicSocket
   #
   # By specifying a keyword argument *exception* to `false`, you can indicate that
   # accept_nonblock should not raise an IO::WaitReadable exception, but return the
-  # symbol `:wait_readable` instead.
+  # symbol <code>:wait_readable</code> instead.
   #
   # ### See
   # *   Socket#accept
@@ -1090,7 +1100,7 @@ class Socket < BasicSocket
   #
   # By specifying a keyword argument *exception* to `false`, you can indicate that
   # connect_nonblock should not raise an IO::WaitWritable exception, but return
-  # the symbol `:wait_writable` instead.
+  # the symbol <code>:wait_writable</code> instead.
   #
   # ### See
   # *   Socket#connect
@@ -1348,7 +1358,7 @@ class Socket < BasicSocket
   #
   # By specifying a keyword argument *exception* to `false`, you can indicate that
   # recvfrom_nonblock should not raise an IO::WaitReadable exception, but return
-  # the symbol `:wait_readable` instead.
+  # the symbol <code>:wait_readable</code> instead.
   #
   # ### See
   # *   Socket#recvfrom
@@ -3769,6 +3779,9 @@ class Socket::Ifaddr
   # -->
   # Returns the flags of *ifaddr*.
   #
+  # The value is bitwise-or of Socket::IFF_* constants such as
+  # Socket::IFF_LOOPBACK.
+  #
   def flags: () -> Integer
 
   # <!--

data/stdlib/socket/0/tcp_server.rbs

@@ -72,7 +72,7 @@ class TCPServer < TCPSocket
   #
   # By specifying a keyword argument *exception* to `false`, you can indicate that
   # accept_nonblock should not raise an IO::WaitReadable exception, but return the
-  # symbol `:wait_readable` instead.
+  # symbol <code>:wait_readable</code> instead.
   #
   # ### See
   # *   TCPServer#accept

data/stdlib/socket/0/tcp_socket.rbs

@@ -38,7 +38,7 @@ class TCPSocket < IPSocket
 
   # <!--
   #   rdoc-file=ext/socket/tcpsocket.c
-  #   - TCPSocket.new(remote_host, remote_port, local_host=nil, local_port=nil, resolv_timeout: nil, connect_timeout: nil, fast_fallback: true)
+  #   - TCPSocket.new(remote_host, remote_port, local_host=nil, local_port=nil, resolv_timeout: nil, connect_timeout: nil, open_timeout: nil, fast_fallback: true)
   # -->
   # Opens a TCP connection to `remote_host` on `remote_port`.  If `local_host` and
   # `local_port` are specified, then those parameters are used on the local end to
@@ -68,12 +68,20 @@ class TCPSocket < IPSocket
   #     The `connect_timeout` specifies the timeout in seconds from the start of
   #     the connection attempt to the last candidate.
   #     By default, all connection attempts continue until the timeout occurs.
-  #     When `fast_fallback:false` is explicitly specified,
+  #     When <code>fast_fallback:false</code> is explicitly specified,
   #     a timeout is set for each connection attempt and any connection attempt
   #     that exceeds its timeout will be canceled.
   #
+  # :open_timeout
+  # :   Specifies the timeout in seconds from the start of the method execution.
+  #     If this timeout is reached while there are still addresses that have not
+  #     yet been attempted for connection, no further attempts will be made.
+  #     If this option is specified together with other timeout options, an
+  #     `ArgumentError` will be raised.
+  #
   # :fast_fallback
   # :   Enables the Happy Eyeballs Version 2 algorithm (enabled by default).
   #
-  def initialize: (String remote_host, Integer remote_port, ?String local_host, ?Integer local_port) -> untyped
+  def initialize: (String remote_host, Integer remote_port, ?String local_host, ?Integer local_port, ?fast_fallback: boolish, ?resolv_timeout: Integer, ?connect_timeout: Integer) -> void
+                | (String remote_host, Integer remote_port, ?String local_host, ?Integer local_port, ?fast_fallback: boolish, ?open_timeout: Integer) -> void
 end

data/stdlib/socket/0/udp_socket.rbs

@@ -81,7 +81,7 @@ class UDPSocket < IPSocket
   #
   # By specifying a keyword argument *exception* to `false`, you can indicate that
   # recvfrom_nonblock should not raise an IO::WaitReadable exception, but return
-  # the symbol `:wait_readable` instead.
+  # the symbol <code>:wait_readable</code> instead.
   #
   # ### See
   # *   Socket#recvfrom

data/stdlib/socket/0/unix_server.rbs

@@ -50,7 +50,7 @@ class UNIXServer < UNIXSocket
   #
   # By specifying a keyword argument *exception* to `false`, you can indicate that
   # accept_nonblock should not raise an IO::WaitReadable exception, but return the
-  # symbol `:wait_readable` instead.
+  # symbol <code>:wait_readable</code> instead.
   #
   # ### See
   # *   UNIXServer#accept