Class: openpgp_packet_compressed

openpgp_packet_compressed

Implementation of the Compressed Data Packet (Tag 8) RFC4880 5.6: The Compressed Data packet contains compressed data. Typically, this packet is found as the contents of an encrypted packet, or following a Signature or One-Pass Signature packet, and contains a literal data packet.

new openpgp_packet_compressed

Source:
  • openpgp.js, line 2519

Methods

<inner> compress

Compress the packet data (member decompressedData)
Parameters:
Name Type Description
type integer algorithm to be used // See RFC 4880 9.3
data String data to be compressed
Source:
  • openpgp.js, line 2599
Returns:
The compressed data stored in attribute compressedData
Type
String

<inner> decompress

decompression method for decompressing the compressed data read by read_packet
Source:
  • openpgp.js, line 2543
Returns:
the decompressed data
Type
String

<inner> read_packet

parsing function for the packet.
Parameters:
Name Type Description
input string payload of a tag 8 packet
position integer position to start reading from the input string
len integer length of the packet or the remaining length of input at position
Source:
  • openpgp.js, line 2529
Returns:
object representation
Type
openpgp_packet_compressed

<inner> toString

pretty printing the packet (useful for debug purposes)
Source:
  • openpgp.js, line 2644
Returns:
Type
String

<inner> write_packet

creates a string representation of the packet
Parameters:
Name Type Description
algorithm integer algorithm to be used // See RFC 4880 9.3
data String data to be compressed
Source:
  • openpgp.js, line 2631
Returns:
string-representation of the packet
Type
String