client

Documentation

Index

• type ArchiveOption
  • func WithArchiveConfig(config *pb.ArchiveConfig) ArchiveOption
• type Client
  • func NewClient(target string, opts ...grpc.DialOption) (*Client, error)
  • func (c *Client) Archive(ctx context.Context, key string, opts ...ArchiveOption) error
  • func (c *Client) ArchiveInfo(ctx context.Context, key string) (*pb.ArchiveInfoResponse, error)
  • func (c *Client) ArchiveStatus(ctx context.Context, key string) (*pb.ArchiveStatusResponse, error)
  • func (c *Client) ArchiveWatch(ctx context.Context, key string, ch chan<- string) error
  • func (c *Client) Close() error
  • func (c *Client) Create(ctx context.Context, opts ...CreateOption) (*pb.CreateResponse, error)
  • func (c *Client) DefaultArchiveConfig(ctx context.Context, key string) (*pb.ArchiveConfig, error)
  • func (c *Client) Links(ctx context.Context, key, pth string) (*pb.LinksResponse, error)
  • func (c *Client) List(ctx context.Context) (*pb.ListResponse, error)
  • func (c *Client) ListIpfsPath(ctx context.Context, pth path.Path) (*pb.ListIpfsPathResponse, error)
  • func (c *Client) ListPath(ctx context.Context, key, pth string) (*pb.ListPathResponse, error)
  • func (c *Client) PullIpfsPath(ctx context.Context, pth path.Path, writer io.Writer, opts ...Option) error
  • func (c *Client) PullPath(ctx context.Context, key, pth string, writer io.Writer, opts ...Option) error
  • func (c *Client) PullPathAccessRoles(ctx context.Context, key, pth string) (map[string]buckets.Role, error)
  • func (c *Client) PushPath(ctx context.Context, key, pth string, reader io.Reader, opts ...Option) (result path.Resolved, root path.Resolved, err error)
  • func (c *Client) PushPathAccessRoles(ctx context.Context, key, pth string, roles map[string]buckets.Role) error
  • func (c *Client) Remove(ctx context.Context, key string) error
  • func (c *Client) RemovePath(ctx context.Context, key, pth string, opts ...Option) (path.Resolved, error)
  • func (c *Client) Root(ctx context.Context, key string) (*pb.RootResponse, error)
  • func (c *Client) SetDefaultArchiveConfig(ctx context.Context, key string, config *pb.ArchiveConfig) error
  • func (c *Client) SetPath(ctx context.Context, key, pth string, remoteCid cid.Cid) (*pb.SetPathResponse, error)
• type CreateOption
  • func WithCid(c cid.Cid) CreateOption
  • func WithName(name string) CreateOption
  • func WithPrivate(private bool) CreateOption
• type Option
  • func WithFastForwardOnly(root path.Resolved) Option
  • func WithProgress(ch chan<- int64) Option

Types

type ArchiveOption

type ArchiveOption func(*pb.ArchiveRequest)

func WithArchiveConfig

func WithArchiveConfig(config *pb.ArchiveConfig) ArchiveOption

WithArchiveConfig allows you to provide a custom ArchiveConfig for a single call to Archive.

type Client

type Client struct {
	// contains filtered or unexported fields
}

Client provides the client api.

func NewClient

func NewClient(target string, opts ...grpc.DialOption) (*Client, error)

NewClient starts the client.

func (*Client) Archive

func (c *Client) Archive(ctx context.Context, key string, opts ...ArchiveOption) error

Archive creates a Filecoin bucket archive via Powergate.

func (*Client) ArchiveInfo

func (c *Client) ArchiveInfo(ctx context.Context, key string) (*pb.ArchiveInfoResponse, error)

ArchiveInfo returns info about a Filecoin bucket archive.

func (*Client) ArchiveStatus

func (c *Client) ArchiveStatus(ctx context.Context, key string) (*pb.ArchiveStatusResponse, error)

ArchiveStatus returns the status of a Filecoin bucket archive.

func (*Client) ArchiveWatch

func (c *Client) ArchiveWatch(ctx context.Context, key string, ch chan<- string) error

ArchiveWatch watches status events from a Filecoin bucket archive.

func (*Client) Close

func (c *Client) Close() error

Close closes the client's grpc connection and cancels any active requests.

func (*Client) Create

func (c *Client) Create(ctx context.Context, opts ...CreateOption) (*pb.CreateResponse, error)

Create initializes a new bucket. The bucket name is only meant to help identify a bucket in a UI and is not unique.

func (*Client) DefaultArchiveConfig

func (c *Client) DefaultArchiveConfig(ctx context.Context, key string) (*pb.ArchiveConfig, error)

DefaultArchiveConfig gets the default archive config for the specified Bucket.

func (*Client) Links

func (c *Client) Links(ctx context.Context, key, pth string) (*pb.LinksResponse, error)

Links returns a list of bucket path URL links.

func (*Client) List

func (c *Client) List(ctx context.Context) (*pb.ListResponse, error)

List returns a list of all bucket roots.

func (*Client) ListIpfsPath

func (c *Client) ListIpfsPath(ctx context.Context, pth path.Path) (*pb.ListIpfsPathResponse, error)

ListIpfsPath returns items at a particular path in a UnixFS path living in the IPFS network.

func (*Client) ListPath

func (c *Client) ListPath(ctx context.Context, key, pth string) (*pb.ListPathResponse, error)

ListPath returns information about a bucket path.

func (*Client) PullIpfsPath

func (c *Client) PullIpfsPath(ctx context.Context, pth path.Path, writer io.Writer, opts ...Option) error

PullIpfsPath pulls the path from a remote UnixFS dag, writing it to writer if it's a file.

func (*Client) PullPath

func (c *Client) PullPath(ctx context.Context, key, pth string, writer io.Writer, opts ...Option) error

PullPath pulls the bucket path, writing it to writer if it's a file.

func (*Client) PullPathAccessRoles

func (c *Client) PullPathAccessRoles(ctx context.Context, key, pth string) (map[string]buckets.Role, error)

PullPathAccessRoles returns access roles for a path.

func (*Client) PushPath

func (c *Client) PushPath(ctx context.Context, key, pth string, reader io.Reader, opts ...Option) (result path.Resolved, root path.Resolved, err error)

PushPath pushes a file to a bucket path. This will return the resolved path and the bucket's new root path.

func (*Client) PushPathAccessRoles

func (c *Client) PushPathAccessRoles(ctx context.Context, key, pth string, roles map[string]buckets.Role) error

PushPathAccessRoles updates path access roles by merging the pushed roles with existing roles. roles is a map of string marshaled public keys to path roles. A non-nil error is returned if the map keys are not unmarshalable to public keys. To delete a role for a public key, set its value to buckets.None.

func (*Client) Remove

func (c *Client) Remove(ctx context.Context, key string) error

Remove removes an entire bucket. Files and directories will be unpinned.

func (*Client) RemovePath

func (c *Client) RemovePath(ctx context.Context, key, pth string, opts ...Option) (path.Resolved, error)

RemovePath removes the file or directory at path. Files and directories will be unpinned.

func (*Client) Root

func (c *Client) Root(ctx context.Context, key string) (*pb.RootResponse, error)

Root returns the bucket root.

func (*Client) SetDefaultArchiveConfig

func (c *Client) SetDefaultArchiveConfig(ctx context.Context, key string, config *pb.ArchiveConfig) error

SetDefaultArchiveConfig sets the default archive config for the specified Bucket.

func (*Client) SetPath

func (c *Client) SetPath(ctx context.Context, key, pth string, remoteCid cid.Cid) (*pb.SetPathResponse, error)

SetPath set a particular path to an existing IPFS UnixFS DAG.

type CreateOption

type CreateOption func(*createOptions)

func WithCid

func WithCid(c cid.Cid) CreateOption

WithCid indicates that an inited bucket should be boostraped with a particular UnixFS DAG.

func WithName

func WithName(name string) CreateOption

WithName sets a name for the bucket.

func WithPrivate

func WithPrivate(private bool) CreateOption

WithPrivate specifies that an encryption key will be used for the bucket.

type Option

type Option func(*options)

func WithFastForwardOnly

func WithFastForwardOnly(root path.Resolved) Option

WithFastForwardOnly instructs the remote to reject non-fast-forward updates by comparing root with the remote.

func WithProgress

func WithProgress(ch chan<- int64) Option

WithProgress writes progress updates to the given channel.