github.com/hasnat/dolt/go@v0.0.0-20210628190320-9eb5d843fbb7/libraries/doltcore/ref/internal_ref.go (about)

     1  // Copyright 2019 Dolthub, Inc.
     2  //
     3  // Licensed under the Apache License, Version 2.0 (the "License");
     4  // you may not use this file except in compliance with the License.
     5  // You may obtain a copy of the License at
     6  //
     7  //     http://www.apache.org/licenses/LICENSE-2.0
     8  //
     9  // Unless required by applicable law or agreed to in writing, software
    10  // distributed under the License is distributed on an "AS IS" BASIS,
    11  // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
    12  // See the License for the specific language governing permissions and
    13  // limitations under the License.
    14  
    15  package ref
    16  
    17  import "strings"
    18  
    19  // InternalRef is a dolt internal reference
    20  type InternalRef struct {
    21  	path string
    22  }
    23  
    24  // GetType returns InternalRefType
    25  func (ir InternalRef) GetType() RefType {
    26  	return InternalRefType
    27  }
    28  
    29  // GetPath returns the name of the internal reference
    30  func (ir InternalRef) GetPath() string {
    31  	return ir.path
    32  }
    33  
    34  // String returns the fully qualified reference e.g. refs/internal/create
    35  func (ir InternalRef) String() string {
    36  	return String(ir)
    37  }
    38  
    39  // NewInternalRef creates an internal ref
    40  func NewInternalRef(name string) DoltRef {
    41  	if IsRef(name) {
    42  		prefix := PrefixForType(InternalRefType)
    43  		if strings.HasPrefix(name, prefix) {
    44  			name = name[len(prefix):]
    45  		} else {
    46  			panic(name + " is a ref that is not of type " + prefix)
    47  		}
    48  	}
    49  
    50  	return InternalRef{name}
    51  }