class Novika::Image

• Novika::Image
• BinData
• Reference
• Object

Overview

An image consists of the 'NKI' signature, payload compression type (see Image::CompressionType), and the (optionally compressed) payload itself (see ImagePayload).

Defined in:

novika/image.cr

Constant Summary

ENDIAN = ["big"]

An image consists of the 'NKI' signature, payload compression type (see Image::CompressionType), and the (optionally compressed) payload itself (see ImagePayload).

KLASS_NAME = [Novika::Image]

An image consists of the 'NKI' signature, payload compression type (see Image::CompressionType), and the (optionally compressed) payload itself (see ImagePayload).

PARTS = [{type: "string", name: signature, cls: String, onlyif: nil, verify: -> do signature == "NKI" end, length: -> do 3 end, value: nil, encoding: nil}, {type: "bitfield", name: 3, cls: Novika::Image, onlyif: nil, verify: nil}] of Nil

An image consists of the 'NKI' signature, payload compression type (see Image::CompressionType), and the (optionally compressed) payload itself (see ImagePayload).

REMAINING = [{type: "bytes", name: payload, onlyif: nil, verify: nil}] of Nil

An image consists of the 'NKI' signature, payload compression type (see Image::CompressionType), and the (optionally compressed) payload itself (see ImagePayload).

Constructors

• .new(payload : ImagePayload, compression = CompressionType::GzipFast)
• .new(block : Block, caps : CapabilityCollection, compression = CompressionType::GzipFast, mode = CaptureMode::CaptureAll)

  Returns the Image formed with this block as the pivot block.

Class Method Summary

• .bit_fields

  An image consists of the 'NKI' signature, payload compression type (see Image::CompressionType), and the (optionally compressed) payload itself (see ImagePayload).

Instance Method Summary

• #__format__ : IO::ByteFormat
• #compression : CompressionType

  Holds compression method used to compress the payload.

• #compression=(compression : UInt8)

  Holds compression method used to compress the payload.

• #compression=(value : CompressionType)

  Holds compression method used to compress the payload.

• #payload : Bytes

  Holds the payload, which may or may not be compressed.

• #payload=(payload : Bytes)

  Holds the payload, which may or may not be compressed.

• #reserved : UInt8
• #reserved=(reserved : UInt8)
• #signature : String

  Holds Novika image signature, the string 'NKI'.

• #signature=(signature : String)

  Holds Novika image signature, the string 'NKI'.

• #to_block(caps : CapabilityCollection)

  Reconstructs the pivot block and its hierarchy from this image.

Macro Summary

• novika_block_pool(name, onlyif = nil, verify = nil, value = nil)

  An image consists of the 'NKI' signature, payload compression type (see Image::CompressionType), and the (optionally compressed) payload itself (see ImagePayload).

• novika_block_ref_snapshot(name, onlyif = nil, verify = nil, value = nil)

  An image consists of the 'NKI' signature, payload compression type (see Image::CompressionType), and the (optionally compressed) payload itself (see ImagePayload).

• novika_boolean_snapshot(name, onlyif = nil, verify = nil, value = nil)

  An image consists of the 'NKI' signature, payload compression type (see Image::CompressionType), and the (optionally compressed) payload itself (see ImagePayload).

• novika_builtin_snapshot(name, onlyif = nil, verify = nil, value = nil)

  An image consists of the 'NKI' signature, payload compression type (see Image::CompressionType), and the (optionally compressed) payload itself (see ImagePayload).

• novika_byteslice_snapshot(name, onlyif = nil, verify = nil, value = nil)

  An image consists of the 'NKI' signature, payload compression type (see Image::CompressionType), and the (optionally compressed) payload itself (see ImagePayload).

• novika_color_snapshot(name, onlyif = nil, verify = nil, value = nil)

  An image consists of the 'NKI' signature, payload compression type (see Image::CompressionType), and the (optionally compressed) payload itself (see ImagePayload).

