client

package

v0.1.31 Latest Latest Go to latest Published: Oct 18, 2022 License: GPL-3.0 Imports: 5 Imported by: 2

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

bitbucket.org/taubyte/go-sdk

Links

Open Source Insights

Documentation ¶

Index ¶

Constants
type Client
- func New() (Client, error)
- func (c Client) Create() (*Content, error)
- func (c Client) Open(_cid cid.Cid) (*Content, error)
type Content

Constants ¶

View Source

const CidBufferSize = 64

Variables ¶

This section is empty.

Functions ¶

This section is empty.

Types ¶

type Client ¶

type Client uint32

func New ¶

func New() (Client, error)

func (Client) Create ¶ added in v0.1.23

func (c Client) Create() (*Content, error)

Creates creates and returns the new content.

func (Client) Open ¶ added in v0.1.23

func (c Client) Open(_cid cid.Cid) (*Content, error)

Open creates a new content using the cid given as the file. Returns a new content.

type Content ¶ added in v0.1.23

type Content struct {
	Id uint32
	// contains filtered or unexported fields
}

func (*Content) Cid ¶ added in v0.1.23

func (c *Content) Cid() (cid.Cid, error)

Cid returns the cid of the file and an error.

func (*Content) Close ¶ added in v0.1.23

func (c *Content) Close() error

Close closes the file associated with the content. Returns an error.

func (*Content) Push ¶ added in v0.1.23

func (c *Content) Push() (cid.Cid, error)

Push adds the file into the network. Updates the cid of the file. Returns cid and an error

func (*Content) Read ¶ added in v0.1.23

func (c *Content) Read(p []byte) (int, []byte, error)

Read reads up to len p in the file. Returns how much was read and an error.

func (*Content) Seek ¶ added in v0.1.23

func (c *Content) Seek(offset int64, whence int) (int64, error)

Seek moves to a position inside the file. Offset is how much to move the current position Whence has three options: 0 = SeekStart, 1 = SeekCurrent, or 2 = SeekEnd Combines both offset and whence to find a new offset inside the file Returns the new offset and an error

func (*Content) Write ¶ added in v0.1.23

func (c *Content) Write(p []byte) (int, error)

Write writes the passed in data into the file. Returns how much was written and an error.

Source Files ¶

View all Source files

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