io-stream 0.4.3 → 0.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 6e86dd2d0db65582e6b9655493776e1f3fa16c8d22af92d40c7c2f1ae374c7ee
-  data.tar.gz: e6299a23d03c263361f04bae8ec29c3d0b70c2f19d6cdfe64ff601d6b7bb7c64
+  metadata.gz: 6d85df6aecb7833dd6945292040cb635510f088df8dc0f9427b207ada1b8fcfa
+  data.tar.gz: 07b3d70a28adc36c23286f42f92c0d9eec99a3a176efbbb839c3f4c9d34a13fd
 SHA512:
-  metadata.gz: 16d2aff35b208b029c2b917cd6a423d5ee54547939a39e5575f2641d8060b793a03a5a0903a885216142d99369ba80f8941d35ab07739a11c95d2c98dfa1d3cd
-  data.tar.gz: af90134348a217f72fe90dea4cab0c2c4e7fc6b7a2c27345b865642191c9aa0bdda16b2e1856114d1e42bbf7f9c6be7bb506daa8cb9724baae2fdf1534dcc85e
+  metadata.gz: e40a994276d5cab512b1c77213ba48c02fe7916256c0070893f37bc641baea4ecf277ee3695b76357617b6e5366ddb22fbf8ff5839f7c64698edc01b3bc2ced9
+  data.tar.gz: 21ae83634d2c036a2c60865fdafb26de516fc8a0822c45ff018fd6c887079c73dcb63ace72f07b316d87b5973b4de5d3d673d435a89f09c755361ab0a63238ce

data/lib/io/stream/generic.rb

@@ -86,9 +86,11 @@ module IO::Stream
 		end
 		
 		# Efficiently read data from the stream until encountering pattern.
-		# @param pattern [String] The pattern to match.
-		# @return [String] The contents of the stream up until the pattern, which is consumed but not returned.
-		def read_until(pattern, offset = 0, chomp: true)
+		# @parameter pattern [String] The pattern to match.
+		# @parameter offset [Integer] The offset to start searching from.
+		# @parameter limit [Integer] The maximum number of bytes to read, including the pattern (even if chomped).
+		# @returns [String | Nil] The contents of the stream up until the pattern, which is consumed but not returned.
+		def read_until(pattern, offset = 0, limit: nil, chomp: true)
 			# We don't want to split on the pattern, so we subtract the size of the pattern.
 			split_offset = pattern.bytesize - 1
 			
@@ -97,9 +99,12 @@ module IO::Stream
 				
 				offset = 0 if offset < 0
 				
-				return unless fill_read_buffer
+				return nil if limit and offset >= limit
+				return nil unless fill_read_buffer
 			end
 			
+			return nil if limit and index >= limit
+			
 			@read_buffer.freeze
 			matched = @read_buffer.byteslice(0, index+(chomp ? 0 : pattern.bytesize))
 			@read_buffer = @read_buffer.byteslice(index+pattern.bytesize, @read_buffer.bytesize)
@@ -148,8 +153,8 @@ module IO::Stream
 		
 		# Writes `string` to the buffer. When the buffer is full or #sync is true the
 		# buffer is flushed to the underlying `io`.
-		# @param string the string to write to the buffer.
-		# @return the number of bytes appended to the buffer.
+		# @parameter string [String] the string to write to the buffer.
+		# @returns [Integer] the number of bytes appended to the buffer.
 		def write(string, flush: false)
 			@writing.synchronize do
 				@write_buffer << string
@@ -292,7 +297,7 @@ module IO::Stream
 		end
 		
 		# Consumes at most `size` bytes from the buffer.
-		# @param size [Integer|nil] The amount of data to consume. If nil, consume entire buffer.
+		# @parameter size [Integer|nil] The amount of data to consume. If nil, consume entire buffer.
 		def consume_read_buffer(size = nil)
 			# If we are at eof, and the read buffer is empty, we can't consume anything.
 			return nil if @eof && @read_buffer.empty?

data/lib/io/stream/version.rb

@@ -4,5 +4,5 @@
 # Copyright, 2023-2024, by Samuel Williams.
 
 module IO::Stream
-	VERSION = "0.4.3"
+	VERSION = "0.5.0"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: io-stream
 version: !ruby/object:Gem::Version
-  version: 0.4.3
+  version: 0.5.0
 platform: ruby
 authors:
 - Samuel Williams
@@ -37,7 +37,7 @@ cert_chain:
   Q2K9NVun/S785AP05vKkXZEFYxqG6EW012U4oLcFl5MySFajYXRYbuUpH6AY+HP8
   voD0MPg1DssDLKwXyt1eKD/+Fq0bFWhwVM/1XiAXL7lyYUyOq24KHgQ2Csg=
   -----END CERTIFICATE-----
-date: 2024-10-02 00:00:00.000000000 Z
+date: 2024-10-14 00:00:00.000000000 Z
 dependencies: []
 description:
 email: