client

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
  • func (c *Content) Cid() (cid.Cid, error)
  • func (c *Content) Close() error
  • func (c *Content) Push() (cid.Cid, error)
  • func (c *Content) Read(p []byte) (int, []byte, error)
  • func (c *Content) Seek(offset int64, whence int) (int64, error)
  • func (c *Content) Write(p []byte) (int, error)

Constants

const CidBufferSize = 64

Types

type Client

type Client uint32

func New

func New() (Client, error)

func (Client) Create

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

Creates creates and returns the new content.

func (Client) Open

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

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

func (*Content) Cid

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

Cid returns the cid of the file and an error.

func (*Content) Close

func (c *Content) Close() error

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

func (*Content) Push

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

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

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

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.