ZipCrc Go Reference Documentation

ZipCrc

Current Version: 10.1.2

Calculate a Zip CRC checksum for a file or in-memory data.

Object Creation

zipcrc := chilkat.NewZipCrc()
...
zipcrc.DisposeZipCrc()

Properties

DebugLogFilePath
func (zipcrc *ZipCrc) DebugLogFilePath() string
func (zipcrc *ZipCrc) SetDebugLogFilePath(s string)

If set to a file path, this property logs the LastErrorText of each Chilkat method or property call to the specified file. This logging helps identify the context and history of Chilkat calls leading up to any crash or hang, aiding in debugging.

Enabling the VerboseLogging property provides more detailed information. This property is mainly used for debugging rare instances where a Chilkat method call causes a hang or crash, which should generally not happen.

Possible causes of hangs include:

  • A timeout property set to 0, indicating an infinite timeout.
  • A hang occurring within an event callback in the application code.
  • An internal bug in the Chilkat code causing the hang.

More Information and Examples
top
LastErrorHtml
func (zipcrc *ZipCrc) LastErrorHtml() string

Provides HTML-formatted information about the last called method or property. If a method call fails or behaves unexpectedly, check this property for details. Note that information is available regardless of the method call's success.

top
LastErrorText
func (zipcrc *ZipCrc) LastErrorText() string

Provides plain text information about the last called method or property. If a method call fails or behaves unexpectedly, check this property for details. Note that information is available regardless of the method call's success.

top
LastErrorXml
func (zipcrc *ZipCrc) LastErrorXml() string

Provides XML-formatted information about the last called method or property. If a method call fails or behaves unexpectedly, check this property for details. Note that information is available regardless of the method call's success.

top
LastMethodSuccess
func (zipcrc *ZipCrc) LastMethodSuccess() bool
func (zipcrc *ZipCrc) SetLastMethodSuccess(b bool)

Indicates the success or failure of the most recent method call: true means success, false means failure. This property remains unchanged by property setters or getters. This method is present to address challenges in checking for null or Nothing returns in certain programming languages.

top
VerboseLogging
func (zipcrc *ZipCrc) VerboseLogging() bool
func (zipcrc *ZipCrc) SetVerboseLogging(b bool)

If set to true, then the contents of LastErrorText (or LastErrorXml, or LastErrorHtml) may contain more verbose information. The default value is false. Verbose logging should only be used for debugging. The potentially large quantity of logged information may adversely affect peformance.

top
Version
func (zipcrc *ZipCrc) Version() string

Version of the component/library, such as "10.1.0"

More Information and Examples
top

Methods

BeginStream
func (zipcrc *ZipCrc) BeginStream()

Provides a way to calculate a CRC by streaming the data a chunk at a time. An application would start by calling BeginStream. Then it would add data by calling MoreData for each additional chunk. After the last chunk has been processed, the EndStream method is called to return the CRC.

top
CalculateCrc
func (zipcrc *ZipCrc) CalculateCrc(data []byte) uint

Calculates a 32-bit CRC for in-memory byte data. This is the 32-bit CRC that would be found in a Zip file header if a file containing the data was added to a zip archive. Returns the CRC32 of the data.

top
CrcBd
func (zipcrc *ZipCrc) CrcBd(bd *BinData) uint
Introduced in version 9.5.0.75

Calculates a CRC32 for the bytes contained in bd.

top
CrcSb
func (zipcrc *ZipCrc) CrcSb(sb *StringBuilder, charset string) uint
Introduced in version 9.5.0.75

Calculates a CRC32 for the string contained in sb. The charset is the byte representation to be used for the sb when calculating the CRC32. It can be utf-8, utf-16, windows-1252, iso-8859-1, or any of the character encodings (charsets) listed at the link below.

top
CrcString
func (zipcrc *ZipCrc) CrcString(str string, charset string) uint
Introduced in version 9.5.0.75

Calculates a CRC32 for a string. The charset is the byte representation to be used for the str when calculating the CRC32. It can be utf-8, utf-16, windows-1252, iso-8859-1, or any of the character encodings (charsets) listed at the link below.

top
EndStream
func (zipcrc *ZipCrc) EndStream() uint

Finalizes and returns the Zip CRC value calculated by calling BeginStream followed by multiple calls to MoreData.

top
FileCrc
func (zipcrc *ZipCrc) FileCrc(path string) uint

Calculates the CRC32 of a file. The data contained in the file is streamed for the calculation to keep the memory footprint small and constant. Returns the CRC32 of the file.

More Information and Examples
top
FileCrcAsync (1)
func (zipcrc *ZipCrc) FileCrcAsync(path string, task chan *Task)

Creates an asynchronous task to call the FileCrc method with the arguments provided.

Returns nil on failure

top
LoadTaskCaller
func (zipcrc *ZipCrc) LoadTaskCaller(task *Task) bool
Introduced in version 9.5.0.80

Loads the caller of the task's async method.

Returns true for success, false for failure.

top
MoreData
func (zipcrc *ZipCrc) MoreData(data []byte)

Adds additional data to the CRC currently being calculated. (See BeginStream for more information.)

top
ToHex
func (zipcrc *ZipCrc) ToHex(crc uint) *string

Converts a 32-bit integer to a hex string.

Returns nil on failure

top