Spec-Zone.ru › Homebrew

Класс: Messages Приватный

Наследует:
Object
  • Object
  • Messages
показать все
Подключает:
Utils::Output::Mixin
Определён в:
messages.rb

Обзор

Этот класс является частью приватного API. Этот класс можно использовать только в репозитории Homebrew/brew. По возможности сторонним разработчикам следует избегать использования этого класса, поскольку он может быть удалён или изменён без предупреждения.

Объект Messages собирает сообщения, которые могут потребоваться для отображения вместе в конце выполнения команды brew в несколько этапов.

Краткое описание атрибутов экземпляра свернуть

  • #caveats ⇒ Array<Hash> только для чтения приватный
  • #install_times ⇒ Array<Hash> только для чтения приватный
  • #package_count ⇒ Integer только для чтения приватный

Краткое описание методов экземпляра свернуть

  • #display_caveats(force: false) ⇒ void приватный
  • #display_install_times ⇒ void приватный
  • #display_messages(force_caveats: false, display_times: false) ⇒ void приватный
  • #initialize ⇒ void конструктор приватный
  • #package_installed(package, elapsed_time) ⇒ void приватный
  • #record_caveats(package, caveats) ⇒ void приватный
  • #record_completions_and_elisp(completions_and_elisp) ⇒ void приватный

Методы, подключённые из Utils::Output::Mixin

#issue_reporting_message, #odebug, #odeprecated, #odie, #odisabled, #ofail, #oh1, #oh1_title, #ohai, #ohai_title, #onoe, #opoo, #opoo_outside_github_actions, #opoo_without_github_actions_annotation, #pretty_deprecated, #pretty_disabled, #pretty_duration, #pretty_install_status, #pretty_installed, #pretty_uninstalled, #pretty_upgradable, #pretty_warning

Подробное описание конструкторов

#initialize ⇒ void

Этот метод является частью закрытого API. Этот метод можно использовать только в репозитории Homebrew/brew. Сторонним разработчикам по возможности не следует использовать этот метод, поскольку он может быть удалён или изменён без предупреждения. 



21
22
23
24
25
26
 
# File 'messages.rb', line 21

def initialize
  @caveats = T.let([], T::Array[{ package: String, caveats: T.any(String, Caveats) }])
  @completions_and_elisp = T.let(Set.new, T::Set[String])
  @package_count = T.let(0, Integer)
  @install_times = T.let([], T::Array[{ package: String, time: Float }])
end

Подробное описание атрибутов экземпляра

#caveats ⇒ Array<Hash> (только для чтения)

Этот метод является частью закрытого API. Этот метод можно использовать только в репозитории Homebrew/brew. Сторонним разработчикам по возможности не следует использовать этот метод, поскольку он может быть удалён или изменён без предупреждения.

Возвращает:

  • (Array<Hash>) 


12
13
14
 
# File 'messages.rb', line 12

def caveats
  @caveats
end

#install_times ⇒ Array<Hash> (только для чтения)

Этот метод является частью закрытого API. Этот метод можно использовать только в репозитории Homebrew/brew. Сторонним разработчикам по возможности не следует использовать этот метод, поскольку он может быть удалён или изменён без предупреждения.

Возвращает:

  • (Array<Hash>) 


18
19
20
 
# File 'messages.rb', line 18

def install_times
  @install_times
end

#package_count ⇒ Integer (только для чтения)

Этот метод является частью закрытого API. Этот метод можно использовать только в репозитории Homebrew/brew. Сторонним разработчикам по возможности не следует использовать этот метод, поскольку он может быть удалён или изменён без предупреждения.

Возвращает:

  • (Integer) 


15
16
17
 
# File 'messages.rb', line 15

def package_count
  @package_count
end

Подробное описание методов экземпляра

#display_caveats(force: false) ⇒ void

Этот метод является частью закрытого API. Этот метод можно использовать только в репозитории Homebrew/brew. Сторонним разработчикам по возможности не следует использовать этот метод, поскольку он может быть удалён или изменён без предупреждения.

