/*
Copyright 2006,2008 Stefano Chizzolini. http://clown.stefanochizzolini.it
Contributors:
* Stefano Chizzolini (original code developer, http://www.stefanochizzolini.it)
This file should be part of the source code distribution of "PDF Clown library"
(the Program): see the accompanying README files for more info.
This Program is free software; you can redistribute it and/or modify it under
the terms of the GNU General Public License as published by the Free Software
Foundation; either version 2 of the License, or (at your option) any later version.
This Program is distributed in the hope that it will be useful, but WITHOUT ANY
WARRANTY, either expressed or implied; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the License for more details.
You should have received a copy of the GNU General Public License along with this
Program (see README files); if not, go to the GNU website (http://www.gnu.org/).
Redistribution and use, with or without modification, are permitted provided that such
redistributions retain the above copyright notice, license and disclaimer, along with
this list of conditions.
*/
using System;
namespace it.stefanochizzolini.clown.bytes{
/**
<summary>
<para>Input stream.</para>
<para>Its pivotal concept is the access pointer.</para>
</summary>
*/
public interface IInputStream : IDisposable
{
/**
<summary>Gets the hash representation of the sequence.</summary>
*/
int GetHashCode(
);
/**
<summary>Gets the used buffer size.</summary>
*/
long Length
{
get;
}
/**
<summary>Gets/Sets the pointer position.</summary>
*/
long Position
{
get;
set;
}
/**
<summary>Reads a sequence of bytes from the stream and advances the position
within the stream.</summary>
<param name="data">Target byte array.</param>
*/
void Read(
byte[] data
);
/**
<summary>Reads a sequence of bytes from the stream and advances the position
within the stream.</summary>
<param name="data">Target byte array.</param>
<param name="offset">Location in the byte array at which storing begins.</param>
<param name="length">Number of bytes to copy.</param>
*/
void Read(
byte[] data,
int offset,
int length
);
/**
<summary>Reads a byte from the stream and advances the position within the
stream, or returns -1 if at the end of the stream.</summary>
<returns>Byte from the stream.</returns>
*/
int ReadByte(
);
/**
<summary>Reads an integer from the stream and advances the position within the
stream, or returns -1 if at the end of the stream.</summary>
<returns>Integer from the stream.</returns>
*/
int ReadInt(
);
/**
<summary>Reads the next line of text.</summary>
<returns>String from the stream.</returns>
*/
string ReadLine(
);
/**
<summary>Reads a short integer from the stream and advances the position within
the stream.</summary>
<returns>Short integer from the stream.</returns>
*/
short ReadShort(
);
/**
<summary>Reads a signed byte integer from the stream and advances the position within
the stream.</summary>
<returns>Signed byte integer from the stream.</returns>
*/
sbyte ReadSignedByte(
);
/**
<summary>Reads an unsigned short integer from the stream and advances the position
within the stream.</summary>
<returns>Unsigned short integer from the stream.</returns>
*/
ushort ReadUnsignedShort(
);
/**
<summary>Reads a string from the stream and advances the position
within the stream.</summary>
<param name="length">Number of bytes to read.</param>
<returns>String from the stream.</returns>
*/
string ReadString(
int length
);
/**
<summary>Sets the pointer absolute position.</summary>
*/
void Seek(
long position
);
/**
<summary>Sets the pointer relative position.</summary>
*/
void Skip(
long offset
);
/**
<summary>Gets the buffer data copied to a newly-allocated byte array.</summary>
*/
byte[] ToByteArray(
);
}
}
|