wreq 1.2.4-aarch64-linux → 1.2.6-aarch64-linux

data/lib/wreq.rb

@@ -9,6 +9,7 @@ end
 
 # Load type hint definitions
 require_relative "wreq_ruby/http"
+require_relative "wreq_ruby/emulate"
 require_relative "wreq_ruby/client"
 require_relative "wreq_ruby/response"
 require_relative "wreq_ruby/body"
@@ -18,22 +19,30 @@ require_relative "wreq_ruby/cookie"
 
 unless defined?(Wreq)
   module Wreq
+    # Current wreq gem version.
+    # @return [String]
     VERSION = nil
 
+    # Module request methods accept only the options documented for each
+    # method. Unknown, ambiguous, ineffective, and unavailable platform options
+    # raise ArgumentError. Known values retain the error class from their Ruby
+    # or native conversion, such as TypeError or Wreq::BuilderError. Validation
+    # finishes before network I/O.
+
     # Send an HTTP request.
     #
     # @param method [Wreq::Method] HTTP method to use
     # @param url [String] Target URL
     # @param headers [Wreq::Headers, Hash{String=>String}, nil] Custom headers for this request
     # @param orig_headers [Array<String>, nil] Original header names used to preserve raw header order and HTTP/1 case-sensitive header handling
-    # @param default_headers [Hash{String=>String}, nil] Default headers to merge
+    # @param default_headers [Boolean, nil] Whether to apply native default headers
     # @param query [Hash, nil] URL query parameters
     # @param auth [String, nil] Authorization header value
     # @param bearer_auth [String, nil] Bearer token for Authorization header
     # @param basic_auth [Array<String>, nil] Username and password for basic auth
     # @param cookies [Hash{String=>String}, String, nil] Cookies to send
     # @param allow_redirects [Boolean, nil] Whether to follow redirects
-    # @param max_redirects [Integer, nil] Maximum number of redirects to follow
+    # @param max_redirects [Integer, nil] Maximum redirects; requires allow_redirects: true
     # @param gzip [Boolean, nil] Enable gzip compression
     # @param brotli [Boolean, nil] Enable Brotli compression
     # @param deflate [Boolean, nil] Enable deflate compression
@@ -42,13 +51,15 @@ unless defined?(Wreq)
     # @param read_timeout [Integer, nil] Per-chunk read timeout (seconds)
     # @param proxy [String, nil] Proxy server URI
     # @param local_address [String, nil] Bind the client's local source IP address (IPv4/IPv6). Useful on multi-homed hosts to originate connections from a specific address or enforce source routing. Examples: "192.168.1.10", "10.0.0.5", "2001:db8::1". The address must exist on the host and be routable or the connection may fail.
-    # @param interface [String, nil] Bind the socket to a specific network interface via `SO_BINDTODEVICE` (e.g., "eth0", "wlan0", "tun0"). Effective only on systems that support the option (Linux/Android/Fuchsia) and typically requires privileges (root or CAP_NET_ADMIN).
+    # @param interface [String, nil] Bind to an interface on supported platforms; unsupported platforms raise ArgumentError.
     # @param emulation [Wreq::Emulation, nil] Device/OS emulation for this request
     # @param version [Wreq::Version, nil] HTTP version to use
     # @param form [Hash{String=>String}, nil] Form data (application/x-www-form-urlencoded)
-    # @param json [Object, nil] JSON body (will be serialized)
-    # @param body [String, IO, nil] Raw request body (string or stream)
+    # @param json [Object, nil] JSON body serialized by the native encoder; Integer values retain arbitrary precision
+    # @param body [String, Wreq::BodySender, nil] Raw or streaming request body
     # @return [Wreq::Response] HTTP response
+    # @raise [TypeError, ArgumentError, Wreq::BuilderError] if a known option
+    #   value cannot be converted, validated, or built
     def self.request(method, url, **options)
     end
 
@@ -57,14 +68,14 @@ unless defined?(Wreq)
     # @param url [String] Target URL
     # @param headers [Wreq::Headers, Hash{String=>String}, nil] Custom headers for this request
     # @param orig_headers [Array<String>, nil] Original header names used to preserve raw header order and HTTP/1 case-sensitive header handling
-    # @param default_headers [Hash{String=>String}, nil] Default headers to merge
+    # @param default_headers [Boolean, nil] Whether to apply native default headers
     # @param query [Hash, nil] URL query parameters
     # @param auth [String, nil] Authorization header value
     # @param bearer_auth [String, nil] Bearer token for Authorization header
     # @param basic_auth [Array<String>, nil] Username and password for basic auth
     # @param cookies [Hash{String=>String}, String, nil] Cookies to send
     # @param allow_redirects [Boolean, nil] Whether to follow redirects
-    # @param max_redirects [Integer, nil] Maximum number of redirects to follow
+    # @param max_redirects [Integer, nil] Maximum redirects; requires allow_redirects: true
     # @param gzip [Boolean, nil] Enable gzip compression
     # @param brotli [Boolean, nil] Enable Brotli compression
     # @param deflate [Boolean, nil] Enable deflate compression
@@ -73,13 +84,15 @@ unless defined?(Wreq)
     # @param read_timeout [Integer, nil] Per-chunk read timeout (seconds)
     # @param proxy [String, nil] Proxy server URI
     # @param local_address [String, nil] Bind the client's local source IP address (IPv4/IPv6). Useful on multi-homed hosts to originate connections from a specific address or enforce source routing. Examples: "192.168.1.10", "10.0.0.5", "2001:db8::1". The address must exist on the host and be routable or the connection may fail.
-    # @param interface [String, nil] Bind the socket to a specific network interface via `SO_BINDTODEVICE` (e.g., "eth0", "wlan0", "tun0"). Effective only on systems that support the option (Linux/Android/Fuchsia) and typically requires privileges (root or CAP_NET_ADMIN).
+    # @param interface [String, nil] Bind to an interface on supported platforms; unsupported platforms raise ArgumentError.
     # @param emulation [Wreq::Emulation, nil] Device/OS emulation for this request
     # @param version [Wreq::Version, nil] HTTP version to use
     # @param form [Hash{String=>String}, nil] Form data (application/x-www-form-urlencoded)
-    # @param json [Object, nil] JSON body (will be serialized)
-    # @param body [String, IO, nil] Raw request body (string or stream)
+    # @param json [Object, nil] JSON body serialized by the native encoder; Integer values retain arbitrary precision
+    # @param body [String, Wreq::BodySender, nil] Raw or streaming request body
     # @return [Wreq::Response] HTTP response
+    # @raise [TypeError, ArgumentError, Wreq::BuilderError] if a known option
+    #   value cannot be converted, validated, or built
     def self.get(url, **options)
     end
 
@@ -88,14 +101,14 @@ unless defined?(Wreq)
     # @param url [String] Target URL
     # @param headers [Wreq::Headers, Hash{String=>String}, nil] Custom headers for this request
     # @param orig_headers [Array<String>, nil] Original header names used to preserve raw header order and HTTP/1 case-sensitive header handling
-    # @param default_headers [Hash{String=>String}, nil] Default headers to merge
+    # @param default_headers [Boolean, nil] Whether to apply native default headers
     # @param query [Hash, nil] URL query parameters
     # @param auth [String, nil] Authorization header value
     # @param bearer_auth [String, nil] Bearer token for Authorization header
     # @param basic_auth [Array<String>, nil] Username and password for basic auth
     # @param cookies [Hash{String=>String}, String, nil] Cookies to send
     # @param allow_redirects [Boolean, nil] Whether to follow redirects
-    # @param max_redirects [Integer, nil] Maximum number of redirects to follow
+    # @param max_redirects [Integer, nil] Maximum redirects; requires allow_redirects: true
     # @param gzip [Boolean, nil] Enable gzip compression
     # @param brotli [Boolean, nil] Enable Brotli compression
     # @param deflate [Boolean, nil] Enable deflate compression
@@ -104,13 +117,15 @@ unless defined?(Wreq)
     # @param read_timeout [Integer, nil] Per-chunk read timeout (seconds)
     # @param proxy [String, nil] Proxy server URI
     # @param local_address [String, nil] Bind the client's local source IP address (IPv4/IPv6). Useful on multi-homed hosts to originate connections from a specific address or enforce source routing. Examples: "192.168.1.10", "10.0.0.5", "2001:db8::1". The address must exist on the host and be routable or the connection may fail.
-    # @param interface [String, nil] Bind the socket to a specific network interface via `SO_BINDTODEVICE` (e.g., "eth0", "wlan0", "tun0"). Effective only on systems that support the option (Linux/Android/Fuchsia) and typically requires privileges (root or CAP_NET_ADMIN).
+    # @param interface [String, nil] Bind to an interface on supported platforms; unsupported platforms raise ArgumentError.
     # @param emulation [Wreq::Emulation, nil] Device/OS emulation for this request
     # @param version [Wreq::Version, nil] HTTP version to use
     # @param form [Hash{String=>String}, nil] Form data (application/x-www-form-urlencoded)
-    # @param json [Object, nil] JSON body (will be serialized)
-    # @param body [String, IO, nil] Raw request body (string or stream)
+    # @param json [Object, nil] JSON body serialized by the native encoder; Integer values retain arbitrary precision
+    # @param body [String, Wreq::BodySender, nil] Raw or streaming request body
     # @return [Wreq::Response] HTTP response
+    # @raise [TypeError, ArgumentError, Wreq::BuilderError] if a known option
+    #   value cannot be converted, validated, or built
     def self.head(url, **options)
     end
 
@@ -119,14 +134,14 @@ unless defined?(Wreq)
     # @param url [String] Target URL
     # @param headers [Wreq::Headers, Hash{String=>String}, nil] Custom headers for this request
     # @param orig_headers [Array<String>, nil] Original header names used to preserve raw header order and HTTP/1 case-sensitive header handling
-    # @param default_headers [Hash{String=>String}, nil] Default headers to merge
+    # @param default_headers [Boolean, nil] Whether to apply native default headers
     # @param query [Hash, nil] URL query parameters
     # @param auth [String, nil] Authorization header value
     # @param bearer_auth [String, nil] Bearer token for Authorization header
     # @param basic_auth [Array<String>, nil] Username and password for basic auth
     # @param cookies [Hash{String=>String}, String, nil] Cookies to send
     # @param allow_redirects [Boolean, nil] Whether to follow redirects
-    # @param max_redirects [Integer, nil] Maximum number of redirects to follow
+    # @param max_redirects [Integer, nil] Maximum redirects; requires allow_redirects: true
     # @param gzip [Boolean, nil] Enable gzip compression
     # @param brotli [Boolean, nil] Enable Brotli compression
     # @param deflate [Boolean, nil] Enable deflate compression
@@ -135,13 +150,15 @@ unless defined?(Wreq)
     # @param read_timeout [Integer, nil] Per-chunk read timeout (seconds)
     # @param proxy [String, nil] Proxy server URI
     # @param local_address [String, nil] Bind the client's local source IP address (IPv4/IPv6). Useful on multi-homed hosts to originate connections from a specific address or enforce source routing. Examples: "192.168.1.10", "10.0.0.5", "2001:db8::1". The address must exist on the host and be routable or the connection may fail.
-    # @param interface [String, nil] Bind the socket to a specific network interface via `SO_BINDTODEVICE` (e.g., "eth0", "wlan0", "tun0"). Effective only on systems that support the option (Linux/Android/Fuchsia) and typically requires privileges (root or CAP_NET_ADMIN).
+    # @param interface [String, nil] Bind to an interface on supported platforms; unsupported platforms raise ArgumentError.
     # @param emulation [Wreq::Emulation, nil] Device/OS emulation for this request
     # @param version [Wreq::Version, nil] HTTP version to use
     # @param form [Hash{String=>String}, nil] Form data (application/x-www-form-urlencoded)
-    # @param json [Object, nil] JSON body (will be serialized)
-    # @param body [String, IO, nil] Raw request body (string or stream)
+    # @param json [Object, nil] JSON body serialized by the native encoder; Integer values retain arbitrary precision
+    # @param body [String, Wreq::BodySender, nil] Raw or streaming request body
     # @return [Wreq::Response] HTTP response
+    # @raise [TypeError, ArgumentError, Wreq::BuilderError] if a known option
+    #   value cannot be converted, validated, or built
     def self.post(url, **options)
     end
 
