rfusefs¶ ↑

DESCRIPTION¶ ↑

RFuseFS is a port of the FuseFS library aimed at allowing Ruby programmers to quickly and easily create virtual filesystems with little more than a few lines of code.

RFuseFS is api compatible with FuseFS (0.7.0)

SYNOPSIS¶ ↑

FuseFS provides a layer of abstraction to a programmer who wants to create a virtual filesystem via FUSE.

First define a virtual directory by subclassing {FuseFS::FuseDir}

See samples under /samples and also the following starter classes

{FuseFS::FuseDir}
{FuseFS::MetaDir}
{FuseFS::DirLink}
{FuseFS::PathMapperFS}
{FuseFS::SqliteMapperFS}

Then start your filesystem with

{FuseFS.main} or {FuseFS.start}

Finally to use the filesystem open up your favourite file browser/terminal and explore the contents under <mountpoint>

Happy Filesystem Hacking!

the hello world filesystem in 14 LOC¶ ↑

require 'rfusefs'

class HelloDir

  def contents(path)
    ['hello.txt']
  end

  def file?(path)
    path == '/hello.txt'
  end

  def read_file(path)
    "Hello, World!\n"
  end

end

# Usage: #{$0} mountpoint [mount_options]
FuseFS.main() { |options| HelloDir.new }

REQUIREMENTS:¶ ↑

FUSE (fuse.sourceforge.net)
Ruby (>=1.9)
rfuse (~> 1.1)

INSTALL:¶ ↑

gem install rfusefs

DEVELOPERS:¶ ↑

After checking out the source, run:

$ bundle install # install dependencies
$ rake spec # run tests
$ rake yard # generate docs

LICENSE:¶ ↑

(The MIT License)

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the ‘Software’), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED ‘AS IS’, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

heinzbeinz/rfusefs