opensource/kubo
1
0
Fork 0
mirror of https://github.com/ipfs/kubo.git synced 2025-07-03 13:00:37 +08:00
Code Issues Projects Releases Wiki Activity

Doc: golint: remove stuttering in pin package

Browse Source 
License: MIT
Signed-off-by: Hector Sanjuan <hector@protocol.ai>
This commit is contained in:
Hector Sanjuan
2018-02-13 13:00:48 +01:00
parent ee7a8f3482
commit d7cd059165
2 changed files with 19 additions and 19 deletions
Download Patch File Download Diff File Expand all files Collapse all files

2
core/commands/pin.go
View File

@ -494,7 +494,7 @@ type RefKeyList struct {
func pinLsKeys(args []string, typeStr string, ctx context.Context, n *core.IpfsNode) (map[string]RefKeyObject, error) { func pinLsKeys(args []string, typeStr string, ctx context.Context, n *core.IpfsNode) (map[string]RefKeyObject, error) {
mode, ok := pin.StringToPinMode(typeStr) mode, ok := pin.StringToMode(typeStr)
if !ok { if !ok {
return nil, fmt.Errorf("invalid pin mode '%s'", typeStr) return nil, fmt.Errorf("invalid pin mode '%s'", typeStr)
} }

36
pin/pin.go
View File

@ -43,14 +43,14 @@ const (
linkAll = "all" linkAll = "all"
) )
// PinMode allows to specify different types of pin (recursive, direct etc.). // Mode allows to specify different types of pin (recursive, direct etc.).
// See the Pin Modes constants for a full list. // See the Pin Modes constants for a full list.
type PinMode int type Mode int
// Pin Modes // Pin Modes
const ( const (
// Recursive pins pin the target cids along with any reachable children. // Recursive pins pin the target cids along with any reachable children.
Recursive PinMode = iota Recursive Mode = iota
// Direct pins pin just the target cid. // Direct pins pin just the target cid.
Direct Direct
@ -68,9 +68,9 @@ const (
Any Any
) )
// PinModeToString returns a human-readable name for the PinMode. // ModeToString returns a human-readable name for the Mode.
func PinModeToString(mode PinMode) (string, bool) { func ModeToString(mode Mode) (string, bool) {
m := map[PinMode]string{ m := map[Mode]string{
Recursive: linkRecursive, Recursive: linkRecursive,
Direct: linkDirect, Direct: linkDirect,
Indirect: linkIndirect, Indirect: linkIndirect,
@ -82,10 +82,10 @@ func PinModeToString(mode PinMode) (string, bool) {
return s, ok return s, ok
} }
// StringToPinMode parses the result of PinModeToString() back to a PinMode. // StringToMode parses the result of ModeToString() back to a Mode.
// It returns a boolean which is set to false if the mode is unknown. // It returns a boolean which is set to false if the mode is unknown.
func StringToPinMode(s string) (PinMode, bool) { func StringToMode(s string) (Mode, bool) {
m := map[string]PinMode{ m := map[string]Mode{
linkRecursive: Recursive, linkRecursive: Recursive,
linkDirect: Direct, linkDirect: Direct,
linkIndirect: Indirect, linkIndirect: Indirect,
@ -109,7 +109,7 @@ type Pinner interface {
// IsPinnedWithType returns whether or not the given cid is pinned with the // IsPinnedWithType returns whether or not the given cid is pinned with the
// given pin type, as well as returning the type of pin its pinned with. // given pin type, as well as returning the type of pin its pinned with.
IsPinnedWithType(*cid.Cid, PinMode) (string, bool, error) IsPinnedWithType(*cid.Cid, Mode) (string, bool, error)
// Pin the given node, optionally recursively. // Pin the given node, optionally recursively.
Pin(ctx context.Context, node ipld.Node, recursive bool) error Pin(ctx context.Context, node ipld.Node, recursive bool) error
@ -130,12 +130,12 @@ type Pinner interface {
// PinWithMode is for manually editing the pin structure. Use with // PinWithMode is for manually editing the pin structure. Use with
// care! If used improperly, garbage collection may not be // care! If used improperly, garbage collection may not be
// successful. // successful.
PinWithMode(*cid.Cid, PinMode) PinWithMode(*cid.Cid, Mode)
// RemovePinWithMode is for manually editing the pin structure. // RemovePinWithMode is for manually editing the pin structure.
// Use with care! If used improperly, garbage collection may not // Use with care! If used improperly, garbage collection may not
// be successful. // be successful.
RemovePinWithMode(*cid.Cid, PinMode) RemovePinWithMode(*cid.Cid, Mode)
// Flush writes the pin state to the backing datastore // Flush writes the pin state to the backing datastore
Flush() error Flush() error
@ -157,7 +157,7 @@ type Pinner interface {
// by some ascendant). // by some ascendant).
type Pinned struct { type Pinned struct {
Key *cid.Cid Key *cid.Cid
Mode PinMode Mode Mode
Via *cid.Cid Via *cid.Cid
} }
@ -174,7 +174,7 @@ func (p Pinned) String() string {
case Indirect: case Indirect:
return fmt.Sprintf("pinned via %s", p.Via) return fmt.Sprintf("pinned via %s", p.Via)
default: default:
modeStr, _ := PinModeToString(p.Mode) modeStr, _ := ModeToString(p.Mode)
return fmt.Sprintf("pinned: %s", modeStr) return fmt.Sprintf("pinned: %s", modeStr)
} }
} }
@ -293,7 +293,7 @@ func (p *pinner) IsPinned(c *cid.Cid) (string, bool, error) {
// IsPinnedWithType returns whether or not the given cid is pinned with the // IsPinnedWithType returns whether or not the given cid is pinned with the
// given pin type, as well as returning the type of pin its pinned with. // given pin type, as well as returning the type of pin its pinned with.
func (p *pinner) IsPinnedWithType(c *cid.Cid, mode PinMode) (string, bool, error) { func (p *pinner) IsPinnedWithType(c *cid.Cid, mode Mode) (string, bool, error) {
p.lock.RLock() p.lock.RLock()
defer p.lock.RUnlock() defer p.lock.RUnlock()
return p.isPinnedWithType(c, mode) return p.isPinnedWithType(c, mode)
@ -301,7 +301,7 @@ func (p *pinner) IsPinnedWithType(c *cid.Cid, mode PinMode) (string, bool, error
// isPinnedWithType is the implementation of IsPinnedWithType that does not lock. // isPinnedWithType is the implementation of IsPinnedWithType that does not lock.
// intended for use by other pinned methods that already take locks // intended for use by other pinned methods that already take locks
func (p *pinner) isPinnedWithType(c *cid.Cid, mode PinMode) (string, bool, error) { func (p *pinner) isPinnedWithType(c *cid.Cid, mode Mode) (string, bool, error) {
switch mode { switch mode {
case Any, Direct, Indirect, Recursive, Internal: case Any, Direct, Indirect, Recursive, Internal:
default: default:
@ -414,7 +414,7 @@ func (p *pinner) CheckIfPinned(cids ...*cid.Cid) ([]Pinned, error) {
// RemovePinWithMode is for manually editing the pin structure. // RemovePinWithMode is for manually editing the pin structure.
// Use with care! If used improperly, garbage collection may not // Use with care! If used improperly, garbage collection may not
// be successful. // be successful.
func (p *pinner) RemovePinWithMode(c *cid.Cid, mode PinMode) { func (p *pinner) RemovePinWithMode(c *cid.Cid, mode Mode) {
p.lock.Lock() p.lock.Lock()
defer p.lock.Unlock() defer p.lock.Unlock()
switch mode { switch mode {
@ -594,7 +594,7 @@ func (p *pinner) InternalPins() []*cid.Cid {
// PinWithMode allows the user to have fine grained control over pin // PinWithMode allows the user to have fine grained control over pin
// counts // counts
func (p *pinner) PinWithMode(c *cid.Cid, mode PinMode) { func (p *pinner) PinWithMode(c *cid.Cid, mode Mode) {
p.lock.Lock() p.lock.Lock()
defer p.lock.Unlock() defer p.lock.Unlock()
switch mode { switch mode {