Clase: Mongo::Crypt::Binary Privado

Hereda:
Objeto
  • Objeto
Mostrar todo
Definido en:
lib/mongo/crypt/binary.rb

Overview

Esta clase forma parte de una API privada. Evita usar esta clase si es posible, ya que puede ser eliminada o modificada en el futuro.

Un contenedor de mongocrypt_binary_t, un búfer no propietario de datos de bytes uint-8. Cada instancia de Binary conserva una copia de los datos que se le pasan para mantenerlos activos.

Resumen del método de clase colapsar

Resumen del método de instancia colapsar

Detalles del constructor

#initialize(data: nil, pointer: nil) ⇒ Binary

Este método forma parte de una API privada. Debe evitarlo si es posible, ya que podría eliminarse o modificarse en el futuro.

Nota:

Al inicializar un objeto binario con una cadena o un puntero,

Crea un nuevo objeto binario que envuelva una string de bytes

se recomienda que utilices #self.from_pointer o #self.from_data métodos

Parámetros:

  • Datos (Cadena) (predeterminado: nulo) —

    La string de datos envuelta por el búfer de bytes (opcional)

  • puntero (FFI::Puntero) (predeterminado: nulo) —

    Un puntero a un objeto mongocrypt_binary_t existente



39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
 
# Archivo 'lib/mongo/crypt/binary.rb', línea 39

def inicializar(datos: nulo, puntero: nulo)
  si Datos
    # Representar la data string como un arreglo de bytes uint-8
    bytes = Datos.desempaquetar('C*')

    # FFI::MemoryPointer libera automáticamente la memoria cuando queda fuera del alcance
    @data_p = FFI::MemoryPointer.Nuevo(bytes.longitud)
              .escribir_array_de_uint8(bytes)

    # FFI::AutoPointer utiliza una estrategia de liberación personalizada para liberar automáticamente
    # el puntero una vez que este objeto salga del alcance
    @bin = FFI::Apuntador automático.Nuevo(
      Vinculante.mongocrypt_binary_new_from_data(@data_p, bytes.longitud),
      Vinculante.Método(destroy_binary_mongocrypt)
    )
  elsif puntero
    # Si la clase Binary se usa de esta manera, significa que el puntero
    # para el objeto subyacente mongocrypt_binary_t se asigna en algún lugar
    # else. No es responsabilidad de esta clase desasignar datos.
    @bin = puntero
  else
    # FFI::AutoPointer utiliza una estrategia de liberación personalizada para liberar automáticamente
    # el puntero una vez que este objeto salga del alcance
    @bin = FFI::Apuntador automático.Nuevo(
      Vinculante.mongocrypt_binary_new,
      Vinculante.Método(destroy_binary_mongocrypt)
    )
  end
end

Detalles del método de clase

.from_data(data) ⇒ Mongo::Crypt::Binary

Este método forma parte de una API privada. Debe evitarlo si es posible, ya que podría eliminarse o modificarse en el futuro.

Inicializa un objeto binario con una cadena. El objeto binario almacenará una copia de la cadena especificada y destruirá la memoria asignada cuando salga del ámbito.

Parámetros:

  • Datos (string) —

    Una string que debe ser envuelta por el objeto Binary

Devuelve:



87
88
89
 
# Archivo 'lib/mongo/crypt/binary.rb', línea 87

def sí mismo.from_data(Datos)
  sí mismo.Nuevo(datos: Datos)
end

.from_pointer(apuntador) ⇒ Mongo::Crypt::Binary

Este método forma parte de una API privada. Debe evitarlo si es posible, ya que podría eliminarse o modificarse en el futuro.

Inicializa un objeto binario desde un puntero existente a un objeto mongocrypt_binary_t.

Parámetros:

  • puntero (FFI::Pointer) —

    Un puntero a un objeto mongocrypt_binary_t existente

Devuelve:



76
77
78
 
# Archivo 'lib/mongo/crypt/binary.rb', línea 76

def sí mismo.from_pointer(puntero)
  sí mismo.Nuevo(puntero: puntero)
end

.wrap_string(str) ⇒ Objeto

Este método forma parte de una API privada. Debe evitarlo si es posible, ya que podría eliminarse o modificarse en el futuro.

Envuelve una cadena con un mongocrypt_binary_t, lo que produce un FFI::Pointer a la estructura envuelta.



145
146
147
148
149
150
151
152
153
154
155
 
# Archivo 'lib/mongo/crypt/binary.rb', línea 145

def sí mismo.wrap_string(str)
  binario_p = Vinculante.mongocrypt_binary_new_from_data(
    FFI::MemoryPointer.from_string(str),
    str.bytesize,
  )
  begin
    rendimiento binario_p
  asegurar
    Vinculante.mongocrypt_binary_destroy(binario_p)
  end
end

Detalles del método de instancia

#ref ⇒ FFI::Pointer

Este método forma parte de una API privada. Debe evitarlo si es posible, ya que podría eliminarse o modificarse en el futuro.

Devuelve la referencia al objeto subyacente mongocrypt_binary_t

Devuelve:

  • (FFI::Pointer) —

    El objeto mongocrypt_binary_t subyacente



139
140
141
 
# Archivo 'lib/mongo/crypt/binary.rb', línea 139

def ref
  @bin
end

#to_s ⇒ String

Este método forma parte de una API privada. Debe evitarlo si es posible, ya que podría eliminarse o modificarse en el futuro.

Devuelve los datos almacenados como una string

Devuelve:

  • (string) —

    Datos almacenados en el mongocrypt_binary_t como una string



129
130
131
132
133
 
# Archivo 'lib/mongo/crypt/binary.rb', línea 129

def to_s
  str_p = Vinculante.get_binary_data_direct(ref)
  len = Vinculante.get_binary_len_direct(ref)
  str_p.read_string(len)
end

#guardar(datos) ⇒ true

Este método forma parte de una API privada. Debe evitarlo si es posible, ya que podría eliminarse o modificarse en el futuro.

Nota:

Los datos ingresados no deben ocupar más memoria que la

Sobrescribir los datos existentes cubiertos por este objeto binario

memoria original asignada al objeto subyacente mongocrypt_binary_t. NO utilizes este método a menos que así lo requiera libmongocrypt.

de lo que se asignó originalmente o al escribir en un objeto que ya posee datos.

Parámetros:

  • Datos (string) —

    El nuevo string que se va a envolver en este objeto binario

Devuelve:

  • (cierto) —

    Siempre cierto

Aumenta:

  • (ArgumentError) —

    Se genera al intentar guardar más datos



104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
 
# Archivo 'lib/mongo/crypt/binary.rb', línea 104

def guardar(Datos)
  si @data
    propagar ArgumentError, 'No se puede guardar en un binario propio'
  end

  # No se puede escribir una string más larga que el espacio actualmente asignado
  # por el objeto mongocrypt_binary_t
  str_p = Vinculante.get_binary_data_direct(ref)
  len = Vinculante.get_binary_len_direct(ref)

  si len < Datos.bytesize
    propagar ArgumentError.Nuevo(
      "No se puede guardar #{data.bytesize} bytes de datos en un objeto Binario " +
      "que se inicializó con #{Binding.get_binary_len_direct(@bin)} bytes."
    )
  end

  str_p.put_bytes(0, Datos)

  true
end