• novika_frozen_block(name, onlyif = nil, verify = nil, value = nil)

  An image consists of the 'NKI' signature, payload compression type (see Image::CompressionType), and the (optionally compressed) payload itself (see ImagePayload).

• novika_frozen_block_dict(name, onlyif = nil, verify = nil, value = nil)

  An image consists of the 'NKI' signature, payload compression type (see Image::CompressionType), and the (optionally compressed) payload itself (see ImagePayload).

• novika_frozen_block_friends(name, onlyif = nil, verify = nil, value = nil)

  An image consists of the 'NKI' signature, payload compression type (see Image::CompressionType), and the (optionally compressed) payload itself (see ImagePayload).

• novika_frozen_block_tape(name, onlyif = nil, verify = nil, value = nil)

  An image consists of the 'NKI' signature, payload compression type (see Image::CompressionType), and the (optionally compressed) payload itself (see ImagePayload).

• novika_frozen_entry(name, onlyif = nil, verify = nil, value = nil)

  An image consists of the 'NKI' signature, payload compression type (see Image::CompressionType), and the (optionally compressed) payload itself (see ImagePayload).

• novika_image(name, onlyif = nil, verify = nil, value = nil)

  An image consists of the 'NKI' signature, payload compression type (see Image::CompressionType), and the (optionally compressed) payload itself (see ImagePayload).

• novika_image_payload(name, onlyif = nil, verify = nil, value = nil)

  An image consists of the 'NKI' signature, payload compression type (see Image::CompressionType), and the (optionally compressed) payload itself (see ImagePayload).

• novika_image_payload_capabilities(name, onlyif = nil, verify = nil, value = nil)

  An image consists of the 'NKI' signature, payload compression type (see Image::CompressionType), and the (optionally compressed) payload itself (see ImagePayload).

• novika_image_payload_capability_id(name, onlyif = nil, verify = nil, value = nil)

  An image consists of the 'NKI' signature, payload compression type (see Image::CompressionType), and the (optionally compressed) payload itself (see ImagePayload).

• novika_image_payload_ver(name, onlyif = nil, verify = nil, value = nil)

  An image consists of the 'NKI' signature, payload compression type (see Image::CompressionType), and the (optionally compressed) payload itself (see ImagePayload).

• novika_large_decimal_snapshot(name, onlyif = nil, verify = nil, value = nil)

  An image consists of the 'NKI' signature, payload compression type (see Image::CompressionType), and the (optionally compressed) payload itself (see ImagePayload).

• novika_quote_snapshot(name, onlyif = nil, verify = nil, value = nil)

  An image consists of the 'NKI' signature, payload compression type (see Image::CompressionType), and the (optionally compressed) payload itself (see ImagePayload).

• novika_quoted_word_snapshot(name, onlyif = nil, verify = nil, value = nil)

  An image consists of the 'NKI' signature, payload compression type (see Image::CompressionType), and the (optionally compressed) payload itself (see ImagePayload).

• novika_small_decimal_snapshot(name, onlyif = nil, verify = nil, value = nil)

  An image consists of the 'NKI' signature, payload compression type (see Image::CompressionType), and the (optionally compressed) payload itself (see ImagePayload).

• novika_snapshot(name, onlyif = nil, verify = nil, value = nil)

  An image consists of the 'NKI' signature, payload compression type (see Image::CompressionType), and the (optionally compressed) payload itself (see ImagePayload).

• novika_typed_snapshot(name, onlyif = nil, verify = nil, value = nil)

  An image consists of the 'NKI' signature, payload compression type (see Image::CompressionType), and the (optionally compressed) payload itself (see ImagePayload).

• novika_word_snapshot(name, onlyif = nil, verify = nil, value = nil)

  An image consists of the 'NKI' signature, payload compression type (see Image::CompressionType), and the (optionally compressed) payload itself (see ImagePayload).

Constructor Detail

Class Method Detail

Instance Method Detail

Macro Detail