class

SSH2::SFTP::File

Inherits SSH2::SFTP::Node / SSH2::SFTP::Base / IO / Reference / Object

Instance methods

fsync

This function causes the remote server to synchronize the file data and metadata to disk (like fsync(2)).

Source
read(slice : Slice(UInt8)) : Int32

Reads at most slice.size bytes from this IO into slice. Returns the number of bytes read, which is 0 if and only if there is no more data to read (so checking for 0 is the way to detect end of file).

io = IO::Memory.new "hello"
slice = Bytes.new(4)
io.read(slice) # => 4
slice          # => Bytes[104, 101, 108, 108]
io.read(slice) # => 1
slice          # => Bytes[111, 101, 108, 108]
io.read(slice) # => 0
Source
rewind

Reset the read/write position to the start of the file.

Source
seek(offset)

Move the read/write position to offset bytes from the start of the file.

Source
tell

Return the current read/write position, in bytes from the start.

Source
write(slice : Bytes) : Nil

Writes the contents of slice into this IO.

io = IO::Memory.new
slice = Bytes.new(4) { |i| ('a'.ord + i).to_u8 }
io.write(slice)
io.to_s # => "abcd"
Source