Spec-Zone.ru › Homebrew

Класс: File

Наследует:
Object
  • Object
  • File
показать все
Определён в:
extend/file/atomic.rb

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

  • .atomic_write(file_name, temp_dir = dirname(file_name), &_block) ⇒ T.type_parameter(:Out) приватный

    Атомарно записывает данные в файл.

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

.atomic_write(file_name, temp_dir = dirname(file_name), &_block) ⇒ T.type_parameter(:Out)

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

Атомарно записывает данные в файл. Полезно в ситуациях, когда вы не хотите, чтобы другие процессы или потоки видели частично записанные файлы.

File.atomic_write('important.file') do |file|
file.write('hello')
end

Для работы этого метода необходимо создать временный файл. По умолчанию он создаётся в том же каталоге, что и целевой файл. Если такое поведение вам не подходит, можно указать другой каталог, но он должен находиться в той же физической файловой системе, что и файл, в который выполняется запись.

File.atomic_write('/data/something.important', '/data/tmp') do |file|
file.write('hello')
end

Параметры:

  • file_name (Pathname, String)
  • temp_dir (String) (по умолчанию: dirname(file_name))
  • _block (T.proc.params(arg0: Tempfile).returns(T.type_parameter(:Out)))

Возвращает:

  • (T.type_parameter(:Out))


29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
# File 'extend/file/atomic.rb', line 29

def self.atomic_write(file_name, temp_dir = dirname(file_name), &_block)
  require "tempfile" unless defined?(Tempfile)

  Tempfile.open(".#{basename(file_name)}", temp_dir) do |temp_file|
    temp_file.binmode
    return_val = yield temp_file
    temp_file.close

    old_stat = if exist?(file_name)
      # Get original file permissions
      stat(file_name)
    else
      # If not possible, probe which are the default permissions in the
      # destination directory.
      probe_stat_in(dirname(file_name))
    end

    if old_stat
      # Set correct permissions on new file
      begin
        chown(old_stat.uid, old_stat.gid, T.must(temp_file.path))
        # This operation will affect filesystem ACL's
        chmod(old_stat.mode, T.must(temp_file.path))
      rescue Errno::EPERM, Errno::EACCES
        # Changing file ownership failed, moving on.
      end
    end

    # Overwrite original file with temp file
    rename(T.must(temp_file.path), file_name)
    return_val
  end
end

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

Spec-Zone.ru

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