@@ -150,14 +167,14 @@ unless defined?(Wreq)
     # @param url [String] Target URL
     # @param headers [Wreq::Headers, Hash{String=>String}, nil] Custom headers for this request
     # @param orig_headers [Array<String>, nil] Original header names used to preserve raw header order and HTTP/1 case-sensitive header handling
-    # @param default_headers [Hash{String=>String}, nil] Default headers to merge
+    # @param default_headers [Boolean, nil] Whether to apply native default headers
     # @param query [Hash, nil] URL query parameters
     # @param auth [String, nil] Authorization header value
     # @param bearer_auth [String, nil] Bearer token for Authorization header
     # @param basic_auth [Array<String>, nil] Username and password for basic auth
     # @param cookies [Hash{String=>String}, String, nil] Cookies to send
     # @param allow_redirects [Boolean, nil] Whether to follow redirects
-    # @param max_redirects [Integer, nil] Maximum number of redirects to follow
+    # @param max_redirects [Integer, nil] Maximum redirects; requires allow_redirects: true
     # @param gzip [Boolean, nil] Enable gzip compression
     # @param brotli [Boolean, nil] Enable Brotli compression
     # @param deflate [Boolean, nil] Enable deflate compression
@@ -166,13 +183,15 @@ unless defined?(Wreq)
     # @param read_timeout [Integer, nil] Per-chunk read timeout (seconds)
     # @param proxy [String, nil] Proxy server URI
     # @param local_address [String, nil] Bind the client's local source IP address (IPv4/IPv6). Useful on multi-homed hosts to originate connections from a specific address or enforce source routing. Examples: "192.168.1.10", "10.0.0.5", "2001:db8::1". The address must exist on the host and be routable or the connection may fail.
-    # @param interface [String, nil] Bind the socket to a specific network interface via `SO_BINDTODEVICE` (e.g., "eth0", "wlan0", "tun0"). Effective only on systems that support the option (Linux/Android/Fuchsia) and typically requires privileges (root or CAP_NET_ADMIN).
+    # @param interface [String, nil] Bind to an interface on supported platforms; unsupported platforms raise ArgumentError.
     # @param emulation [Wreq::Emulation, nil] Device/OS emulation for this request
     # @param version [Wreq::Version, nil] HTTP version to use
     # @param form [Hash{String=>String}, nil] Form data (application/x-www-form-urlencoded)
-    # @param json [Object, nil] JSON body (will be serialized)
-    # @param body [String, IO, nil] Raw request body (string or stream)
+    # @param json [Object, nil] JSON body serialized by the native encoder; Integer values retain arbitrary precision
+    # @param body [String, Wreq::BodySender, nil] Raw or streaming request body
     # @return [Wreq::Response] HTTP response
+    # @raise [TypeError, ArgumentError, Wreq::BuilderError] if a known option
+    #   value cannot be converted, validated, or built
     def self.put(url, **options)
     end
 
@@ -181,14 +200,14 @@ unless defined?(Wreq)
     # @param url [String] Target URL
     # @param headers [Wreq::Headers, Hash{String=>String}, nil] Custom headers for this request
     # @param orig_headers [Array<String>, nil] Original header names used to preserve raw header order and HTTP/1 case-sensitive header handling
-    # @param default_headers [Hash{String=>String}, nil] Default headers to merge
+    # @param default_headers [Boolean, nil] Whether to apply native default headers
     # @param query [Hash, nil] URL query parameters
     # @param auth [String, nil] Authorization header value
     # @param bearer_auth [String, nil] Bearer token for Authorization header
     # @param basic_auth [Array<String>, nil] Username and password for basic auth
     # @param cookies [Hash{String=>String}, String, nil] Cookies to send
     # @param allow_redirects [Boolean, nil] Whether to follow redirects
-    # @param max_redirects [Integer, nil] Maximum number of redirects to follow
+    # @param max_redirects [Integer, nil] Maximum redirects; requires allow_redirects: true
     # @param gzip [Boolean, nil] Enable gzip compression
     # @param brotli [Boolean, nil] Enable Brotli compression
     # @param deflate [Boolean, nil] Enable deflate compression
