github.com/dolthub/dolt/go@v0.40.5-0.20240520175717-68db7794bea6/libraries/doltcore/ref/stats_ref.go (about)

     1  // Copyright 2023 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  type StatsRef struct {
    18  	stats string
    19  }
    20  
    21  var _ DoltRef = StatsRef{}
    22  
    23  // NewStatsRef creates a reference to a statistic dataset head.
    24  func NewStatsRef(branch string) StatsRef {
    25  	return StatsRef{branch}
    26  }
    27  
    28  // GetType will return StatsRefType
    29  func (br StatsRef) GetType() RefType {
    30  	return StatsRefType
    31  }
    32  
    33  // GetPath returns the name of the tag
    34  func (br StatsRef) GetPath() string {
    35  	return br.stats
    36  }
    37  
    38  // String returns the fully qualified reference name e.g. refs/heads/main
    39  func (br StatsRef) String() string {
    40  	return String(br)
    41  }