Module: StraightReadableIO

Defined in:
lib/block_cipher_kit/io_types.rb

Overview

Used as a stand-in for any IO-ish that responds to #read. This module is defined for YARD docs so that Sorbet has a proper type definition.

Instance Method Summary collapse

Instance Method Details

#read(n) ⇒ String?

Returns a String in binary encoding or nil.

Parameters:

  • n (Integer) —

    how many bytes to read from the IO

Returns:

  • (String, nil) —

    a String in binary encoding or nil



6
7
 
# File 'lib/block_cipher_kit/io_types.rb', line 6

def read(n)
end