io-stream 0.10.0 → 0.11.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c9a2897049a042fc1a0ba9a45d3f5700375938c6983d2ad2752f68c98b187b0c
-  data.tar.gz: 7991aaf45961ca5ec63254a1f83dffa5af87a1b4950aa0d0484ea4d23b55f7f0
+  metadata.gz: aa0f71cc4addc72776d1dbc02c14d0edb79fc0ae250aebb7f0d4924f6b251701
+  data.tar.gz: b5f6ec1328debef8a9b9f9d8593f8a929504e5f0cc170cb780fec41a75ac38f2
 SHA512:
-  metadata.gz: ee85bb6dd18c0281d3dbe0d3af1a8cb5379834e40666e0a77c813a372f05dea8dda255a29c0196517ca978860f0032ee15bfec89cfb8770c1a24416acfc1d189
-  data.tar.gz: 399269a7444a2763b7ef82f2dacc2954aa06e82e3859a88411f7291f6afc98949d93a5b2936fdc8a0d493df3c38ee216b40e9055017f8c9f6c5dd95fcfc6116c
+  metadata.gz: bd297845e8fdcabd8879baa92e46908129d585a378bf982a1e6f051d67748d216aa7435cbd391bebf2ae364838893c372666a1c10d5de36fcef4e91884377cd1
+  data.tar.gz: 857c75d7a920b8f4b6dbcda4746ae41e059eb936cda6f1ea347191843996e00af4a87d4f6e04b0be219c1b4199f59d9ccb3b1114a15619f131186aba68b833e5

data/lib/io/stream/buffered.rb

@@ -1,9 +1,10 @@
 # frozen_string_literal: true
 
 # Released under the MIT License.
-# Copyright, 2024, by Samuel Williams.
+# Copyright, 2024-2025, by Samuel Williams.
 
 require_relative "generic"
+require_relative "connection_reset_error"
 
 module IO::Stream
 	# A buffered stream implementation that wraps an underlying IO object to provide efficient buffered reading and writing.
@@ -59,34 +60,34 @@ module IO::Stream
 				@timeout = nil
 			end
 		end
-
+		
 		# @attribute [IO] The wrapped IO object.
 		attr :io
-
+		
 		# Get the underlying IO object.
 		# @returns [IO] The underlying IO object.
 		def to_io
 			@io.to_io
 		end
-
+		
 		# Check if the stream is closed.
 		# @returns [Boolean] True if the stream is closed.
 		def closed?
 			@io.closed?
 		end
-
+		
 		# Close the read end of the stream.
 		def close_read
 			@io.close_read
 		end
-
+		
 		# Close the write end of the stream.
 		def close_write
 			super
 		ensure
 			@io.close_write
 		end
-
+		
 		# Check if the stream is readable.
 		# @returns [Boolean] True if the stream is readable.
 		def readable?
@@ -146,6 +147,12 @@ module IO::Stream
 					return result
 				end
 			end
+		rescue OpenSSL::SSL::SSLError => error
+			if error.message =~ /unexpected eof while reading/
+				raise ConnectionResetError, "Connection reset by peer!"
+			end
+		rescue Errno::ECONNRESET
+			raise ConnectionResetError, "Connection reset by peer!"
 		rescue Errno::EBADF
 			raise ::IOError, "stream closed"
 		end

data/lib/io/stream/connection_reset_error.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+module IO::Stream
+	# Represents a connection reset error in IO streams, usually occurring when the remote side closes the connection unexpectedly.
+	class ConnectionResetError < Errno::ECONNRESET
+	end
+end

data/lib/io/stream/generic.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 # Released under the MIT License.
-# Copyright, 2023-2024, by Samuel Williams.
+# Copyright, 2023-2025, by Samuel Williams.
 
 require_relative "string_buffer"
 require_relative "readable"
@@ -18,6 +18,14 @@ module IO::Stream
 		include Readable
 		include Writable
 		
+		# Check if a method is async-safe.
+		#
+		# @parameter method [Symbol] The method name to check.
+		# @returns [Symbol | Boolean] The concurrency guard for the given method.
+		def self.async_safe?(method)
+			Readable.async_safe?(method) || Writable.async_safe?(method)
+		end
+		
 		# Initialize a new generic stream.
 		# @parameter options [Hash] Options passed to included modules.
 		def initialize(**options)

data/lib/io/stream/openssl.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 # Released under the MIT License.
-# Copyright, 2024, by Samuel Williams.
+# Copyright, 2024-2025, by Samuel Williams.
 
 require "openssl"
 

data/lib/io/stream/readable.rb

@@ -1,17 +1,17 @@
 # frozen_string_literal: true
 
 # Released under the MIT License.
-# Copyright, 2023-2024, by Samuel Williams.
+# Copyright, 2025, by Samuel Williams.
 
 require_relative "string_buffer"
 
 module IO::Stream
 	# The default block size for IO buffers. Defaults to 256KB (optimized for modern SSDs and networks).
 	BLOCK_SIZE = ENV.fetch("IO_STREAM_BLOCK_SIZE", 1024*256).to_i
-
+	
 	# The minimum read size for efficient I/O operations. Defaults to the same as BLOCK_SIZE.
 	MINIMUM_READ_SIZE = ENV.fetch("IO_STREAM_MINIMUM_READ_SIZE", BLOCK_SIZE).to_i
-
+	
 	# The maximum read size for a single read operation. This limit exists because:
 	# 1. System calls like read() cannot handle requests larger than SSIZE_MAX
 	# 2. Very large reads can cause memory pressure and poor interactive performance  
@@ -25,6 +25,31 @@ module IO::Stream
 	#
 	# You must implement the `sysread` method to read data from the underlying IO.
 	module Readable
+		ASYNC_SAFE = {
+			read: :readable,
+			read_partial: :readable,
+			read_exactly: :readable,
+			read_until: :readable,
+			peek: :readable,
+			gets: :readable,
+			getc: :readable,
+			getbyte: :readable,
+			readline: :readable,
+			readlines: :readable,
+			readable?: :readable,
+			fill_read_buffer: :readable,
+			eof?: :readable,
+			finished?: :readable,
+		}.freeze
+		
+		# Check if a method is async-safe.
+		#
+		# @parameter method [Symbol] The method name to check.
+		# @returns [Symbol | Boolean] The concurrency guard for the given method.
+		def self.async_safe?(method)
+			ASYNC_SAFE.fetch(method, false)
+		end
+		
 		# Initialize readable stream functionality.
 		# @parameter minimum_read_size [Integer] The minimum size for read operations.
 		# @parameter maximum_read_size [Integer] The maximum size for read operations.
@@ -41,21 +66,21 @@ module IO::Stream
 			
 			super(**, &block) if defined?(super)
 		end
-
+		
 		attr_accessor :minimum_read_size
-
+		
 		# Legacy accessor for backwards compatibility
 		# @returns [Integer] The minimum read size.
 		def block_size
 			@minimum_read_size
 		end
-
+		
 		# Legacy setter for backwards compatibility
 		# @parameter value [Integer] The minimum read size.
 		def block_size=(value)
 			@minimum_read_size = value
 		end
-
+		
 		# Read data from the stream.
 		# @parameter size [Integer | Nil] The number of bytes to read. If nil, read until end of stream.
 		# @parameter buffer [String | Nil] An optional buffer to fill with data instead of allocating a new string.
@@ -113,7 +138,7 @@ module IO::Stream
 					return String.new(encoding: Encoding::BINARY)
 				end
 			end
-		
+			
 			if !@finished and @read_buffer.empty?
 				fill_read_buffer
 			end

data/lib/io/stream/shim/buffered.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 # Released under the MIT License.
-# Copyright, 2023-2024, by Samuel Williams.
+# Copyright, 2023-2025, by Samuel Williams.
 
 unless IO.method_defined?(:buffered?, false)
 	class IO

data/lib/io/stream/shim/readable.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 # Released under the MIT License.
-# Copyright, 2023-2024, by Samuel Williams.
+# Copyright, 2023-2025, by Samuel Williams.
 
 class IO
 	unless method_defined?(:readable?, false)

data/lib/io/stream/string_buffer.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 # Released under the MIT License.
-# Copyright, 2023-2024, by Samuel Williams.
+# Copyright, 2023-2025, by Samuel Williams.
 
 module IO::Stream
 	# A specialized string buffer for binary data with automatic encoding handling.