@@ -197,13 +216,15 @@ unless defined?(Wreq)
     # @param read_timeout [Integer, nil] Per-chunk read timeout (seconds)
     # @param proxy [String, nil] Proxy server URI
     # @param local_address [String, nil] Bind the client's local source IP address (IPv4/IPv6). Useful on multi-homed hosts to originate connections from a specific address or enforce source routing. Examples: "192.168.1.10", "10.0.0.5", "2001:db8::1". The address must exist on the host and be routable or the connection may fail.
-    # @param interface [String, nil] Bind the socket to a specific network interface via `SO_BINDTODEVICE` (e.g., "eth0", "wlan0", "tun0"). Effective only on systems that support the option (Linux/Android/Fuchsia) and typically requires privileges (root or CAP_NET_ADMIN).
+    # @param interface [String, nil] Bind to an interface on supported platforms; unsupported platforms raise ArgumentError.
     # @param emulation [Wreq::Emulation, nil] Device/OS emulation for this request
     # @param version [Wreq::Version, nil] HTTP version to use
     # @param form [Hash{String=>String}, nil] Form data (application/x-www-form-urlencoded)
-    # @param json [Object, nil] JSON body (will be serialized)
-    # @param body [String, IO, nil] Raw request body (string or stream)
+    # @param json [Object, nil] JSON body serialized by the native encoder; Integer values retain arbitrary precision
+    # @param body [String, Wreq::BodySender, nil] Raw or streaming request body
     # @return [Wreq::Response] HTTP response
+    # @raise [TypeError, ArgumentError, Wreq::BuilderError] if a known option
+    #   value cannot be converted, validated, or built
     def self.delete(url, **options)
     end
 
@@ -212,14 +233,14 @@ unless defined?(Wreq)
     # @param url [String] Target URL
     # @param headers [Wreq::Headers, Hash{String=>String}, nil] Custom headers for this request
     # @param orig_headers [Array<String>, nil] Original header names used to preserve raw header order and HTTP/1 case-sensitive header handling
-    # @param default_headers [Hash{String=>String}, nil] Default headers to merge
+    # @param default_headers [Boolean, nil] Whether to apply native default headers
     # @param query [Hash, nil] URL query parameters
     # @param auth [String, nil] Authorization header value
     # @param bearer_auth [String, nil] Bearer token for Authorization header
     # @param basic_auth [Array<String>, nil] Username and password for basic auth
     # @param cookies [Hash{String=>String}, String, nil] Cookies to send
     # @param allow_redirects [Boolean, nil] Whether to follow redirects
-    # @param max_redirects [Integer, nil] Maximum number of redirects to follow
+    # @param max_redirects [Integer, nil] Maximum redirects; requires allow_redirects: true
     # @param gzip [Boolean, nil] Enable gzip compression
     # @param brotli [Boolean, nil] Enable Brotli compression
     # @param deflate [Boolean, nil] Enable deflate compression
@@ -228,13 +249,15 @@ unless defined?(Wreq)
     # @param read_timeout [Integer, nil] Per-chunk read timeout (seconds)
     # @param proxy [String, nil] Proxy server URI
     # @param local_address [String, nil] Bind the client's local source IP address (IPv4/IPv6). Useful on multi-homed hosts to originate connections from a specific address or enforce source routing. Examples: "192.168.1.10", "10.0.0.5", "2001:db8::1". The address must exist on the host and be routable or the connection may fail.
-    # @param interface [String, nil] Bind the socket to a specific network interface via `SO_BINDTODEVICE` (e.g., "eth0", "wlan0", "tun0"). Effective only on systems that support the option (Linux/Android/Fuchsia) and typically requires privileges (root or CAP_NET_ADMIN).
+    # @param interface [String, nil] Bind to an interface on supported platforms; unsupported platforms raise ArgumentError.
     # @param emulation [Wreq::Emulation, nil] Device/OS emulation for this request
     # @param version [Wreq::Version, nil] HTTP version to use
     # @param form [Hash{String=>String}, nil] Form data (application/x-www-form-urlencoded)
-    # @param json [Object, nil] JSON body (will be serialized)
-    # @param body [String, IO, nil] Raw request body (string or stream)
+    # @param json [Object, nil] JSON body serialized by the native encoder; Integer values retain arbitrary precision
+    # @param body [String, Wreq::BodySender, nil] Raw or streaming request body
     # @return [Wreq::Response] HTTP response
