Options
All
  • Public
  • Public/Protected
  • All
Menu

Module "yaz0/constants"

Index

Variables

Const CHUNKS_PER_GROUP

CHUNKS_PER_GROUP: 8 = 8

The number of chunks in a Yaz0 group.

Const CHUNK_DISTANCE_OFFSET

CHUNK_DISTANCE_OFFSET: 1 = 1

The value added to the distance of a Yaz0 chunk.

Const CHUNK_DISTANCE_WIDTH

CHUNK_DISTANCE_WIDTH: 12 = 12

The width of a Yaz0 chunk distance in bits.

Const GROUP_HEADER_LENGTH

GROUP_HEADER_LENGTH: 1 = 1

The length of a Yaz0 group header in bytes.

Const HEADER_LENGTH

HEADER_LENGTH: 16 = 16

The length of a Yaz0 file header in bytes.

Const LONG_CHUNK_LENGTH_OFFSET

LONG_CHUNK_LENGTH_OFFSET: 18 = 18

The value added to a the length of a long Yaz0 chunk.

Const MAGIC_STRING

MAGIC_STRING: "Yaz0" = "Yaz0"

The ASCII magic string beginning a Yaz0 file.

Const MAX_CHUNK_DISTANCE

MAX_CHUNK_DISTANCE: 4096 = 4096

The maximum distance of a Yaz0 backreference chunk in bytes.

Const MAX_COMPRESSED_CHUNK_LENGTH

MAX_COMPRESSED_CHUNK_LENGTH: 3 = 3

The maximum length of a compressed Yaz0 chunk in bytes.

Const MAX_COMPRESSED_GROUP_LENGTH

MAX_COMPRESSED_GROUP_LENGTH: number = GROUP_HEADER_LENGTH + MAX_COMPRESSED_CHUNK_LENGTH * CHUNKS_PER_GROUP

The maximum length of a compressed Yaz0 group in bytes.

Const MAX_DECOMPRESSED_CHUNK_LENGTH

MAX_DECOMPRESSED_CHUNK_LENGTH: 273 = 273

The maximum length of a decompressed Yaz0 chunk in bytes.

Const MAX_DECOMPRESSED_GROUP_LENGTH

MAX_DECOMPRESSED_GROUP_LENGTH: number = MAX_DECOMPRESSED_CHUNK_LENGTH * CHUNKS_PER_GROUP

The maximum length of a decompressed Yaz0 group in bytes.

Const MAX_DECOMPRESSED_SHORT_CHUNK_LENGTH

MAX_DECOMPRESSED_SHORT_CHUNK_LENGTH: 17 = 17

The maximum length of a decompressed short Yaz0 chunk in bytes.

Const MIN_CHUNK_LENGTH

MIN_CHUNK_LENGTH: 1 = 1

The minimum length of a compressed or decompressed Yaz0 chunk in bytes.

Const MIN_COMPRESSED_CHUNK_LENGTH

MIN_COMPRESSED_CHUNK_LENGTH: 2 = 2

The minimum length of a compressed Yaz0 chunk in bytes.

Const MIN_COMPRESSED_GROUP_LENGTH

MIN_COMPRESSED_GROUP_LENGTH: number = GROUP_HEADER_LENGTH + MIN_CHUNK_LENGTH * CHUNKS_PER_GROUP

The minimum length of a compressed Yaz0 group in bytes.

Const SHORT_CHUNK_LENGTH_OFFSET

SHORT_CHUNK_LENGTH_OFFSET: 2 = 2

The value added to a the length of a short Yaz0 chunk.

Generated using TypeDoc