123456789_123456789_123456789_123456789_123456789_

Class: Mongo::Crypt::Binary Private

Do not use. This class is for internal use only.
Relationships & Source Files
Inherits: Object
Defined in: lib/mongo/crypt/binary.rb

Overview

A wrapper around mongocrypt_binary_t, a non-owning buffer of uint-8 byte data. Each Binary instance keeps a copy of the data passed to it in order to keep that data alive.

Class Method Summary

Instance Method Summary

Class Method Details

.from_data(data) ⇒ Binary

Initialize a Binary object with a string. The Binary object will store a copy of the specified string and destroy the allocated memory when it goes out of scope.

Parameters:

  • data (String) —

    A string to be wrapped by the Binary object

Returns:

  • (Binary) —

    A new binary object

[ GitHub ] 

  


# File 'lib/mongo/crypt/binary.rb', line 87



def self.from_data(data)
  self.new(data: data)
end


  








  

    .from_pointer(pointer)  ⇒ Binary 
  



  

    

Initialize a Binary object from an existing pointer to a mongocrypt_binary_t object.


  





  
Parameters:


    
  
  • 
    pointer
    (FFI::Pointer)
—    
    

    A pointer to an existing mongocrypt_binary_t object
    

    
  
    • 



Returns:


    
  
  • 
    (Binary)
—    
    

    A new binary object
    

    
  
    • 





  [ GitHub ]


  

  


# File 'lib/mongo/crypt/binary.rb', line 76



def self.from_pointer(pointer)
  self.new(pointer: pointer)
end


  








  

    .wrap_string(str)  
  



  

    

Wraps a String with a mongocrypt_binary_t, yielding an FFI::Pointer to the wrapped struct.


  





  


  [ GitHub ]


  

  


# File 'lib/mongo/crypt/binary.rb', line 145



def self.wrap_string(str)
  binary_p = Binding.mongocrypt_binary_new_from_data(
    FFI::MemoryPointer.from_string(str),
    str.bytesize,
  )
  begin
    yield binary_p
  ensure
    Binding.mongocrypt_binary_destroy(binary_p)
  end
end


  







Instance Method Details



  

    #ref  ⇒ FFI::Pointer 
  



  

    

Returns the reference to the underlying mongocrypt_binary_t object


  





  
Returns:


    
  
  • 
    (FFI::Pointer)
—    
    

    The underlying mongocrypt_binary_t object
    

    
  
    • 





  [ GitHub ]


  

  


# File 'lib/mongo/crypt/binary.rb', line 139



def ref
  @bin
end


  








  

    #to_s  ⇒ String 
  



  

    

Returns the data stored as a string


  





  
Returns:


    
  
  • 
    (String)
—    
    

    Data stored in the mongocrypt_binary_t as a string
    

    
  
    • 





  [ GitHub ]


  

  


# File 'lib/mongo/crypt/binary.rb', line 129



def to_s
  str_p = Binding.mongocrypt_binary_data(ref)
  len = Binding.mongocrypt_binary_len(ref)
  str_p.read_string(len)
end


  








  

    #write(data)  ⇒ true 
  



  

    
  

    Note:
    


The data passed in must not take up more memory than the



  




Overwrite the existing data wrapped by this Binary object



original memory allocated to the underlying mongocrypt_binary_t object. Do NOT use this method unless required to do so by libmongocrypt.



than was originally allocated or when writing to an object that already owns data.


  





  
Parameters:


    
  
  • 
    data
    (String)
—    
    

    The new string data to be wrapped by this binary object
    

    
  
    • 



Returns:


    
  
  • 
    (true)
—    
    

    Always true
    

    
  
    • 



Raises:


    
  
  • 
    (ArgumentError)
—    
    

    Raises when trying to write more data
    

    
  
    • 





  [ GitHub ]


  

  


# File 'lib/mongo/crypt/binary.rb', line 104



def write(data)
  if @data
    raise ArgumentError, 'Cannot write to an owned Binary'
  end

  # Cannot write a string that's longer than the space currently allocated
  # by the mongocrypt_binary_t object
  str_p = Binding.mongocrypt_binary_data(ref)
  len = Binding.mongocrypt_binary_len(ref)

  if len < data.bytesize
    raise ArgumentError.new(
      "Cannot write #{data.bytesize} bytes of data to a Binary object " +
      "that was initialized with #{Binding.mongocrypt_binary_len(@bin)} bytes."
    )
  end

  str_p.put_bytes(0, data)

  true
end