data/lib/io/stream/version.rb

@@ -1,8 +1,8 @@
 # frozen_string_literal: true
 
 # Released under the MIT License.
-# Copyright, 2023-2024, by Samuel Williams.
+# Copyright, 2023-2025, by Samuel Williams.
 
 module IO::Stream
-	VERSION = "0.10.0"
+	VERSION = "0.11.1"
 end

data/lib/io/stream/writable.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 # Released under the MIT License.
-# Copyright, 2023-2024, by Samuel Williams.
+# Copyright, 2025, by Samuel Williams.
 
 require_relative "readable"
 
@@ -13,6 +13,20 @@ module IO::Stream
 	#
 	# You must implement the `syswrite` method to write data to the underlying IO.
 	module Writable
+		ASYNC_SAFE = {
+			write: true,
+			puts: true,
+			flush: true,
+		}.freeze
+		
+		# Check if a method is async-safe.
+		#
+		# @parameter method [Symbol] The method name to check.
+		# @returns [Symbol | Boolean] The concurrency guard for the given method.
+		def self.async_safe?(method)
+			ASYNC_SAFE.fetch(method, false)
+		end
+		
 		# Initialize writable stream functionality.
 		# @parameter minimum_write_size [Integer] The minimum buffer size before flushing.
 		def initialize(minimum_write_size: MINIMUM_WRITE_SIZE, **, &block)

data/lib/io/stream.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 # Released under the MIT License.
-# Copyright, 2023-2024, by Samuel Williams.
+# Copyright, 2023-2025, by Samuel Williams.
 
 require_relative "stream/version"
 require_relative "stream/buffered"

data/readme.md

@@ -12,6 +12,11 @@ Please see the [project documentation](https://socketry.github.io/io-stream) for
 
 Please see the [project releases](https://socketry.github.io/io-streamreleases/index) for all releases.
 
+### v0.11.0
+
+  - Introduce `class IO::Stream::ConnectionResetError < Errno::ECONNRESET` to standardize connection reset error handling across different IO types.
+      - `OpenSSL::SSL::SSLSocket` raises `OpenSSL::SSL::SSLError` on connection reset, while other IO types raise `Errno::ECONNRESET`. `SSLError` is now rescued and re-raised as `IO::Stream::ConnectionResetError` for consistency.
+
 ### v0.10.0
 
   - Rename `done?` to `finished?` for clarity and consistency.
@@ -54,11 +59,6 @@ Please see the [project releases](https://socketry.github.io/io-streamreleases/i
   - Ensure TLS connections have correct buffering behavior.
   - Improve test suite organization and readability.
 
-### v0.4.2
-
-  - Add external test suite for better integration testing.
-  - Update dependencies and improve code style with RuboCop.
-
 ## See Also
 
   - [async-io](https://github.com/socketry/async-io) — Where this implementation originally came from.

data/releases.md

@@ -1,5 +1,10 @@
 # Releases
 
+## v0.11.0
+
+  - Introduce `class IO::Stream::ConnectionResetError < Errno::ECONNRESET` to standardize connection reset error handling across different IO types.
+      - `OpenSSL::SSL::SSLSocket` raises `OpenSSL::SSL::SSLError` on connection reset, while other IO types raise `Errno::ECONNRESET`. `SSLError` is now rescued and re-raised as `IO::Stream::ConnectionResetError` for consistency.
+
 ## v0.10.0
 
   - Rename `done?` to `finished?` for clarity and consistency.

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: io-stream
 version: !ruby/object:Gem::Version
-  version: 0.10.0
+  version: 0.11.1
 platform: ruby
 authors:
 - Samuel Williams
@@ -44,6 +44,7 @@ extra_rdoc_files: []
 files:
 - lib/io/stream.rb
 - lib/io/stream/buffered.rb
+- lib/io/stream/connection_reset_error.rb
 - lib/io/stream/generic.rb
 - lib/io/stream/openssl.rb
 - lib/io/stream/readable.rb
@@ -75,7 +76,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.6.7
+rubygems_version: 3.6.9
 specification_version: 4
 summary: Provides a generic stream wrapper for IO instances.
 test_files: []