Class: OpenAI::Internal::Util::ReadIOAdapter Private

Inherits:
Object
  • Object
show all
Defined in:
lib/openai/internal/read_io_adapter.rb,
sig/openai/internal/read_io_adapter.rbs

Overview

This class is part of a private API. You should avoid using this class if possible, as it may be removed or be changed in the future.

An adapter that satisfies the IO interface required by ::IO.copy_stream

Instance Method Summary collapse

Constructor Details

#initialize(src, &blk) {|| ... } ⇒ ReadIOAdapter

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

Returns a new instance of ReadIOAdapter.

Parameters:

  • src (String, Pathname, StringIO, Enumerable<String>)
  • blk (Proc)

Yield Parameters:

  • (String) 


117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
 
# File 'lib/openai/internal/read_io_adapter.rb', line 117

def initialize(src, &blk)
  @stream =
    case src
    in String
      StringIO.new(src)
    in Pathname
      @closing = true
      src.open(binmode: true)
    in Enumerator
      @closing = true
      InterruptibleEnumerator.new(src)
    else
      src
    end
  @buf = String.new
  @blk = blk
end

Instance Method Details

#close ⇒ void

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

This method returns an undefined value.



59
60
61
62
63
64
65
66
67
 
# File 'lib/openai/internal/read_io_adapter.rb', line 59

def close
  case @stream
  in Enumerator
    OpenAI::Internal::Util.close_fused!(@stream)
  in InterruptibleEnumerator | IO if close?
    @stream.close
  else
  end
end

#close? ⇒ Boolean?

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

Returns:



56
 
# File 'lib/openai/internal/read_io_adapter.rb', line 56

def close? = @closing

#read(max_len = nil, out_string = nil) ⇒ String?

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

Parameters:

  • max_len (Integer, nil) (defaults to: nil)
  • out_string (String, nil) (defaults to: nil)

Returns:

  • (String, nil) 


93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
 
# File 'lib/openai/internal/read_io_adapter.rb', line 93

def read(max_len = nil, out_string = nil)
  case @stream
  in nil
    nil
  in IO | StringIO
    @stream.read(max_len, out_string)
  in Enumerator | InterruptibleEnumerator
    read = read_enum(max_len)
    case out_string
    in String
      out_string.replace(read)
    in nil
      read
    end
  end
    .tap(&@blk)
end