TarOutputStream Members

SharpZip Compression Library

SharpZip Compression Library

TarOutputStream Members

TarOutputStream overview

Public Instance Constructors

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

Public Instance Properties

CanRead true if the stream supports reading; otherwise, false.
CanSeek true if the stream supports seeking; otherwise, false.
CanWrite true if stream supports writing; otherwise, false.
Length length of stream in bytes
Position gets or sets the position within the current stream.

Public Instance Methods

BeginRead (inherited from Stream) Begins an asynchronous read operation.
BeginWrite (inherited from Stream) Begins an asynchronous write operation.
Close Ends the TAR archive and closes the underlying OutputStream. This means that finish() is called followed by calling the TarBuffer's close().
CloseEntry Close an entry. This method MUST be called for all file entries that contain data. The reason is that we must buffer data written to the stream in order to satisfy the buffer's block based writes. Thus, there may be data fragments still being assembled that must be written to the output stream before this entry is closed and the next entry written.
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.
Finish Ends the TAR archive without closing the underlying OutputStream. The result is that the EOF record of nulls is written.
Flush All buffered data is written to destination
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.
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.
PutNextEntry Put an entry on the output stream. This writes the entry's header and positions the output stream for writing the contents of the entry. Once this method is called, the stream is ready for calls to write() to write the entry's contents. Once the contents are written, closeEntry() MUST be called to ensure that all buffered data is completely written to the output stream.
Read read bytes from the current stream and advance the position within the stream by the number of bytes read.
ReadByte Read a byte from the stream and advance the position within the stream by one byte or returns -1 if at the end of the stream.
Seek set the position within the current stream
SetLength set the length of the current stream
ToString (inherited from Object) Returns a String that represents the current Object.
Write Writes bytes to the current tar archive entry. This method is aware of the current entry and will throw an exception if you attempt to write bytes past the length specified for the current entry. The method is also (painfully) aware of the record buffering required by TarBuffer, and manages buffers that are not a multiple of recordsize in length, including assembling records from small buffers.
WriteByte Writes a byte to the current tar archive entry. This method simply calls Write(byte[], int, int).

Protected Instance Fields

assemBuf 'Assembly' buffer used to assmble data before writing
assemLen current 'Assembly' buffer length
blockBuf single block working buffer
buffer TarBuffer used to provide correct blocking factor
currBytes bytes written for this entry so far
currSize Size for the current entry
debug flag indicating debugging code should be activated or not
outputStream the destination stream for the archive contents

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

TarOutputStream Class | ICSharpCode.SharpZipLib.Tar Namespace