Этот метод возвращает неопределённое значение.

Параметры:

  • force (Boolean) (по умолчанию: false) 


51
52
53
54
55
56
57
58
59
60
61
 
# File 'messages.rb', line 51

def display_caveats(force: false)
  return if @package_count.zero?
  return if @caveats.empty? && @completions_and_elisp.empty?

  oh1 "Caveats" unless @completions_and_elisp.empty?
  @completions_and_elisp.each { |c| puts c }
  return if @package_count == 1 && !force

  oh1 "Caveats" if @completions_and_elisp.empty?
  @caveats.each { |c| ohai c.fetch(:package), c.fetch(:caveats) }
end

#display_install_times ⇒ void

Этот метод является частью закрытого API. Этот метод можно использовать только в репозитории Homebrew/brew. Сторонним разработчикам по возможности не следует использовать этот метод, поскольку он может быть удалён или изменён без предупреждения.

Этот метод возвращает неопределённое значение.



64
65
66
67
68
69
70
71
 
# File 'messages.rb', line 64

def display_install_times
  return if install_times.empty?

  oh1 "Installation times"
  install_times.each do |t|
    puts format("%<package>-20s %<time>10.3f s", t)
  end
end

#display_messages(force_caveats: false, display_times: false) ⇒ void

Этот метод является частью закрытого API. Этот метод можно использовать только в репозитории Homebrew/brew. Сторонним разработчикам по возможности не следует использовать этот метод, поскольку он может быть удалён или изменён без предупреждения.

Этот метод возвращает неопределённое значение.

Параметры:

  • force_caveats (Boolean) (по умолчанию: false)
  • display_times (Boolean) (по умолчанию: false) 


45
46
47
48
 
# File 'messages.rb', line 45

def display_messages(force_caveats: false, display_times: false)
  display_caveats(force: force_caveats)
  display_install_times if display_times
end

#package_installed(package, elapsed_time) ⇒ void

Этот метод является частью закрытого API. Этот метод можно использовать только в репозитории Homebrew/brew. Сторонним разработчикам по возможности не следует использовать этот метод, поскольку он может быть удалён или изменён без предупреждения.

Этот метод возвращает неопределённое значение.

Параметры:

  • package (String)
  • elapsed_time (Float) 


39
40
41
42
 
# File 'messages.rb', line 39

def package_installed(package, elapsed_time)
  @package_count += 1
  @install_times.push(package:, time: elapsed_time)
end

#record_caveats(package, caveats) ⇒ void

Этот метод является частью закрытого API. Этот метод можно использовать только в репозитории Homebrew/brew. Сторонним разработчикам по возможности не следует использовать этот метод, поскольку он может быть удалён или изменён без предупреждения.

Этот метод возвращает неопределённое значение.

Параметры:

  • package (String)
  • caveats (String, Caveats) 


29
30
31
 
# File 'messages.rb', line 29

def record_caveats(package, caveats)
  @caveats.push(package:, caveats:)
end

#record_completions_and_elisp(completions_and_elisp) ⇒ void

Этот метод является частью закрытого API. Этот метод можно использовать только в репозитории Homebrew/brew. Сторонним разработчикам по возможности не следует использовать этот метод, поскольку он может быть удалён или изменён без предупреждения.

Этот метод возвращает неопределённое значение.

Параметры:

  • completions_and_elisp (Array<String>) 


34
35
36
 
# File 'messages.rb', line 34

def record_completions_and_elisp(completions_and_elisp)
  @completions_and_elisp.merge(completions_and_elisp)
end

© 2009–present Homebrew contributors
Licensed under the BSD 2-Clause License.
https://docs.brew.sh/rubydoc/Messages.html

Spec-Zone.ru

Настройки Оффлайн Что нового Помощь О нас
Spec-Zone .ru
спецификации, руководства, описания, API