class BinaryParser

• BinaryParser
• Reference
• Object

Overview

BinaryParser for Crystal

class Parser < BinaryParser
  uint8 :value
end

io = IO::Memory.new(sizeof(UInt8))
io.write_bytes(42)
io.rewind
parser = Parser.new.load(io)

parser.value # 42

Defined in:

Class Method Summary

• .from_io(io : IO, format : IO::ByteFormat)

  Support for IO#read_bytes

Instance Method Summary

• #load(filename : String)

  Load from file with filename

• #load(io : IO)

  Load from an IO object

• #save(filename : String)

  Save to file with filename

• #to_io(io : IO, format : IO::ByteFormat)

  Support for IO#write_bytes

• #to_s(io : IO)

  Convert to string

• #write(io : IO)

  Write to an IO object

Macro Summary

• array(name, opt)

  Declare an array field

• char(name)
• int16(name)

  Declare a int16 field

• int32(name)

  Declare a int32 field

• int8(name)

  Declare a int8 field

• string(name, opt = {count: -1})

  Declare a string field

• type(name, klass)

  Nested BinaryParser

• uint16(name)

  Declare a uint16 field

• uint32(name)

  Declare a uint32 field

• uint8(name)

  Declare a uint8 field

Class Method Detail

Instance Method Detail

File.write("filename", parser)

Macro Detail

# Fixed size
class Parser < BinaryParser
  array :arr, { type: UInt8, count: 10 } # Array of 10 UInt8
end

# Variable size
class Parser < BinaryParser
  uint32 :size
  array :arr, { type: UInt8, count: :size }
end

int16 :value # name of field

int32 :value # name of field

int8 :value # name of field

# Fixed size
class Parser < BinaryParser
  string :str, { count: 10 } # Array of 10 UInt8
end

# Variable size
class Parser < BinaryParser
  uint32 :size
  string :str, { count: :size }
end

class InnerParser < BinaryParser
  uint8 :foo
end

class Parser < BinaryParser
  type :inner, InnerParser
end

uint16 :value # name of field

uint32 :value # name of field

uint8 :value # name of field