Spec-Zone.ru › Hammerspoon

hs.fs.volume

Взаимодействие с томами файловой системы OS X

Это отличается от hs.fs, так как hs.fs работает с операциями файловой системы UNIX, а hs.fs.volume взаимодействует с концепцией томов OS X более высокого уровня

Обзор API

  • Константы — полезные значения, которые нельзя изменить
    • didMount
    • didRename
    • didUnmount
    • willUnmount
  • Функции — API-вызовы, предоставляемые непосредственно расширением
    • allVolumes
    • eject
  • Конструкторы — API-вызовы, которые возвращают объект, обычно тот, который предлагает API-методы
    • new
  • Методы — API-вызовы, которые могут быть выполнены только с объектом, возвращенным конструктором
    • start
    • stop

Документация API

Константы

didMount
Подпись hs.fs.volume.didMount
Тип Константа
Описание

Том был смонтирован

Источник extensions/fs/libfs_volume.m строка 12
didRename
Подпись hs.fs.volume.didRename
Тип Константа
Описание

Том изменил своё имя или точку монтирования (или, скорее всего, оба)

Источник extensions/fs/libfs_volume.m строка 24
didUnmount
Подпись hs.fs.volume.didUnmount
Тип Константа
Описание

Том был размонтирован

Источник extensions/fs/libfs_volume.m строка 16
willUnmount
Подпись hs.fs.volume.willUnmount
Тип Константа
Описание

Том скоро будет размонтирован

Источник extensions/fs/libfs_volume.m строка 20

Функции

allVolumes
Подпись hs.fs.volume.allVolumes([showHidden]) -> table
Тип Функция
Описание

Возвращает таблицу информации о дисках, подключенных к системе

Параметры
  • showHidden — необязательный булевый параметр, true для отображения скрытых томов, false — для их не отображения. По умолчанию false.
Возвращаемое значение
  • Таблица информации, где ключами являются пути дисков
Примечания
  • Это псевдоним для hs.host.volumeInformation()
  • Возможные ключи в таблице:
  • NSURLVolumeTotalCapacityKey — размер тома в байтах
  • NSURLVolumeAvailableCapacityKey — доступное пространство на томе в байтах
  • NSURLVolumeIsAutomountedKey — булево значение, указывающее, был ли том автоматически смонтирован
  • NSURLVolumeIsBrowsableKey — булево значение, указывающее, можно ли просматривать том
  • NSURLVolumeIsEjectableKey — булево значение, указывающее, нужно ли извлечь том перед извлечением носителя
  • NSURLVolumeIsInternalKey — булево значение, указывающее, является ли том внутренним или внешним накопителем
  • NSURLVolumeIsLocalKey — булево значение, указывающее, является ли том локальным или удалённым
  • NSURLVolumeIsReadOnlyKey — булево значение, указывающее, является ли том только для чтения
  • NSURLVolumeIsRemovableKey — булево значение, указывающее, можно ли физически извлечь носитель тома с диска (например, DVD)
  • NSURLVolumeMaximumFileSizeKey — максимальный размер файла, который может поддерживать том, в байтах
  • NSURLVolumeUUIDStringKey — UUID файловой системы тома
  • NSURLVolumeURLForRemountingKey — для удаленных томов сетевой URL тома
  • NSURLVolumeLocalizedNameKey — локальный вариант имени тома
  • NSURLVolumeNameKey — имя тома
  • NSURLVolumeLocalizedFormatDescriptionKey — локальное описание тома
  • Не все ключи будут присутствовать для всех томов
  • Значения NSURLVolumeIsEjectableKey и NSURLVolumeIsRemovableKey не всегда полезны для определения того, является ли диск съемным в современном понимании (например, USB-накопитель), так как большая часть этой терминологии относится к временам, когда USB не существовал, и съемными дисками были такие как Floppy/DVD-диски. Если вы пытаетесь определить, не является ли диск неподвижным в компьютере, вам может потребоваться использовать комбинацию этих ключей, но точная комбинация, которую следует использовать, не является постоянной в разных версиях macOS.
Источник extensions/fs/fs.lua строка 35
eject
Подпись hs.fs.volume.eject(path) -> boolean,string
Тип Функция
Описание

Размонтирует и извлекает том

Параметры
  • path — абсолютный путь к тому, который вы хотите извлечь
Возвращаемое значение
  • Булево значение, true, если том был извлечен, в противном случае false
  • Строка, пустая, если том был извлечен, в противном случае она будет содержать сообщение об ошибке
Источник extensions/fs/libfs_volume.m строка 120

Конструкторы

new
Подпись hs.fs.volume.new(fn) -> watcher
Тип Конструктор
Описание

Создает объект наблюдателя событий томов

Параметры
  • fn — функция, которая будет вызываться при возникновении событий тома. Она должна принимать два параметра:
    • Тип события (см. выше определенные константы)
    • Таблица, которая будет содержать соответствующую информацию
Возвращаемое значение
  • Объект hs.fs.volume
Источник extensions/fs/libfs_volume.m строка 148

Методы

start
Подпись hs.fs.volume:start()
Тип Метод
Описание

Запускает наблюдателя за событиями томов

Параметры
  • Нет
Возвращаемое значение
  • Объект hs.fs.volume
Источник extensions/fs/libfs_volume.m строка 208
stop
Подпись hs.fs.volume:stop()
Тип Метод
Описание

Останавливает наблюдателя за событиями томов

Параметры
  • Нет
Возвращаемое значение
  • Объект hs.fs.volume
Источник extensions/fs/libfs_volume.m строка 232

© 2014–2017 Hammerspoon contributors
Licensed under the MIT License.
https://www.hammerspoon.org/docs/hs.fs.volume.html

Spec-Zone.ru

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