Struct

A typeclass for binary data structures.

A struct's alignment, offset and size constitute its frame; the alignment must evenly divide the offset and size. Structs must never access more than size - 1 bytes beyond a given address, and should assume proper alignment of provided addresses.

T: This struct's instance type.

Annotations: @implicitNotFound( ... )

Linear Supertypes

ClassTypeHint[T], TypeHint[T], Equals, AnyRef, Any

Known Subclasses

PackedBoolean, PackedByte, PackedDouble, PackedFloat, PackedInt, PackedLong, PackedShort, PaddedDouble, PaddedFloat, PaddedInt, PaddedLong, PaddedShort, Record2, Record3, Record4

Instance Constructors

new Struct()

Abstract Value Members

abstract def alignment: Long

Returns the power-of-two alignment of this struct's frame.
Returns the power-of-two alignment of this struct's frame. This alignment must evenly divide all storage addresses used for values of this type.
abstract def load(data: Data, address: Long): T

Loads a struct instance from data.
Loads a struct instance from data.
data
the data to load from.
address
the aligned address in data to load from.
returns
the loaded instance.
abstract def runtimeClass: Class[_]

Definition Classes
ClassTypeHint
abstract def size: Long

Returns the size in bytes of this struct's frame.
Returns the size in bytes of this struct's frame. The struct's alignment must evenly divide this size.
abstract def store(data: Data, address: Long, value: T): Unit

Stores a struct instance as data.
Stores a struct instance as data.
data
the data to store to.
address
the aligned address in data to store to.
value
the instance to store.

Concrete Value Members

final def !=(arg0: AnyRef): Boolean

Definition Classes
AnyRef
final def !=(arg0: Any): Boolean

Definition Classes
Any
final def ##(): Int

Definition Classes
AnyRef → Any
final def ==(arg0: AnyRef): Boolean

Definition Classes
AnyRef
final def ==(arg0: Any): Boolean

Definition Classes
Any
final def asInstanceOf[T0]: T0

Definition Classes
Any
def canEqual(other: Any): Boolean

Definition Classes
ClassTypeHint → Equals
def clone(): AnyRef

Attributes
protected[java.lang]
Definition Classes
AnyRef
Annotations
@throws()
final def eq(arg0: AnyRef): Boolean

Definition Classes
AnyRef
def equals(other: Any): Boolean

Definition Classes
ClassTypeHint → Equals → AnyRef → Any
def finalize(): Unit

Attributes
protected[java.lang]
Definition Classes
AnyRef
Annotations
@throws()
final def getClass(): Class[_]

Definition Classes
AnyRef → Any
def hashCode(): Int

Definition Classes
ClassTypeHint → AnyRef → Any
final def isInstanceOf[T0]: Boolean

Definition Classes
Any
final def ne(arg0: AnyRef): Boolean

Definition Classes
AnyRef
def newArray(length: Int): Array[T]

Definition Classes
ClassTypeHint
final def notify(): Unit

Definition Classes
AnyRef
final def notifyAll(): Unit

Definition Classes
AnyRef
final def synchronized[T0](arg0: ⇒ T0): T0

Definition Classes
AnyRef
def toString(): String

Definition Classes
ClassTypeHint → AnyRef → Any
final def wait(): Unit

Definition Classes
AnyRef
Annotations
@throws()
final def wait(arg0: Long, arg1: Int): Unit

Definition Classes
AnyRef
Annotations
@throws()
final def wait(arg0: Long): Unit

Definition Classes
AnyRef
Annotations
@throws()

abstract class Struct[T] extends ClassTypeHint[T]

Instance Constructors

new Struct()

Abstract Value Members

abstract def alignment: Long

abstract def load(data: Data, address: Long): T

abstract def runtimeClass: Class[_]

abstract def size: Long

abstract def store(data: Data, address: Long, value: T): Unit

Concrete Value Members

final def !=(arg0: AnyRef): Boolean

final def !=(arg0: Any): Boolean

final def ##(): Int

final def ==(arg0: AnyRef): Boolean

final def ==(arg0: Any): Boolean

final def asInstanceOf[T0]: T0

def canEqual(other: Any): Boolean

def clone(): AnyRef

final def eq(arg0: AnyRef): Boolean

def equals(other: Any): Boolean

def finalize(): Unit

final def getClass(): Class[_]

def hashCode(): Int

final def isInstanceOf[T0]: Boolean

final def ne(arg0: AnyRef): Boolean

def newArray(length: Int): Array[T]

final def notify(): Unit

final def notifyAll(): Unit

final def synchronized[T0](arg0: ⇒ T0): T0

def toString(): String

final def wait(): Unit

final def wait(arg0: Long, arg1: Int): Unit

final def wait(arg0: Long): Unit

Inherited from ClassTypeHint[T]

Inherited from TypeHint[T]

Inherited from Equals

Inherited from AnyRef

Inherited from Any

Ungrouped