Class: Indis::BinaryFormat::Format

Inherits:

Object

• Object
• Indis::BinaryFormat::Format

Defined in:

lib/indis-core/binary_format.rb

Overview

Base class for any binary format.

Class Method Summary

• .magic ⇒ Fixnum abstract

  Magic bytes that are checked against the first bytes in binary.

• .name ⇒ String abstract

  Human-readable format name.

Instance Method Summary

• #initialize(target, io) ⇒ Format constructor

  Basic constructor takes care of storing the target and io stream.

Constructor Details

#initialize(target, io) ⇒ Format

Basic constructor takes care of storing the target and io stream.

# File 'lib/indis-core/binary_format.rb', line 40

def initialize(target, io)
  @target = target
  @io = io
end

Class Method Details

.magic ⇒ Fixnum

This method is abstract.

Returns the format magic bytes.

Returns Magic bytes that are checked against the first bytes in binary.

Returns:

• (Fixnum) —

  Magic bytes that are checked against the first bytes in binary.

Raises:

• (RuntimeError)

# File 'lib/indis-core/binary_format.rb', line 48

def self.magic
  raise RuntimeError
end

.name ⇒ String

This method is abstract.

Returns the human-readable format name.

Returns Human-readable format name.

Returns:

• (String) —

  Human-readable format name.

Raises:

• (RuntimeError)

# File 'lib/indis-core/binary_format.rb', line 55

def self.name
  raise RuntimeError
end