123456789_123456789_123456789_123456789_123456789_

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

Relationships & Source Files
Defined in: lib/mongo/protocol/serializers.rb

Overview

MongoDB wire protocol serialization strategy for a single byte.

Writes and fetches a single byte from the byte buffer.

Class Method Summary

Class Method Details

.deserialize(buffer, options = {}) ⇒ String

Deserializes a byte from the byte buffer.

Parameters:

  • buffer (BSON::ByteBuffer) —

    Buffer containing the value to read.

  • options (Hash) (defaults to: {}) —

    This method currently accepts no options.

Returns:

  • (String) —

    The byte.

Since:

  • 2.5.0

[ GitHub ] 

  


# File 'lib/mongo/protocol/serializers.rb', line 426



def self.deserialize(buffer, options = {})
  buffer.get_byte
end


  








  

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



  

    

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: nil)
—    
    

    Whether to validate keys. This option is deprecated and will not be used. It will removed in version 3.0.
    

    
  
    • 



Returns:


    
  
  • 
    (BSON::ByteBuffer)
—    
    

    Buffer with serialized value.
    

    
  
    • 



Since:


    
  
  • 
    
    

    2.5.0
    

    
  
    • 





  [ GitHub ]


  

  


# File 'lib/mongo/protocol/serializers.rb', line 414



def self.serialize(buffer, value, validating_keys = nil)
  buffer.put_byte(value)
end