carbon

package module

v0.0.0-...-07badf5 Latest Latest Go to latest Published: Jul 21, 2021 License: Apache-2.0, MIT Imports: 15 Imported by: 0

Details

Valid go.mod file

The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license

Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version

Modules with tagged versions give importers more predictable builds.
Stable version

When a project reaches major version v1 it is considered stable.
Learn more about best practices

Repository

github.com/willscott/carbon

Links

Open Source Insights

README ¶

💎 Carbon

Note: This repository has been integrated into the core car library. Use of this module is deprecated, and you should instead prefer car/v2/blockstore.

Carbon provides a blockstore interface with saved blocks stored to a car-compatible log. A Carbs index for the resulting file is tracked and can be saved as needed.

Note: Carbon does not support deletion.

License

Carbon is dual-licensed under Apache 2.0 and MIT terms:

Apache License, Version 2.0, (LICENSE or http://www.apache.org/licenses/LICENSE-2.0)
MIT license (LICENSE-MIT or http://opensource.org/licenses/MIT)

Documentation ¶

Index ¶

Constants
type Carbondeprecated
- func New(path string) (Carbon, error)
- func NewWithRoots(path string, roots []cid.Cid) (Carbon, error)

Constants ¶

View Source

const IndexInsertion carbs.IndexCodec = 0x300010

IndexInsertion carbs IndexCodec identifier

Variables ¶

This section is empty.

Functions ¶

This section is empty.

Types ¶

type Carbon deprecated

type Carbon interface {
	bs.Blockstore
	Checkpoint() error
	Finish() error
}

Deprecated: Prefer go-car/v2/blockstore.ReadWrite Carbon is a carbs-index-compatible blockstore supporting appending additional blocks

func New ¶

func New(path string) (Carbon, error)

New creates a new Carbon blockstore

func NewWithRoots ¶

func NewWithRoots(path string, roots []cid.Cid) (Carbon, error)

NewWithRoots creates a new Carbon blockstore with a provided set of root cids as the car roots

Source Files ¶

View all Source files

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