Reading Files Character-by-Character with InputStream

Introduction to InputStream

Welcome to this lesson on reading files character by character. Building upon our foundational knowledge of handling text files, this lesson will guide you through utilizing input streams to read files character by character. These methods are crucial for handling varying file sizes efficiently and managing memory use effectively. By the end of this lesson, you'll be able to read entire files, specific portions, and process files in manageable chunks, granting you flexible control over text data processing.

Example File

Before we jump into reading files, let's review the example file that we will work with: text Hi! This file contains some sample example text to use to test how the read method works. Let's do some programming! This file contains multiple lines of varied lengths.

Understanding InputStreams

The InputStream is designed for reading data from a source in the form of bytes, and it can be used for reading files as a stream of characters. It provides methods to open a file and read its contents character by character, which is helpful for detailed text processing. To read a file's entire content character by character, we open the file using an input stream and utilize the read() method, which reads the next byte in the stream and returns its integer representation. Here is how to read a file completely character by character using a loop: Scalaimport os._ @main def main() = // Specify the file path val filePath = os.pwd / "example.txt" println("Reading file character-by-character:") // Open the file and get an input stream val inputStream = os.read.inputStream(filePath) // Read the first byte from the input stream var byte = inputStream.read() // Continue reading until the end of the file is reached while (byte != -1) { // Convert the byte to a character and print it print(byte.toChar) // Read the next byte byte = inputStream.read() } // Close the input stream after processing inputStream.close() The read() method reads a byte from the file and returns its integer representation, which is then cast back to a character using toChar. The loop continues until all characters have been read. It is crucial to close the input stream after the operations to release system resources and prevent potential file locks. The expected output is: textHi! This file contains some sample example text to use to test how the read method works. Let's do some programming! This approach suits situations where processing files one character at a time is necessary or preferred. It provides a straightforward way to read entire files while maintaining resource efficiency, making input streams a versatile option for file manipulation.

Join the 1M+ learners on CodeSignal

Be a part of our community of 1M+ users who develop and demonstrate their skills on CodeSignal

Reading Defined Portions of a File

In many situations, you may only need to read a specific number of characters rather than the entire file. This can be accomplished by utilizing read() inside a loop that iterates a set number of times based on the count of characters you'd like to read.

Scala

import os._

@main def main() =
  // Specify the file path
  val filePath = os.pwd / "example.txt"

  println("Reading first 10 characters:")

  // Open the file and get an input stream
  val inputStream = os.read.inputStream(filePath)

  // Number of characters to read
  var charactersToRead = 10

  // Read the first byte from the input stream
  var byte = inputStream.read()

  // Continue reading until the specified number is reached or end-of-file
  while (byte != -1 && charactersToRead > 0) {
    // Convert the byte to a character and print it
    print(byte.toChar)
    // Read the next byte
    byte = inputStream.read()
    // Decrement the charactersToRead count
    charactersToRead -= 1
  }

  // Close the input stream after processing
  inputStream.close()

import os._

@main def main() =
  // Specify the file path
  val filePath = os.pwd / "example.txt"

  println("Reading first 10 characters:")

  // Open the file and get an input stream
  val inputStream = os.read.inputStream(filePath)

  // Number of characters to read
  var charactersToRead = 10

  // Read the first byte from the input stream
  var byte = inputStream.read()

  // Continue reading until the specified number is reached or end-of-file
  while (byte != -1 && charactersToRead > 0) {
    // Convert the byte to a character and print it
    print(byte.toChar)
    // Read the next byte
    byte = inputStream.read()
    // Decrement the charactersToRead count
    charactersToRead -= 1
  }

  // Close the input stream after processing
  inputStream.close()

The loop continues until the specified number of characters (in this case, 10) is read or until the end of the file is reached, whichever comes first.

The expected output is:

text

Hi!
This

Hi!
This

This method is especially useful for preliminary processing or debugging large files.

Sequential File Reading

Sequential reading in file handling refers to the process of reading a file's contents in a predefined, orderly manner — part by part — without restarting from the beginning each time. For instance, by using loops in combination with the read() method, each subsequent read operation continues from where the last one concluded.

This approach is particularly beneficial when dealing with large files or when you require distinct segments from a file. Unlike loading the entire file into memory at once, which can be inefficient and resource-intensive for large files, sequential reading processes data in smaller, manageable segments, thus conserving memory and allowing the application to maintain performance and responsiveness.

Here's an example:

Scala

import os._

@main def main() =
  // Specify the file path
  val filePath = os.pwd / "example.txt"

  // Open the file and get an input stream
  val inputStream = os.read.inputStream(filePath)

  println("First 10 characters:")

  // First segment: read the initial 10 characters
  var firstReadLength = 10
  var byte = inputStream.read()
  while (byte != -1 && firstReadLength > 0) {
    print(byte.toChar)
    byte = inputStream.read()
    firstReadLength -= 1
  }

  println("\n\nNext 10 characters:")

  // Second segment: read the next 10 characters
  var nextReadLength = 10
  byte = inputStream.read()
  while (byte != -1 && nextReadLength > 0) {
    print(byte.toChar)
    byte = inputStream.read()
    nextReadLength -= 1
  }

  // Close the input stream after processing
  inputStream.close()

import os._

@main def main() =
  // Specify the file path
  val filePath = os.pwd / "example.txt"

  // Open the file and get an input stream
  val inputStream = os.read.inputStream(filePath)

  println("First 10 characters:")

  // First segment: read the initial 10 characters
  var firstReadLength = 10
  var byte = inputStream.read()
  while (byte != -1 && firstReadLength > 0) {
    print(byte.toChar)
    byte = inputStream.read()
    firstReadLength -= 1
  }

  println("\n\nNext 10 characters:")

  // Second segment: read the next 10 characters
  var nextReadLength = 10
  byte = inputStream.read()
  while (byte != -1 && nextReadLength > 0) {
    print(byte.toChar)
    byte = inputStream.read()
    nextReadLength -= 1
  }

  // Close the input stream after processing
  inputStream.close()

This program reads and prints the first 10 characters from the file, then moves forward to read the next set of 10 characters. The input stream maintains its position within the file, allowing seamless sequential access to subsequent portions.

Expected output would be: