Class: BSON::ByteBuffer

Inherits:
Object
  • Object
show all
Defined in:
lib/bson/byte_buffer.rb

Direct Known Subclasses

Binary

Constant Summary collapse

NULL_BYTE = 
"\0"
UTF8_ENCODING = 
Encoding.find('utf-8')
BINARY_ENCODING = 
Encoding.find('binary')

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(initial_data = "") ⇒ ByteBuffer

Returns a new instance of ByteBuffer.



25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
 
# File 'lib/bson/byte_buffer.rb', line 25

def initialize(initial_data="")
  @str = case initial_data
    when String then
      if initial_data.respond_to?(:force_encoding)
        initial_data.force_encoding('binary')
      else
        initial_data
      end
    when BSON::ByteBuffer then
      initial_data.to_a.pack('C*')
    else
      initial_data.pack('C*')
  end

  @cursor = @str.length
  @order  = :little_endian
  @int_pack_order    = 'V'
  @double_pack_order = 'E'
end

Instance Attribute Details

#order ⇒ Object

Returns the value of attribute order.



23
24
25
 
# File 'lib/bson/byte_buffer.rb', line 23

def order
  @order
end

Class Method Details

.serialize_cstr(buf, val) ⇒ Object 



66
67
68
69
 
# File 'lib/bson/byte_buffer.rb', line 66

def self.serialize_cstr(buf, val)
  buf.append!(to_utf8_binary(val.to_s))
  buf.append!(NULL_BYTE)
end

.to_utf8_binary(str) ⇒ Object 



50
51
52
 
# File 'lib/bson/byte_buffer.rb', line 50

def self.to_utf8_binary(str)
  str.encode(UTF8_ENCODING).force_encoding(BINARY_ENCODING)
end

Instance Method Details

#append!(buffer) ⇒ Object

Appends a second ByteBuffer object, buffer, to the current buffer.



102
103
104
105
 
# File 'lib/bson/byte_buffer.rb', line 102

def append!(buffer)
  @str << buffer.to_s
  self
end

#clear ⇒ Object 



90
91
92
93
94
 
# File 'lib/bson/byte_buffer.rb', line 90

def clear
  @str = ""
  @str.force_encoding('binary') if @str.respond_to?(:force_encoding)
  rewind
end

#dump ⇒ Object 



247
248
249
250
251
252
253
 
# File 'lib/bson/byte_buffer.rb', line 247

def dump
  i = 0
  @str.each_byte do |c, i|
    $stderr.puts "#{'%04d' % i}: #{'%02x' % c} #{'%03o' % c} #{'%s' % c.chr} #{'%3d' % c}"
    i += 1
  end
end

#get(len = nil) ⇒ Object 



180
181
182
183
184
185
186
187
188
189
190
191
 
# File 'lib/bson/byte_buffer.rb', line 180

def get(len=nil)
  one_byte = len.nil?
  len ||= 1
  check_read_length(len)
  start = @cursor
  @cursor += len
  if one_byte
    @str[start]
  else
    @str[start, len].unpack("C*")
  end
end

#get_double ⇒ Object 



224
225
226
227
228
229
 
# File 'lib/bson/byte_buffer.rb', line 224

def get_double
  check_read_length(8)
  vals = @str[@cursor..@cursor+7]
  @cursor += 8
  vals.unpack(@double_pack_order)[0]
end

#get_int ⇒ Object 



207
208
209
210
211
212
 
# File 'lib/bson/byte_buffer.rb', line 207

def get_int
  check_read_length(4)
  vals = @str[@cursor..@cursor+3]
  @cursor += 4
  vals.unpack(@int_pack_order)[0]
end

#get_long ⇒ Object 



214
215
216
217
218
219
220
221
222
 
# File 'lib/bson/byte_buffer.rb', line 214

def get_long
  i1 = get_int
  i2 = get_int
  if @int_pack_order == 'N'
    (i1 << 32) + i2
  else
    (i2 << 32) + i1
  end
end

#more? ⇒ Boolean

Returns:

  • (Boolean) 


