assert

package

v0.7.3 Latest Latest Go to latest Published: Feb 10, 2026 License: Apache-2.0, MIT Imports: 11 Imported by: 15

Details

Valid go.mod file
Redistributable license
Tagged version
Stable version
Learn more about best practices

Repository

github.com/storacha/go-libstoracha

Links

Open Source Insights

Documentation ¶

Index ¶

Constants
Variables
func EqualsCaveatsType() ipldschema.Type
func InclusionCaveatsType() ipldschema.Type
func IndexCaveatsType() ipldschema.Type
func LocationCaveatsType() ipldschema.Type
func PartitionCaveatsType() ipldschema.Type
func RelationCaveatsType() ipldschema.Type
type EqualsCaveats
- func (ec EqualsCaveats) ToIPLD() (datamodel.Node, error)
type InclusionCaveats
- func (ic InclusionCaveats) ToIPLD() (datamodel.Node, error)
type IndexCaveats
- func (ic IndexCaveats) ToIPLD() (datamodel.Node, error)
type LegacyLocationCaveats
type LocationCaveats
- func (lc LocationCaveats) ToIPLD() (datamodel.Node, error)
type PartitionCaveats
- func (pc PartitionCaveats) ToIPLD() (datamodel.Node, error)
type Range
type RelationCaveats
- func (rc RelationCaveats) ToIPLD() (datamodel.Node, error)
type RelationPart
type RelationPartInclusion

Constants ¶

View Source

const EqualsAbility = "assert/equals"

EqualsAbility claims data is referred to by another CID and/or multihash. e.g CAR CID & CommP CID

View Source

const InclusionAbility = "assert/inclusion"

InclusionAbility claims that a CID includes the contents claimed in another CID.

View Source

const IndexAbility = "assert/index"

IndexAbility claims that a content graph can be found in blob(s) that are identified and indexed in the given index CID.

View Source

const LocationAbility = "assert/location"

View Source

const PartitionAbility = "assert/partition"

PartitionAbility claims that a CID's graph can be read from the blocks found in parts.

View Source

const RelationAbility = "assert/relation"

InclusionAbility claims that a CID links to other CIDs.

Variables ¶

View Source

var Equals = validator.NewCapability(
	EqualsAbility,
	schema.DIDString(),
	EqualsCaveatsReader,
	nil,
)

View Source

var EqualsCaveatsReader = schema.Struct[EqualsCaveats](EqualsCaveatsType(), nil, types.Converters...)

View Source

var Inclusion = validator.NewCapability(InclusionAbility, schema.DIDString(),
	InclusionCaveatsReader, nil)

View Source

var InclusionCaveatsReader = schema.Struct[InclusionCaveats](InclusionCaveatsType(), nil, types.Converters...)

View Source

var Index = validator.NewCapability(IndexAbility, schema.DIDString(), IndexCaveatsReader, nil)

View Source

var IndexCaveatsReader = schema.Struct[IndexCaveats](IndexCaveatsType(), nil, types.Converters...)

View Source

var Location = validator.NewCapability(LocationAbility, schema.DIDString(), LocationCaveatsReader, nil)

View Source

var LocationCaveatsReader = schema.Mapped(schema.Struct[LegacyLocationCaveats](LocationCaveatsType(), nil, types.Converters...),
	func(llc LegacyLocationCaveats) (LocationCaveats, failure.Failure) {
		space := did.Undef
		if llc.Space != nil {
			space = *llc.Space
		}
		return LocationCaveats{llc.Content, llc.Location, llc.Range, space}, nil
	})

View Source

var Partition = validator.NewCapability(
	PartitionAbility,
	schema.DIDString(),
	PartitionCaveatsReader, nil)

View Source

var PartitionCaveatsReader = schema.Struct[PartitionCaveats](PartitionCaveatsType(), nil, types.Converters...)

View Source

var Relation = validator.NewCapability(
	RelationAbility,
	schema.DIDString(),
	RelationCaveatsReader,
	nil,
)

View Source

var RelationCaveatsReader = schema.Struct[RelationCaveats](RelationCaveatsType(), nil, types.Converters...)

Functions ¶

func EqualsCaveatsType ¶

func EqualsCaveatsType() ipldschema.Type

func InclusionCaveatsType ¶

func InclusionCaveatsType() ipldschema.Type

func IndexCaveatsType ¶

func IndexCaveatsType() ipldschema.Type

func LocationCaveatsType ¶

func LocationCaveatsType() ipldschema.Type

func PartitionCaveatsType ¶

func PartitionCaveatsType() ipldschema.Type

func RelationCaveatsType ¶

func RelationCaveatsType() ipldschema.Type

Types ¶

type EqualsCaveats ¶

type EqualsCaveats struct {
	Content types.HasMultihash
	Equals  ipld.Link
}

func (EqualsCaveats) ToIPLD ¶

func (ec EqualsCaveats) ToIPLD() (datamodel.Node, error)

type InclusionCaveats ¶

type InclusionCaveats struct {
	Content  types.HasMultihash
	Includes ipld.Link
	Proof    *ipld.Link
}

func (InclusionCaveats) ToIPLD ¶

func (ic InclusionCaveats) ToIPLD() (datamodel.Node, error)

type IndexCaveats ¶

type IndexCaveats struct {
	Content ipld.Link
	Index   ipld.Link
}

func (IndexCaveats) ToIPLD ¶

func (ic IndexCaveats) ToIPLD() (datamodel.Node, error)

type LegacyLocationCaveats ¶

type LegacyLocationCaveats struct {
	Content  types.HasMultihash
	Location []url.URL
	Range    *Range
	Space    *did.DID
}

Space field used to be optional, so we maintain compatibility

type LocationCaveats ¶

type LocationCaveats struct {
	Content  types.HasMultihash
	Location []url.URL
	Range    *Range
	Space    did.DID
}

func (LocationCaveats) ToIPLD ¶

func (lc LocationCaveats) ToIPLD() (datamodel.Node, error)

type PartitionCaveats ¶

type PartitionCaveats struct {
	Content types.HasMultihash
	Blocks  *ipld.Link
	Parts   []ipld.Link
}

func (PartitionCaveats) ToIPLD ¶

func (pc PartitionCaveats) ToIPLD() (datamodel.Node, error)

type Range ¶

type Range struct {
	Offset uint64
	Length *uint64
}

type RelationCaveats ¶

type RelationCaveats struct {
	Content  types.HasMultihash
	Children []ipld.Link
	Parts    []RelationPart
}

func (RelationCaveats) ToIPLD ¶

func (rc RelationCaveats) ToIPLD() (datamodel.Node, error)

type RelationPart ¶

type RelationPart struct {
	Content  ipld.Link
	Includes *RelationPartInclusion
}

type RelationPartInclusion ¶

type RelationPartInclusion struct {
	Content ipld.Link
	Parts   *[]ipld.Link
}

Source Files ¶

View all Source files

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL