Class: ZSTDS::Stream::Abstract

Inherits:
Object
  • Object
show all
Includes:
Delegates
Defined in:
lib/zstds/stream/abstract.rb

Direct Known Subclasses

Reader, Writer

Constant Summary

Constants included from Delegates

Delegates::DELEGATES

Instance Attribute Summary collapse

Instance Method Summary collapse

Methods included from Delegates

included

Constructor Details

#initialize(io, options = {}) ⇒ Abstract

Returns a new instance of Abstract.



25
26
27
28
29
30
31
32
33
34
35
36
37
38
 
# File 'lib/zstds/stream/abstract.rb', line 25

def initialize(io, options = {})
  @raw_stream = create_raw_stream

  Validation.validate_io io
  @io = io

  @stat = Stat.new @io.stat if @io.respond_to? :stat

  set_encoding options[:external_encoding], options[:internal_encoding], options[:transcode_options]
  reset_buffer
  reset_io_advise

  @pos = 0
end

Instance Attribute Details

#external_encoding ⇒ Object (readonly)

Returns the value of attribute external_encoding.



21
22
23
 
# File 'lib/zstds/stream/abstract.rb', line 21

def external_encoding
  @external_encoding
end

#internal_encoding ⇒ Object (readonly)

Returns the value of attribute internal_encoding.



21
22
23
 
# File 'lib/zstds/stream/abstract.rb', line 21

def internal_encoding
  @internal_encoding
end

#io ⇒ Object (readonly)

Returns the value of attribute io.



21
22
23
 
# File 'lib/zstds/stream/abstract.rb', line 21

def io
  @io
end

#pos ⇒ Object (readonly) Also known as: tell

Returns the value of attribute pos.



21
22
23
 
# File 'lib/zstds/stream/abstract.rb', line 21

def pos
  @pos
end

#stat ⇒ Object (readonly)

Returns the value of attribute stat.



21
22
23
 
# File 'lib/zstds/stream/abstract.rb', line 21

def stat
  @stat
end

#transcode_options ⇒ Object (readonly)

Returns the value of attribute transcode_options.



21
22
23
 
# File 'lib/zstds/stream/abstract.rb', line 21

def transcode_options
  @transcode_options
end

Instance Method Details

#advise ⇒ Object 



55
56
57
58
 
# File 'lib/zstds/stream/abstract.rb', line 55

def advise
  # Noop
  nil
end

#close ⇒ Object 



137
138
139
140
141
 
# File 'lib/zstds/stream/abstract.rb', line 137

def close
  @io.close

  nil
end

#closed? ⇒ Boolean

Returns:

  • (Boolean) 


143
144
145
 
# File 'lib/zstds/stream/abstract.rb', line 143

def closed?
  @raw_stream.closed? && @io.closed?
end

#rewind ⇒ Object

– etc –



124
125
126
127
128
129
130
131
132
133
134
135
 
# File 'lib/zstds/stream/abstract.rb', line 124

def rewind
  @raw_stream = create_raw_stream

  @io.rewind if @io.respond_to? :rewind

  reset_buffer
  reset_io_advise

  @pos = 0

  0
end

#set_encoding(*args) ⇒ Object

– encoding –



62
63
64
65
66
67
68
69
70
 
# File 'lib/zstds/stream/abstract.rb', line 62

def set_encoding(*args)
  external_encoding, internal_encoding, transcode_options = process_set_encoding_arguments(*args)

  set_target_encoding :@external_encoding, external_encoding
  set_target_encoding :@internal_encoding, internal_encoding
  @transcode_options = transcode_options

  self
end

#to_io ⇒ Object 



147
148
149
 
# File 'lib/zstds/stream/abstract.rb', line 147

def to_io
  self
end