231
232
233
 
# File 'lib/bson/byte_buffer.rb', line 231

def more?
  @cursor < @str.size
end

#position ⇒ Object 



82
83
84
 
# File 'lib/bson/byte_buffer.rb', line 82

def position
  @cursor
end

#position=(val) ⇒ Object 



86
87
88
 
# File 'lib/bson/byte_buffer.rb', line 86

def position=(val)
  @cursor = val
end

#prepend!(buffer) ⇒ Object

Prepends a second ByteBuffer object, buffer, to the current buffer.



108
109
110
111
 
# File 'lib/bson/byte_buffer.rb', line 108

def prepend!(buffer)
  @str = buffer.to_s + @str
  self
end

#put(byte, offset = nil) ⇒ Object 



113
114
115
116
117
118
119
120
121
122
 
# File 'lib/bson/byte_buffer.rb', line 113

def put(byte, offset=nil)
  @cursor = offset if offset
  if more?
    @str[@cursor] = chr(byte)
  else
    ensure_length(@cursor)
    @str << chr(byte)
  end
  @cursor += 1
end

#put_array(array, offset = nil) ⇒ Object 



138
139
140
141
142
143
144
145
146
147
 
# File 'lib/bson/byte_buffer.rb', line 138

def put_array(array, offset=nil)
  @cursor = offset if offset
  if more?
    @str[@cursor, array.length] = array.pack("C*")
  else
    ensure_length(@cursor)
    @str << array.pack("C*")
  end
  @cursor += array.length
end

#put_binary(data, offset = nil) ⇒ Object 



124
125
126
127
128
129
130
131
132
133
134
135
136
 
# File 'lib/bson/byte_buffer.rb', line 124

def put_binary(data, offset=nil)
  @cursor = offset if offset
  if defined?(BINARY_ENCODING)
    data = data.dup.force_encoding(BINARY_ENCODING)
  end
  if more?
    @str[@cursor, data.length] = data
  else
    ensure_length(@cursor)
    @str << data
  end
  @cursor += data.length
end

#put_double(d, offset = nil) ⇒ Object 



171
172
173
174
175
 
# File 'lib/bson/byte_buffer.rb', line 171

def put_double(d, offset=nil)
  a = []
  [d].pack(@double_pack_order).each_byte { |b| a << b }
  put_array(a, offset)
end

#put_int(i, offset = nil) ⇒ Object 



149
150
151
152
153
154
155
156
157
158
 
# File 'lib/bson/byte_buffer.rb', line 149

def put_int(i, offset=nil)
  @cursor = offset if offset
  if more?
    @str[@cursor, 4] = [i].pack(@int_pack_order)
  else
    ensure_length(@cursor)
    @str << [i].pack(@int_pack_order)
  end
  @cursor += 4
end

#put_long(i, offset = nil) ⇒ Object 



160
161
162
163
164
165
166
167
168
169
 
# File 'lib/bson/byte_buffer.rb', line 160

def put_long(i, offset=nil)
  offset = @cursor unless offset
  if @int_pack_order == 'N'
    put_int(i >> 32, offset)
    put_int(i & 0xffffffff, offset + 4)
  else
    put_int(i & 0xffffffff, offset)
    put_int(i >> 32, offset + 4)
  end
end

#rewind ⇒ Object 



78
79
80
 
# File 'lib/bson/byte_buffer.rb', line 78

def rewind
  @cursor = 0
end

#size ⇒ Object Also known as: length 



96
97
98
 
# File 'lib/bson/byte_buffer.rb', line 96

def size
  @str.size
end

#to_a ⇒ Object 



235
236
237
 
# File 'lib/bson/byte_buffer.rb', line 235

def to_a
  @str.unpack("C*")
end

#to_s ⇒ Object 



243
244
245
 
# File 'lib/bson/byte_buffer.rb', line 243

def to_s
  @str
end

#unpack(args) ⇒ Object 



239
240
241
 
# File 'lib/bson/byte_buffer.rb', line 239

def unpack(args)
  to_a
end