class SF::FileInputStream

• SF::FileInputStream
• SF::InputStream
• Reference
• Object

Overview

Implementation of input stream based on a file

This class is a specialization of InputStream that reads from a file on disk.

It wraps a file in the common InputStream interface and therefore allows to use generic classes or functions that accept such a stream, with a file on disk as the data source.

In addition to the virtual functions inherited from InputStream, FileInputStream adds a function to specify the file to open.

SFML resource classes can usually be loaded directly from a filename, so this class shouldn't be useful to you unless you create your own algorithms that operate on an InputStream

Usage example:

def process(stream : InputStream)
end

stream = SF::FileInputStream.open("some_file.dat")
process(stream)

See also: InputStream, MemoryInputStream

Included Modules

• SF::NonCopyable

Defined in:

Constructors

• .new

  Default constructor

• .open(*args, **kwargs) : self

  Shorthand for file_input_stream = FileInputStream.new; file_input_stream.open(...); file_input_stream

Instance Method Summary

• #finalize

  Default destructor

• #open(filename : String) : Bool

  Open the stream from a file path

• #read(data : Slice) : Int64

  Read data from the stream

• #seek(position : Int) : Int64

  Change the current reading position

• #size : Int64

  Return the size of the stream

• #tell : Int64

  Get the current reading position in the stream

Constructor Detail

Instance Method Detail