+    # @raise [TypeError, ArgumentError, Wreq::BuilderError] if a known option
+    #   value cannot be converted, validated, or built
     def self.options(url, **options)
     end
 
@@ -243,14 +266,14 @@ unless defined?(Wreq)
     # @param url [String] Target URL
     # @param headers [Wreq::Headers, Hash{String=>String}, nil] Custom headers for this request
     # @param orig_headers [Array<String>, nil] Original header names used to preserve raw header order and HTTP/1 case-sensitive header handling
-    # @param default_headers [Hash{String=>String}, nil] Default headers to merge
+    # @param default_headers [Boolean, nil] Whether to apply native default headers
     # @param query [Hash, nil] URL query parameters
     # @param auth [String, nil] Authorization header value
     # @param bearer_auth [String, nil] Bearer token for Authorization header
     # @param basic_auth [Array<String>, nil] Username and password for basic auth
     # @param cookies [Hash{String=>String}, String, nil] Cookies to send
     # @param allow_redirects [Boolean, nil] Whether to follow redirects
-    # @param max_redirects [Integer, nil] Maximum number of redirects to follow
+    # @param max_redirects [Integer, nil] Maximum redirects; requires allow_redirects: true
     # @param gzip [Boolean, nil] Enable gzip compression
     # @param brotli [Boolean, nil] Enable Brotli compression
     # @param deflate [Boolean, nil] Enable deflate compression
@@ -259,13 +282,15 @@ unless defined?(Wreq)
     # @param read_timeout [Integer, nil] Per-chunk read timeout (seconds)
     # @param proxy [String, nil] Proxy server URI
     # @param local_address [String, nil] Bind the client's local source IP address (IPv4/IPv6). Useful on multi-homed hosts to originate connections from a specific address or enforce source routing. Examples: "192.168.1.10", "10.0.0.5", "2001:db8::1". The address must exist on the host and be routable or the connection may fail.
-    # @param interface [String, nil] Bind the socket to a specific network interface via `SO_BINDTODEVICE` (e.g., "eth0", "wlan0", "tun0"). Effective only on systems that support the option (Linux/Android/Fuchsia) and typically requires privileges (root or CAP_NET_ADMIN).
+    # @param interface [String, nil] Bind to an interface on supported platforms; unsupported platforms raise ArgumentError.
     # @param emulation [Wreq::Emulation, nil] Device/OS emulation for this request
     # @param version [Wreq::Version, nil] HTTP version to use
     # @param form [Hash{String=>String}, nil] Form data (application/x-www-form-urlencoded)
-    # @param json [Object, nil] JSON body (will be serialized)
-    # @param body [String, IO, nil] Raw request body (string or stream)
+    # @param json [Object, nil] JSON body serialized by the native encoder; Integer values retain arbitrary precision
+    # @param body [String, Wreq::BodySender, nil] Raw or streaming request body
     # @return [Wreq::Response] HTTP response
+    # @raise [TypeError, ArgumentError, Wreq::BuilderError] if a known option
+    #   value cannot be converted, validated, or built
     def self.trace(url, **options)
     end
 
@@ -274,14 +299,14 @@ unless defined?(Wreq)
     # @param url [String] Target URL
     # @param headers [Wreq::Headers, Hash{String=>String}, nil] Custom headers for this request
     # @param orig_headers [Array<String>, nil] Original header names used to preserve raw header order and HTTP/1 case-sensitive header handling
-    # @param default_headers [Hash{String=>String}, nil] Default headers to merge
+    # @param default_headers [Boolean, nil] Whether to apply native default headers
     # @param query [Hash, nil] URL query parameters
     # @param auth [String, nil] Authorization header value
     # @param bearer_auth [String, nil] Bearer token for Authorization header
     # @param basic_auth [Array<String>, nil] Username and password for basic auth
     # @param cookies [Hash{String=>String}, String, nil] Cookies to send
     # @param allow_redirects [Boolean, nil] Whether to follow redirects
