C# Class Ionic.Zip.ZipSegmentedStream

Inheritance: System.IO.Stream

Show file Open project: haf/DotNetZip.Semverd Class Usage Examples

Public Methods

Method	Description
ComputeSegment ( int length ) : UInt32
Flush ( ) : void
ForReading ( string name, uint initialDiskNumber, uint maxDiskNumber ) : ZipSegmentedStream
ForUpdate ( string name, uint diskNumber ) : Stream	Sort-of like a factory method, ForUpdate is used only when the application needs to update the zip entry metadata for a segmented zip file, when the starting segment is earlier than the ending segment, for a particular entry. The update is always contiguous, never rolls over. As a result, this method doesn't need to return a ZSS; it can simply return a FileStream. That's why it's "sort of" like a Factory method. Caller must Close/Dispose the stream object returned by this method.
ForWriting ( string name, int maxSegmentSize ) : ZipSegmentedStream
Read ( byte buffer, int offset, int count ) : int	Read from the stream
Seek ( long offset, System origin ) : long
SetLength ( long value ) : void
ToString ( ) : String
TruncateBackward ( uint diskNumber, long offset ) : long
Write ( byte buffer, int offset, int count ) : void	Write to the stream.

Protected Methods

Method	Description
Dispose ( bool disposing ) : void

Private Methods

Method	Description
ZipSegmentedStream ( ) : System
_NameForSegment ( uint diskNumber ) : string
_SetReadStream ( ) : void
_SetWriteStream ( uint increment ) : void

Method Details

ComputeSegment() public method

public ComputeSegment ( int length ) : UInt32
length	int
return	System.UInt32

Dispose() protected method

protected Dispose ( bool disposing ) : void
disposing	bool
return	void

Flush() public method

public Flush ( ) : void
return	void

ForReading() public static method

public static ForReading ( string name, uint initialDiskNumber, uint maxDiskNumber ) : ZipSegmentedStream
name	string
initialDiskNumber	uint
maxDiskNumber	uint
return	ZipSegmentedStream

ForUpdate() public static method

Sort-of like a factory method, ForUpdate is used only when the application needs to update the zip entry metadata for a segmented zip file, when the starting segment is earlier than the ending segment, for a particular entry.

The update is always contiguous, never rolls over. As a result, this method doesn't need to return a ZSS; it can simply return a FileStream. That's why it's "sort of" like a Factory method.

Caller must Close/Dispose the stream object returned by this method.

public static ForUpdate ( string name, uint diskNumber ) : Stream
name	string
diskNumber	uint
return	Stream

ForWriting() public static method

public static ForWriting ( string name, int maxSegmentSize ) : ZipSegmentedStream
name	string
maxSegmentSize	int
return	ZipSegmentedStream

Read() public method

Read from the stream

public Read ( byte buffer, int offset, int count ) : int
buffer	byte	the buffer to read
offset	int	the offset at which to start
count	int	the number of bytes to read
return	int

Seek() public method

public Seek ( long offset, System origin ) : long
offset	long
origin	System
return	long

SetLength() public method

public SetLength ( long value ) : void
value	long
return	void

ToString() public method

public ToString ( ) : String
return	String

TruncateBackward() public method

public TruncateBackward ( uint diskNumber, long offset ) : long
diskNumber	uint
offset	long
return	long

Write() public method

Write to the stream.

public Write ( byte buffer, int offset, int count ) : void
buffer	byte	the buffer from which to write
offset	int	the offset at which to start writing
count	int	the number of bytes to write
return	void