class Net::SFTP::Operations::FileFactory

  1. lib/net/sftp/operations/file_factory.rb
Parent: Operations

A factory class for opening files and returning Operations::File instances that wrap the SFTP handles that represent them. This is a convenience class for use when working with files synchronously. Rather than relying on the programmer to provide callbacks that define a state machine that describes the behavior of the program, this class (and Operations::File) provide an interface where calls will block until they return, mimicking the IO class' interface.

Methods

Public Class

  1. new

Public Instance

  1. directory?
  2. open
  3. sftp

Attributes

sftp [R]

The SFTP session object that drives this file factory.

Public Class methods

new (sftp)

Create a new instance on top of the given SFTP session instance.

[show source] 
# File lib/net/sftp/operations/file_factory.rb, line 18
def initialize(sftp)
  @sftp = sftp
end

Public Instance methods

directory? (path)

Returns true if the argument refers to a directory on the remote host.

[show source] 
# File lib/net/sftp/operations/file_factory.rb, line 55
def directory?(path)
  sftp.lstat!(path).directory?
end
open(name, flags="r", mode=nil) -> file
open(name, flags="r", mode=nil) { |file| ... }

Attempt to open a file on the remote server. The flags parameter accepts the same values as the standard Ruby ::File#open method. The mode parameter must be an integer describing the permissions to use if a new file is being created.

If a block is given, the new Operations::File instance will be yielded to it, and closed automatically when the block terminates. Otherwise the object will be returned, and it is the caller's responsibility to close the file.

sftp.file.open("/tmp/names.txt", "w") do |f|
  # ...
end
[show source] 
# File lib/net/sftp/operations/file_factory.rb, line 39
def open(name, flags="r", mode=nil, &block)
  handle = sftp.open!(name, flags, :permissions => mode)
  file = Operations::File.new(sftp, handle)

  if block_given?
    begin
      yield file
    ensure
      file.close
    end
  else
    return file
  end
end