Módulo: Mongo::Deprecations Private

Estendido por:
Depreciações, registráveis
Incluído em:
Itens obsoletos
Definido em:
lib/mongo/deprecations.rb

Visão geral

Este módulo faz parte de uma API privada. Você deve evitar usar este módulo, se possível, pois ele pode ser removido ou alterado no futuro.

Usado para relatar comportamentos obsoletos no driver. Quando é possível detectar que um recurso obsoleto está sendo usado, um aviso deve ser emitido por meio desse módulo.

O aviso será emitido no máximo uma vez para esse recurso, independentemente de quantas vezes Mongo::Deprecations.wards for chamado.

Exemplos:

Emitir um aviso de depreciação.

Mongo::Deprecations.warn(:old_feature, "The old_feature is deprecated, use new_feature instead.")

Colapsode resumo constante

MUTEX =

Essa constante faz parte de uma API privada. Você deve evitar usar essa constante, se possível, pois ela pode ser removida ou alterada no futuro.

Mutex para sincronizar o acesso a recursos de aviso.

Thread::Mutex.Novo

Constantes incluídas do Loggable

Loggable::Prefix

Recolhimento do Resumo do método de instância

Métodos incluídos no Loggable

log_debug, log_error, log_fatal, log_info, log_warn, logger

Detalhes do método de instância

#claro! ➤ Objeto

Este método faz parte de uma API privada. Evite usar esse método, se possível, pois ele pode ser removido ou alterado no futuro.

Limpa toda a memória de recursos avisados anteriormente.



58
59
60
61
 
# Arquivo 'lib/mongo/deprecations.rb', linha 58

def claro!
  MUTEX.sincronizar { alert_features redefinir: true }
  nada
end

#alert(característica, mensagem) ➤ Objeto

Este método faz parte de uma API privada. Evite usar esse método, se possível, pois ele pode ser removido ou alterado no futuro.

Emitir um aviso sobre um recurso obsoleto. O aviso é gravado no registrador e não será gravado mais de uma vez por recurso.

Parâmetros:

  • funcionalidade (String | Símbolo) —

    O recurso obsoleto.

  • mensagem (string) —

    A mensagem de descontinuação.



30
31
32
33
34
35
36
37
 
# Arquivo 'lib/mongo/deprecations.rb', linha 30

def AVISAR(funcionalidade, mensagem)
  MUTEX.sincronizar fazer
    Método se _aviso?(funcionalidade)

    _aviso!(funcionalidade)
    log_service("[DEscendente:#{feature}] #{message}")
  end
end

#aviso! (recurso)➤ Objeto

Este método faz parte de uma API privada. Evite usar esse método, se possível, pois ele pode ser removido ou alterado no futuro.

Marque que um aviso para uma determinada funcionalidade obsoleta foi emitido.

Parâmetros:

  • funcionalidade (String | Símbolo) —

    O recurso obsoleto.



52
53
54
55
 
# Arquivo 'lib/mongo/deprecations.rb', linha 52

def avisado!(funcionalidade)
  MUTEX.sincronizar { _aviso!(funcionalidade) }
  nada
end

#avisado?(recurso, prefixo: falso) ➤ verdadeiro | false

Este método faz parte de uma API privada. Evite usar esse método, se possível, pois ele pode ser removido ou alterado no futuro.

Verifique se um aviso para uma determinada funcionalidade obsoleta já foi emitido.

Parâmetros:

  • funcionalidade (String | Símbolo) —

    O recurso obsoleto.

  • prefix (verdadeiro | falso) (padrão para: false) —

    Se deve verificar se há correspondências de prefixo.

Retorna:

  • (verdadeiro | falso) —

    Se um aviso já tiver sido emitido.



45
46
47
 
# Arquivo 'lib/mongo/deprecations.rb', linha 45

def avisado?(funcionalidade, prefix: false)
  MUTEX.sincronizar { _aviso?(funcionalidade, prefix: prefix) }
end