Documentation ¶
Index ¶
- Constants
- Variables
- type AddOption
- type Client
- func (c *Client) Add(ctx context.Context, cid cid.Cid, opts ...AddOption) (PinStatusGetter, error)
- func (c *Client) DeleteByID(ctx context.Context, pinID string) error
- func (c *Client) GetStatusByID(ctx context.Context, pinID string) (PinStatusGetter, error)
- func (c *Client) Ls(ctx context.Context, opts ...LsOption) (chan PinStatusGetter, chan error)
- func (c *Client) LsSync(ctx context.Context, opts ...LsOption) ([]PinStatusGetter, error)
- func (c *Client) Modify(ctx context.Context, pinID string, cid cid.Cid, opts ...AddOption) (PinStatusGetter, error)
- type LsOption
- type PinGetter
- type PinStatusGetter
- type Status
Constants ¶
View Source
const UserAgent = "go-pinning-service-http-client"
Variables ¶
View Source
var PinOpts = pinOpts{}
Functions ¶
This section is empty.
Types ¶
type Client ¶
type Client struct {
// contains filtered or unexported fields
}
func (*Client) GetStatusByID ¶
type PinGetter ¶
type PinGetter interface { fmt.Stringer json.Marshaler // CID to be pinned recursively GetCid() cid.Cid // Optional name for pinned data; can be used for lookups later GetName() string // Optional list of multiaddrs known to provide the data GetOrigins() []string // Optional metadata for pin object GetMeta() map[string]string }
PinGetter Getter for Pin object
type PinStatusGetter ¶
type PinStatusGetter interface { fmt.Stringer json.Marshaler // Globally unique ID of the pin request; can be used to check the status of ongoing pinning, modification of pin object, or pin removal GetRequestId() string GetStatus() Status // Immutable timestamp indicating when a pin request entered a pinning service; can be used for filtering results and pagination GetCreated() time.Time GetPin() PinGetter // List of multiaddrs designated by pinning service for transferring any new data from external peers GetDelegates() []multiaddr.Multiaddr // Optional info for PinStatus response GetInfo() map[string]string }
PinStatusGetter Getter for Pin object with status
Click to show internal directories.
Click to hide internal directories.