pathological.file-stores

Liking cljdoc? Tell your friends :D

Clojure only.

*file-store-attribute-view-factories*
->file-store
->file-store-attribute-view-factory
FileAttributeViewSupport
FileStoreAttributeViewSupport
ReloadFileStoreAttributes

file-store-attribute-view-factories^clj

A mapping of available file store attribute view types to factory functions for materialised records.

By default, there are no factories defined since Java NIO2 does not include any file store attribute views. However, since the file store attribute view framework is extensible and implementation dependent in Java NIO2, this var is dynamic and can be altered / rebound to support additional file store attribute views.

A mapping of available file store attribute view types to factory functions
for materialised records.

By default, there are no factories defined since Java NIO2 does not include
any file store attribute views. However, since the file store attribute view
framework is extensible and implementation dependent in Java NIO2, this var is
dynamic and can be altered / rebound to support additional file store
attribute views.

raw docstring

->file-store^clj

(->file-store file-store)

Converts the FileStore instance to a materialised record.

The returned record includes:

:name: the name of the file store,
:type: the type of the file store,
:read-only?: whether the file store is read only, as a boolean,
:total-space: the total space in the file store, in bytes,
:usable-space: the usable space for this JVM in the file store, in bytes,
:unallocated-space: the unallocated space in the file store, in bytes,
:block-size: the block size of the file store, when available, in bytes; nil when not available,
:delegate: the underlying instance.

The returned record implements ReloadFileStoreAttributes, FileAttributeViewSupport and FileStoreAttributeViewSupport.

Converts the [FileStore](https://docs.oracle.com/javase/7/docs/api/java/nio/file/FileStore.html)
instance to a materialised record.

The returned record includes:

  - `:name`: the name of the file store,
  - `:type`: the type of the file store,
  - `:read-only?`: whether the file store is read only, as a boolean,
  - `:total-space`: the total space in the file store, in bytes,
  - `:usable-space`: the usable space for this JVM in the file store, in
    bytes,
  - `:unallocated-space`: the unallocated space in the file store, in bytes,
  - `:block-size`: the block size of the file store, when available, in bytes;
    `nil` when not available,
  - `:delegate`: the underlying instance.

The returned record implements [[ReloadFileStoreAttributes]],
[[FileAttributeViewSupport]] and [[FileStoreAttributeViewSupport]].

raw docstring

->file-store-attribute-view-factory^clj

(->file-store-attribute-view-factory type)

Returns a file store attribute view factory for building materialised records for the supplied file store attribute view type when available. If no factory is available, an identity factory is returned which leaves the provided view unchanged.

See *file-store-attribute-view-factories* for details on supported types.

Returns a file store attribute view factory for building materialised records
for the supplied file store attribute view type when available. If no factory
is available, an identity factory is returned which leaves the provided view
unchanged.

See [[*file-store-attribute-view-factories*]] for details on supported types.

raw docstring

FileAttributeViewSupport^cljprotocol

A protocol allowing the file attribute view support of a file store to be determined.

A protocol allowing the file attribute view support of a file store to be
determined.

supports-file-attribute-view^clj

(supports-file-attribute-view file-store class-or-type)

Returns true if the file store supports the file attribute view identified by the class or type; returns false otherwise.

The class or type argument should be:

a Class instance corresponding to a class implementing FileAttributeView,
a string or keyword representing the view name of the file attribute view, defined by the underlying file system implementation.

Returns true if the file store supports the file attribute view
identified by the class or type; returns false otherwise.

The class or type argument should be:

  - a [Class](https://docs.oracle.com/javase/7/docs/api/java/lang/Class.html)
    instance corresponding to a class implementing
    [FileAttributeView](https://docs.oracle.com/javase/7/docs/api/java/nio/file/attribute/FileAttributeView.html),
  - a string or keyword representing the view name of the file attribute
    view, defined by the underlying file system implementation.

raw docstring

FileStoreAttributeViewSupport^cljprotocol

A protocol allowing the file store attribute view support of a file store to be determined, allowing attributes to be read in the case that file store attribute views are supported.

By default, Java NIO2 does not include any file store attribute views. However, the file store attribute view framework is extensible and implementation dependent so this protocol is provided in the case that a file system is in use that does provide file store attribute views.

A protocol allowing the file store attribute view support of a file store
to be determined, allowing attributes to be read in the case that file store
attribute views are supported.

By default, Java NIO2 does not include any file store attribute views.
However, the file store attribute view framework is extensible and
implementation dependent so this protocol is provided in the case that a file
system is in use that does provide file store attribute views.

read-attribute^clj

(read-attribute file-store attribute-spec)

Reads the attribute defined by the given attribute spec from the file store.

The attribute spec should be as defined in pathological.attribute-specs/->attribute-spec.

Reads the attribute defined by the given attribute spec from the file
store.

The attribute spec should be as defined in
[[pathological.attribute-specs/->attribute-spec]].

read-file-store-attribute-view^clj

(read-file-store-attribute-view file-store class-or-type)

Reads a file store attribute view of the given class or type from the file store.

The class or type argument should be:

a Class instance corresponding to a class implementing FileStoreAttributeView,
a string or keyword representing the view name of the file store attribute view, defined by the underlying file system implementation.

Reads a file store attribute view of the given class or type from the
file store.

The class or type argument should be:

  - a [Class](https://docs.oracle.com/javase/7/docs/api/java/lang/Class.html)
    instance corresponding to a class implementing
    [FileStoreAttributeView](https://docs.oracle.com/javase/7/docs/api/java/nio/file/attribute/FileStoreAttributeView.html),
  - a string or keyword representing the view name of the file store
    attribute view, defined by the underlying file system implementation.

raw docstring

ReloadFileStoreAttributes^cljprotocol

A protocol allowing file store attribute views to be reloaded from the backing file system.

A protocol allowing file store attribute views to be reloaded from the
backing file system.

reload^clj

(reload view)

Reloads all attributes of the view.

Reloads all attributes of the view.

raw docstring

cljdoc is a website building & hosting documentation for Clojure/Script libraries

Keyboard shortcuts Report a problem cljdoc on GitHub

× close