Skip to content

Commit

Permalink
Rename ProcCidBase to GetCidEncoder.
Browse files Browse the repository at this point in the history
License: MIT
Signed-off-by: Kevin Atkinson <k@kevina.org>
  • Loading branch information
kevina committed Dec 12, 2018
1 parent c51d55b commit a828b60
Show file tree
Hide file tree
Showing 13 changed files with 32 additions and 32 deletions.
2 changes: 1 addition & 1 deletion core/commands/add.go
Original file line number Diff line number Diff line change
Expand Up @@ -168,7 +168,7 @@ You can now check what blocks have been created by:
return fmt.Errorf("unrecognized hash function: %s", strings.ToLower(hashFunStr))
}

enc, err := cmdenv.ProcCidBase(req)
enc, err := cmdenv.GetCidEncoder(req)
if err != nil {
return err
}
Expand Down
4 changes: 2 additions & 2 deletions core/commands/bitswap.go
Original file line number Diff line number Diff line change
Expand Up @@ -74,7 +74,7 @@ Print out all blocks currently on the bitswap wantlist for the local peer.`,
},
Encoders: cmds.EncoderMap{
cmds.Text: cmds.MakeTypedEncoder(func(req *cmds.Request, w io.Writer, out *KeyList) error {
enc, err := cmdenv.ProcCidBaseLowLevel(req)
enc, err := cmdenv.GetLowLevelCidEncoder(req)
if err != nil {
return err
}
Expand Down Expand Up @@ -118,7 +118,7 @@ var bitswapStatCmd = &cmds.Command{
},
Encoders: cmds.EncoderMap{
cmds.Text: cmds.MakeTypedEncoder(func(req *cmds.Request, w io.Writer, s *bitswap.Stat) error {
enc, err := cmdenv.ProcCidBaseLowLevel(req)
enc, err := cmdenv.GetLowLevelCidEncoder(req)
if err != nil {
return err
}
Expand Down
16 changes: 8 additions & 8 deletions core/commands/cmdenv/cidbase.go
Original file line number Diff line number Diff line change
Expand Up @@ -11,20 +11,20 @@ import (
var OptionCidBase = cmdkit.StringOption("cid-base", "Multibase encoding used for version 1 CIDs in output.")
var OptionOutputCidV1 = cmdkit.BoolOption("output-cidv1", "Upgrade CID version 0 to version 1 in output.")

// ProcCidBase processes the `cid-base` and `output-cidv1` options and
// GetCidEncoder processes the `cid-base` and `output-cidv1` options and
// returns a encoder to use based on those parameters.
func ProcCidBase(req *cmds.Request) (cidenc.Encoder, error) {
return procCidBase(req, true)
func GetCidEncoder(req *cmds.Request) (cidenc.Encoder, error) {
return getCidBase(req, true)
}

// ProcCidBaseNoUpgrade is like ProcCidBase but meant to be used by
// lower level commands. It differs from ProcCidBase in that CIDv0
// GetLowLevelCidEncoder is like GetCidEncoder but meant to be used by
// lower level commands. It differs from GetCidEncoder in that CIDv0
// and not, by default, auto-upgraded to CIDv1.
func ProcCidBaseLowLevel(req *cmds.Request) (cidenc.Encoder, error) {
return procCidBase(req, false)
func GetLowLevelCidEncoder(req *cmds.Request) (cidenc.Encoder, error) {
return getCidBase(req, false)
}

func procCidBase(req *cmds.Request, autoUpgrade bool) (cidenc.Encoder, error) {
func getCidBase(req *cmds.Request, autoUpgrade bool) (cidenc.Encoder, error) {
base, _ := req.Options["cid-base"].(string)
upgrade, upgradeDefined := req.Options["output-cidv1"].(bool)

Expand Down
4 changes: 2 additions & 2 deletions core/commands/dag/dag.go
Original file line number Diff line number Diff line change
Expand Up @@ -143,7 +143,7 @@ into an object of the specified format.
Type: OutputObject{},
Encoders: cmds.EncoderMap{
cmds.Text: cmds.MakeTypedEncoder(func(req *cmds.Request, w io.Writer, out *OutputObject) error {
enc, err := cmdenv.ProcCidBaseLowLevel(req)
enc, err := cmdenv.GetLowLevelCidEncoder(req)
if err != nil {
return err
}
Expand Down Expand Up @@ -230,7 +230,7 @@ var DagResolveCmd = &cmds.Command{
},
Encoders: cmds.EncoderMap{
cmds.Text: cmds.MakeTypedEncoder(func(req *cmds.Request, w io.Writer, out *ResolveOutput) error {
enc, err := cmdenv.ProcCidBaseLowLevel(req)
enc, err := cmdenv.GetLowLevelCidEncoder(req)
if err != nil {
return err
}
Expand Down
4 changes: 2 additions & 2 deletions core/commands/files.go
Original file line number Diff line number Diff line change
Expand Up @@ -137,7 +137,7 @@ var filesStatCmd = &cmds.Command{

withLocal, _ := req.Options[filesWithLocalOptionName].(bool)

enc, err := cmdenv.ProcCidBase(req)
enc, err := cmdenv.GetCidEncoder(req)
if err != nil {
return err
}
Expand Down Expand Up @@ -439,7 +439,7 @@ Examples:

long, _ := req.Options[longOptionName].(bool)

enc, err := cmdenv.ProcCidBase(req)
enc, err := cmdenv.GetCidEncoder(req)
if err != nil {
return err
}
Expand Down
6 changes: 3 additions & 3 deletions core/commands/filestore.go
Original file line number Diff line number Diff line change
Expand Up @@ -80,7 +80,7 @@ The output is:
},
PostRun: cmds.PostRunMap{
cmds.CLI: func(res cmds.Response, re cmds.ResponseEmitter) error {
enc, err := cmdenv.ProcCidBase(res.Request())
enc, err := cmdenv.GetCidEncoder(res.Request())
if err != nil {
return err
}
Expand Down Expand Up @@ -157,7 +157,7 @@ For ERROR entries the error will also be printed to stderr.
},
PostRun: cmds.PostRunMap{
cmds.CLI: func(res cmds.Response, re cmds.ResponseEmitter) error {
enc, err := cmdenv.ProcCidBase(res.Request())
enc, err := cmdenv.GetCidEncoder(res.Request())
if err != nil {
return err
}
Expand Down Expand Up @@ -196,7 +196,7 @@ var dupsFileStore = &cmds.Command{
return err
}

enc, err := cmdenv.ProcCidBase(req)
enc, err := cmdenv.GetCidEncoder(req)
if err != nil {
return err
}
Expand Down
2 changes: 1 addition & 1 deletion core/commands/ls.go
Original file line number Diff line number Diff line change
Expand Up @@ -94,7 +94,7 @@ The JSON output contains type information.
}
paths := req.Arguments

enc, err := cmdenv.ProcCidBase(req)
enc, err := cmdenv.GetCidEncoder(req)
if err != nil {
return err
}
Expand Down
10 changes: 5 additions & 5 deletions core/commands/object/object.go
Original file line number Diff line number Diff line change
Expand Up @@ -119,7 +119,7 @@ multihash.
return err
}

enc, err := cmdenv.ProcCidBaseLowLevel(req)
enc, err := cmdenv.GetLowLevelCidEncoder(req)
if err != nil {
return err
}
Expand Down Expand Up @@ -214,7 +214,7 @@ Supported values are:
return err
}

enc, err := cmdenv.ProcCidBaseLowLevel(req)
enc, err := cmdenv.GetLowLevelCidEncoder(req)
if err != nil {
return err
}
Expand Down Expand Up @@ -309,7 +309,7 @@ var ObjectStatCmd = &cmds.Command{
return err
}

enc, err := cmdenv.ProcCidBaseLowLevel(req)
enc, err := cmdenv.GetLowLevelCidEncoder(req)
if err != nil {
return err
}
Expand Down Expand Up @@ -406,7 +406,7 @@ And then run:
return err
}

enc, err := cmdenv.ProcCidBaseLowLevel(req)
enc, err := cmdenv.GetLowLevelCidEncoder(req)
if err != nil {
return err
}
Expand Down Expand Up @@ -484,7 +484,7 @@ Available templates:
return err
}

enc, err := cmdenv.ProcCidBaseLowLevel(req)
enc, err := cmdenv.GetLowLevelCidEncoder(req)
if err != nil {
return err
}
Expand Down
8 changes: 4 additions & 4 deletions core/commands/pin.go
Original file line number Diff line number Diff line change
Expand Up @@ -88,7 +88,7 @@ var addPinCmd = &cmds.Command{
return err
}

enc, err := cmdenv.ProcCidBase(req)
enc, err := cmdenv.GetCidEncoder(req)
if err != nil {
return err
}
Expand Down Expand Up @@ -221,7 +221,7 @@ collected if needed. (By default, recursively. Use -r=false for direct pins.)
return err
}

enc, err := cmdenv.ProcCidBase(req)
enc, err := cmdenv.GetCidEncoder(req)
if err != nil {
return err
}
Expand Down Expand Up @@ -322,7 +322,7 @@ Example:
return err
}

enc, err := cmdenv.ProcCidBase(req)
enc, err := cmdenv.GetCidEncoder(req)
if err != nil {
return err
}
Expand Down Expand Up @@ -443,7 +443,7 @@ var verifyPinCmd = &cmds.Command{
return fmt.Errorf("the --verbose and --quiet options can not be used at the same time")
}

enc, err := cmdenv.ProcCidBase(req)
enc, err := cmdenv.GetCidEncoder(req)
if err != nil {
return err
}
Expand Down
2 changes: 1 addition & 1 deletion core/commands/refs.go
Original file line number Diff line number Diff line change
Expand Up @@ -80,7 +80,7 @@ NOTE: List all references recursively by using the flag '-r'.
return err
}

enc, err := cmdenv.ProcCidBase(req)
enc, err := cmdenv.GetCidEncoder(req)
if err != nil {
return err
}
Expand Down
2 changes: 1 addition & 1 deletion core/commands/resolve.go
Original file line number Diff line number Diff line change
Expand Up @@ -94,7 +94,7 @@ Resolve the value of an IPFS DAG path:
name := req.Arguments[0]
recursive, _ := req.Options[resolveRecursiveOptionName].(bool)

enc, err := cmdenv.ProcCidBase(req)
enc, err := cmdenv.GetCidEncoder(req)
if err != nil {
return err
}
Expand Down
2 changes: 1 addition & 1 deletion core/commands/tar.go
Original file line number Diff line number Diff line change
Expand Up @@ -44,7 +44,7 @@ represent it.
return err
}

enc, err := cmdenv.ProcCidBase(req)
enc, err := cmdenv.GetCidEncoder(req)
if err != nil {
return err
}
Expand Down
2 changes: 1 addition & 1 deletion core/commands/urlstore.go
Original file line number Diff line number Diff line change
Expand Up @@ -74,7 +74,7 @@ time.

useTrickledag, _ := req.Options[trickleOptionName].(bool)

enc, err := cmdenv.ProcCidBase(req)
enc, err := cmdenv.GetCidEncoder(req)
if err != nil {
return err
}
Expand Down

0 comments on commit a828b60

Please sign in to comment.