TarInputStream Members

SharpZip Compression Library

previous page next page
SharpZip Compression Library

TarInputStream Members

TarInputStream overview

Public Instance Constructors

TarInputStream Overloaded. Initializes a new instance of the TarInputStream class.

Public Instance Properties

Available Get the available data that can be read from the current entry in the archive. This does not indicate how much data is left in the entire archive, only in the current entry. This value is determined from the entry's size header field and the amount of data already read from the current entry.
CanRead Gets a value indicating whether the current stream supports reading
CanSeek Gets a value indicating whether the current stream supports seeking This property always returns false.
CanWrite Gets a value indicating if the stream supports writing. This property always returns false.
IsMarkSupported Since we do not support marking just yet, we return false.
Length The length in bytes of the stream
Position Gets or sets the position within the stream. Setting the Position is not supported and throws a NotSupportedExceptionNotSupportedException

Public Instance Methods

BeginRead (inherited from Stream) Begins an asynchronous read operation.
BeginWrite (inherited from Stream) Begins an asynchronous write operation.
Close Closes this stream. Calls the TarBuffer's close() method. The underlying stream is closed by the TarBuffer.
CopyEntryContents Copies the contents of the current tar archive entry directly into an output stream.
CreateObjRef (inherited from MarshalByRefObject) Creates an object that contains all the relevant information required to generate a proxy used to communicate with a remote object.
EndRead (inherited from Stream) Waits for the pending asynchronous read to complete.
EndWrite (inherited from Stream) Ends an asynchronous write operation.
Equals (inherited from Object) Determines whether the specified Object is equal to the current Object.
Flush Flushes the baseInputStream
GetHashCode (inherited from Object) Serves as a hash function for a particular type, suitable for use in hashing algorithms and data structures like a hash table.
GetLifetimeService (inherited from MarshalByRefObject) Retrieves the current lifetime service object that controls the lifetime policy for this instance.
GetNextEntry Get the next entry in this tar archive. This will skip over any remaining data in the current entry, if there is one, and place the input stream at the header of the next entry, and read the header and instantiate a new TarEntry from the header bytes and return that entry. If there are no more entries in the archive, null will be returned to indicate that the end of the archive has been reached.
GetRecordSize Get the record size being used by this stream's TarBuffer.
GetType (inherited from Object) Gets the Type of the current instance.
InitializeLifetimeService (inherited from MarshalByRefObject) Obtains a lifetime service object to control the lifetime policy for this instance.
Mark Since we do not support marking just yet, we do nothing.
Read Reads bytes from the current tar archive entry. This method is aware of the boundaries of the current entry in the archive and will deal with them appropriately
ReadByte Reads a byte from the current tar archive entry. This method simply calls read(byte[], int, int).
Reset Since we do not support marking just yet, we do nothing.
Seek Set the streams position. This operation is not supported and will throw a NotSupportedException
SetEntryFactory Set the entry factory for this instance.
SetLength Sets the length of the stream This operation is not supported and will throw a NotSupportedException
Skip Skip bytes in the input buffer. This skips bytes in the current entry's data, not the entire archive, and will stop at the end of the current entry's data if the number to skip extends beyond that point.
ToString (inherited from Object) Returns a String that represents the current Object.
Write Writes a block of bytes to this stream using data from a buffer. This operation is not supported and will throw a NotSupportedException
WriteByte Writes a byte to the current position in the file stream. This operation is not supported and will throw a NotSupportedException

Protected Instance Fields

buffer Working buffer
currEntry Current entry being read
eFactory Factory used to create TarEntry or descendant class instance
entryOffset Number of bytes read for this entry so far
entrySize Size of this entry as recorded in header
hasHitEOF Flag set when last block has been read
readBuf Buffer used with calls to 
Read()

Protected Instance Methods

CreateWaitHandle (inherited from Stream) Allocates a WaitHandle object.
Finalize (inherited from Object) Allows an Object to attempt to free resources and perform other cleanup operations before the Object is reclaimed by garbage collection.
MemberwiseClone (inherited from Object) Creates a shallow copy of the current Object.

See Also

TarInputStream Class | ICSharpCode.SharpZipLib.Tar Namespace

previous page start next page