Module: Mongo::Protocol::Serializers::Byte Private

Defined in:
lib/mongo/protocol/serializers.rb

Overview

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

MongoDB wire protocol serialization strategy for a single byte.

Writes and fetches a single byte from the byte buffer.

Class Method Summary collapse

Class Method Details

.deserialize(buffer) ⇒ 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.

Deserializes a byte from the byte buffer.

Parameters:

  • buffer (BSON::ByteBuffer)

    Buffer containing the value to read.

Returns:

  • (String)

    The byte.

Since:

  • 2.5.0



376
377
378
# File 'lib/mongo/protocol/serializers.rb', line 376

def self.deserialize(buffer)
  buffer.get_byte
end

.serialize(buffer, value, validating_keys = BSON::Config.validating_keys?) ⇒ BSON::ByteBuffer

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.

Writes a byte into the buffer.

Parameters:

  • buffer (BSON::ByteBuffer)

    Buffer to receive the single byte.

  • value (String)

    The byte to write to the buffer.

  • validating_keys (true, false) (defaults to: BSON::Config.validating_keys?)

    Whether to validate keys.

Returns:

  • (BSON::ByteBuffer)

    Buffer with serialized value.

Since:

  • 2.5.0



365
366
367
# File 'lib/mongo/protocol/serializers.rb', line 365

def self.serialize(buffer, value, validating_keys = BSON::Config.validating_keys?)
  buffer.put_byte(value)
end