FileInputStream.class.php

<?php namespace io\streams;

use io\File;
use lang\Value;
use util\Comparison;

/**
 * InputStream that reads from a file
 *
 * @test  io.unittest.FileInputStreamTest
 */
class FileInputStream implements InputStream, Seekable, Value {
  use Comparison;

  protected $file;
  
  /**
   * Constructor
   *
   * @param   io.File|string $file Either a file instance or a file name
   */
  public function __construct($file) {
    $this->file= $file instanceof File ? $file : new File($file);
    $this->file->isOpen() || $this->file->open(File::READ);
  }

  /**
   * Read a string
   *
   * @param   int limit default 8192
   * @return  string
   */
  public function read($limit= 8192) {
    return (string)$this->file->read($limit);
  }

  /**
   * Returns the number of bytes that can be read from this stream 
   * without blocking.
   *
   * @return  int
   */
  public function available() {
    return $this->file->size() - $this->file->tell();
  }

  /**
   * Close this buffer
   *
   */
  public function close() {
    $this->file->isOpen() && $this->file->close();
  }

  /**
   * Creates a string representation of this file
   *
   * @return  string
   */
  public function toString() {
    return nameof($this).'<'.$this->file->toString().'>';
  }

  /**
   * Seek to a given offset
   *
   * @param   int offset
   * @param   int whence default SEEK_SET (one of SEEK_[SET|CUR|END])
   * @throws  io.IOException in case of error
   */
  public function seek($offset, $whence= SEEK_SET) {
    $this->file->seek($offset, $whence);
  }

  /** @return int */
  public function tell() { return $this->file->tell(); }

  /** @return int */
  public function size() { return $this->file->size(); }
}