method

getbinaryfile

v2_4_6 - Show latest stable - Class: Net::FTP

getbinaryfile(remotefile, localfile = File.basename(remotefile), blocksize = DEFAULT_BLOCKSIZE)

public

Retrieves remotefile in binary mode, storing the result in localfile. If localfile is nil, returns retrieved data. If a block is supplied, it is passed the retrieved data in blocksize chunks.

# File lib/net/ftp.rb, line 750
    def getbinaryfile(remotefile, localfile = File.basename(remotefile),
                      blocksize = DEFAULT_BLOCKSIZE, &block) # :yield: data
      f = nil
      result = nil
      if localfile
        if @resume
          rest_offset = File.size?(localfile)
          f = File.open(localfile, "a")
        else
          rest_offset = nil
          f = File.open(localfile, "w")
        end
      elsif !block_given?
        result = String.new
      end
      begin
        f&.binmode
        retrbinary("RETR #{remotefile}", blocksize, rest_offset) do |data|
          f&.write(data)
          block&.(data)
          result&.concat(data)
        end
        return result
      ensure
        f&.close
      end
    end

1Note

writes the file to disk even if you pass a block

ColinDKelley · Jun 17, 2010

I was surprised to find that the local file is opened and written even if you pass the block. If you're local working directory isn't writeable or doesn't have the space, you're out of luck.

getbinaryfile

1Note

writes the file to disk even if you pass a block

Related methods