-    # @param max_redirects [Integer, nil] Maximum number of redirects to follow
+    # @param max_redirects [Integer, nil] Maximum redirects; requires allow_redirects: true
     # @param gzip [Boolean, nil] Enable gzip compression
     # @param brotli [Boolean, nil] Enable Brotli compression
     # @param deflate [Boolean, nil] Enable deflate compression
@@ -290,13 +315,15 @@ unless defined?(Wreq)
     # @param read_timeout [Integer, nil] Per-chunk read timeout (seconds)
     # @param proxy [String, nil] Proxy server URI
     # @param local_address [String, nil] Bind the client's local source IP address (IPv4/IPv6). Useful on multi-homed hosts to originate connections from a specific address or enforce source routing. Examples: "192.168.1.10", "10.0.0.5", "2001:db8::1". The address must exist on the host and be routable or the connection may fail.
-    # @param interface [String, nil] Bind the socket to a specific network interface via `SO_BINDTODEVICE` (e.g., "eth0", "wlan0", "tun0"). Effective only on systems that support the option (Linux/Android/Fuchsia) and typically requires privileges (root or CAP_NET_ADMIN).
+    # @param interface [String, nil] Bind to an interface on supported platforms; unsupported platforms raise ArgumentError.
     # @param emulation [Wreq::Emulation, nil] Device/OS emulation for this request
     # @param version [Wreq::Version, nil] HTTP version to use
     # @param form [Hash{String=>String}, nil] Form data (application/x-www-form-urlencoded)
-    # @param json [Object, nil] JSON body (will be serialized)
-    # @param body [String, IO, nil] Raw request body (string or stream)
+    # @param json [Object, nil] JSON body serialized by the native encoder; Integer values retain arbitrary precision
+    # @param body [String, Wreq::BodySender, nil] Raw or streaming request body
     # @return [Wreq::Response] HTTP response
+    # @raise [TypeError, ArgumentError, Wreq::BuilderError] if a known option
+    #   value cannot be converted, validated, or built
     def self.patch(url, **options)
     end
   end

data/lib/wreq_ruby/body.rb

@@ -2,10 +2,10 @@
 
 unless defined?(Wreq)
   module Wreq
-    # BodySender: for streaming request bodies, allowing thread-safe chunked data push.
-    # Backed by a Rust channel, avoids buffering the entire payload in memory.
+    # Streams a request body through a bounded, thread-safe channel.
     #
-    # Supports multi-threaded chunk push: you can safely call `push` from multiple threads.
+    # The channel applies backpressure instead of buffering the entire request body.
+    # Multiple threads may safely push chunks while a request drains the receiving side.
     #
     # Usage:
     #   sender = Wreq::BodySender.new(8)
@@ -15,22 +15,43 @@ unless defined?(Wreq)
     #   end
     #   resp = client.post(url, body: sender)
     #
-    # Note:
-    #   - Sender is for request upload only, not for response reading.
-    #   - Each BodySender instance can only be used once (single-use):
-    #     after being consumed by a request, further push or reuse is not allowed.
+    # A sender can be attached to one request. Closing it prevents further writes but
+    # retains queued chunks so a request attached afterward can still drain them.
     class BodySender
-      # @param capacity [Integer] channel buffer size, default 8
+      # Create a bounded request-body sender.
+      #
+      # @param capacity [Integer] positive number of chunks that may wait in the channel;
+      #   defaults to 8 and must be greater than zero
+      # @return [Wreq::BodySender] A streaming request body sender
+      # @raise [ArgumentError] if capacity is zero, negative, or too large
+      # @raise [TypeError] if capacity is not an Integer
       def self.new(capacity = 8)
       end
 
+      # Push one binary chunk, waiting while the channel is full.
+      #
       # @param data [String] binary chunk
+      # @return [nil]
+      # @raise [IOError] if the sender or receiving side is closed
       def push(data)
       end
 
-      # Close the sender, signaling end of data.
+      # Close the producer and signal EOF after all queued chunks are read.
+      #
+      # This operation is idempotent.
+      #
+      # @return [nil]
       def close
       end
+
+      # Return whether the sender can no longer accept chunks.
+      #
+      # This becomes true after {#close} or when the request stops consuming
+      # the receiving side.
+      #
+      # @return [Boolean]
+      def closed?
+      end
     end
   end
 end