ledger

Documentation

Index

• Constants
• type ChapterID
• type ControlLocator
  • func NewControlLocator(chapterID ChapterID, ofs uint32) ControlLocator
  • func NewDropControlLocator(id jet.ExactID, chapterID ChapterID, ofs uint64) ControlLocator
  • func (v ControlLocator) ChapterID() ChapterID
  • func (v ControlLocator) ChapterOffset() uint32
  • func (v ControlLocator) ExactID() jet.ExactID
  • func (v ControlLocator) IsZero() bool
  • func (v ControlLocator) Offset() uint64
• type DirectoryEntryFlags
• type DirectoryIndex
  • func NewDirectoryIndex(id SectionID, ordinal Ordinal) DirectoryIndex
  • func (v DirectoryIndex) IsZero() bool
  • func (v DirectoryIndex) Ordinal() Ordinal
  • func (v DirectoryIndex) SectionID() SectionID
  • func (v DirectoryIndex) WithFlags(flags DirectoryEntryFlags) DirectoryIndexAndFlags
• type DirectoryIndexAndFlags
  • func (v DirectoryIndexAndFlags) DirectoryIndex() DirectoryIndex
  • func (v DirectoryIndexAndFlags) Flags() DirectoryEntryFlags
  • func (v DirectoryIndexAndFlags) IsZero() bool
  • func (v DirectoryIndexAndFlags) Ordinal() Ordinal
  • func (v DirectoryIndexAndFlags) SectionID() SectionID
  • func (v DirectoryIndexAndFlags) WithFlags(flags DirectoryEntryFlags) DirectoryIndexAndFlags
  • func (v DirectoryIndexAndFlags) WithIndex(index DirectoryIndex) DirectoryIndexAndFlags
• type DropOrdinal
  • func NewDropOrdinal(id jet.ExactID, ordinal Ordinal) DropOrdinal
  • func NewNoDropOrdinal(ordinal Ordinal) DropOrdinal
  • func (v DropOrdinal) ExactID() jet.ExactID
  • func (v DropOrdinal) IsZero() bool
  • func (v DropOrdinal) Ordinal() Ordinal
• type ExtensionID
• type Ordinal
• type SectionID
• type StorageLocator
  • func NewLocator(id SectionID, chapterID ChapterID, ofs uint32) StorageLocator
  • func NewOffsetLocator(id SectionID, ofs uint64) StorageLocator
  • func (v StorageLocator) ChapterID() ChapterID
  • func (v StorageLocator) ChapterOffset() uint32
  • func (v StorageLocator) IsZero() bool
  • func (v StorageLocator) Offset() uint64
  • func (v StorageLocator) SectionID() SectionID

Constants

const DefaultDataSection = DefaultEntrySection

DefaultDataSection is to store data indefinitely (except for wiping out & evictions)

const MaxChapterOffset = 0x00FF_FFFF

const MaxControlChapterID = MaxChapterID >> 1

const MaxSectionID = (^SectionID(0)) >> 1

const RelativeEntry = ControlSection

RelativeEntry is used to reference an entry in the same bundle for filament binding logic on storage side. Used by LineStage and UpdateBundle logic, which are not applicable for ControlSection entries.

Types

type ChapterID

type ChapterID uint32

const MaxChapterID ChapterID = 0x00FF_FFFF

type ControlLocator

type ControlLocator StorageLocator

func NewControlLocator

func NewControlLocator(chapterID ChapterID, ofs uint32) ControlLocator

func NewDropControlLocator

func NewDropControlLocator(id jet.ExactID, chapterID ChapterID, ofs uint64) ControlLocator

func (ControlLocator) ChapterID

func (v ControlLocator) ChapterID() ChapterID

func (ControlLocator) ChapterOffset

func (v ControlLocator) ChapterOffset() uint32

func (ControlLocator) ExactID

func (v ControlLocator) ExactID() jet.ExactID

func (ControlLocator) IsZero

func (v ControlLocator) IsZero() bool

func (ControlLocator) Offset

func (v ControlLocator) Offset() uint64

type DirectoryEntryFlags

type DirectoryEntryFlags uint16

const (
	FilamentClose DirectoryEntryFlags = 1 << iota
	FilamentLocalStart
	FilamentReopen
)

type DirectoryIndex

type DirectoryIndex uint64

func NewDirectoryIndex

func NewDirectoryIndex(id SectionID, ordinal Ordinal) DirectoryIndex

func (DirectoryIndex) IsZero

func (v DirectoryIndex) IsZero() bool

func (DirectoryIndex) Ordinal

func (v DirectoryIndex) Ordinal() Ordinal

func (DirectoryIndex) SectionID

func (v DirectoryIndex) SectionID() SectionID

func (DirectoryIndex) WithFlags

func (v DirectoryIndex) WithFlags(flags DirectoryEntryFlags) DirectoryIndexAndFlags

type DirectoryIndexAndFlags

type DirectoryIndexAndFlags uint64

func (DirectoryIndexAndFlags) DirectoryIndex

func (v DirectoryIndexAndFlags) DirectoryIndex() DirectoryIndex

func (DirectoryIndexAndFlags) Flags

func (v DirectoryIndexAndFlags) Flags() DirectoryEntryFlags

func (DirectoryIndexAndFlags) IsZero

func (v DirectoryIndexAndFlags) IsZero() bool

func (DirectoryIndexAndFlags) Ordinal

func (v DirectoryIndexAndFlags) Ordinal() Ordinal

func (DirectoryIndexAndFlags) SectionID

func (v DirectoryIndexAndFlags) SectionID() SectionID

func (DirectoryIndexAndFlags) WithFlags

func (v DirectoryIndexAndFlags) WithFlags(flags DirectoryEntryFlags) DirectoryIndexAndFlags

func (DirectoryIndexAndFlags) WithIndex

func (v DirectoryIndexAndFlags) WithIndex(index DirectoryIndex) DirectoryIndexAndFlags

type DropOrdinal

type DropOrdinal uint64

func NewDropOrdinal

func NewDropOrdinal(id jet.ExactID, ordinal Ordinal) DropOrdinal

func NewNoDropOrdinal

func NewNoDropOrdinal(ordinal Ordinal) DropOrdinal

func (DropOrdinal) ExactID

func (v DropOrdinal) ExactID() jet.ExactID

func (DropOrdinal) IsZero

func (v DropOrdinal) IsZero() bool

func (DropOrdinal) Ordinal

func (v DropOrdinal) Ordinal() Ordinal

type ExtensionID

type ExtensionID uint32

const (
	OrdinalSize                       = 4
	SameAsBodyExtensionID ExtensionID = 0
)

type Ordinal

type Ordinal uint32

type SectionID

type SectionID uint16

const (
	// ControlSection is to keep storage management information. Resides outside of drops. Its entries can only be in this section.
	ControlSection SectionID = iota

	// DefaultEntrySection is to store catalog entries of a drop.
	DefaultEntrySection

	// DefaultDustSection is to store data temporarily with no exact guarantees of retention time after finalization.
	DefaultDustSection
)

type StorageLocator

type StorageLocator uint64

func NewLocator

func NewLocator(id SectionID, chapterID ChapterID, ofs uint32) StorageLocator

func NewOffsetLocator

func NewOffsetLocator(id SectionID, ofs uint64) StorageLocator

func (StorageLocator) ChapterID

func (v StorageLocator) ChapterID() ChapterID

func (StorageLocator) ChapterOffset

func (v StorageLocator) ChapterOffset() uint32

func (StorageLocator) IsZero

func (v StorageLocator) IsZero() bool

func (StorageLocator) Offset

func (v StorageLocator) Offset() uint64

func (StorageLocator) SectionID

func (v StorageLocator) SectionID() SectionID