github.com/m3db/m3@v1.5.1-0.20231129193456-75a402aa583b/src/msg/topic/consumption_type.go (about)

     1  // Copyright (c) 2018 Uber Technologies, Inc.
     2  //
     3  // Permission is hereby granted, free of charge, to any person obtaining a copy
     4  // of this software and associated documentation files (the "Software"), to deal
     5  // in the Software without restriction, including without limitation the rights
     6  // to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
     7  // copies of the Software, and to permit persons to whom the Software is
     8  // furnished to do so, subject to the following conditions:
     9  //
    10  // The above copyright notice and this permission notice shall be included in
    11  // all copies or substantial portions of the Software.
    12  //
    13  // THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
    14  // IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
    15  // FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
    16  // AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
    17  // LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
    18  // OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
    19  // THE SOFTWARE.
    20  
    21  package topic
    22  
    23  import (
    24  	"fmt"
    25  	"strings"
    26  
    27  	"github.com/m3db/m3/src/msg/generated/proto/topicpb"
    28  )
    29  
    30  var (
    31  	validTypes = []ConsumptionType{
    32  		Shared,
    33  		Replicated,
    34  	}
    35  )
    36  
    37  func (t ConsumptionType) String() string {
    38  	return string(t)
    39  }
    40  
    41  // NewConsumptionType creates a consumption type from a string.
    42  func NewConsumptionType(str string) (ConsumptionType, error) {
    43  	var validTypeStrings []string
    44  	for _, t := range validTypes {
    45  		validStr := t.String()
    46  		if validStr == str {
    47  			return t, nil
    48  		}
    49  		validTypeStrings = append(validTypeStrings, validStr)
    50  	}
    51  	return Unknown, fmt.Errorf(
    52  		"invalid consumption type '%s', valid types are: %s", str, strings.Join(validTypeStrings, ", "),
    53  	)
    54  }
    55  
    56  // NewConsumptionTypeFromProto creates ConsumptionType from a proto.
    57  func NewConsumptionTypeFromProto(ct topicpb.ConsumptionType) (ConsumptionType, error) {
    58  	switch ct {
    59  	case topicpb.ConsumptionType_SHARED:
    60  		return Shared, nil
    61  	case topicpb.ConsumptionType_REPLICATED:
    62  		return Replicated, nil
    63  	}
    64  	return Unknown, fmt.Errorf("invalid consumption type in protobuf: %v", ct)
    65  }
    66  
    67  // ConsumptionTypeToProto creates proto from a ConsumptionType.
    68  func ConsumptionTypeToProto(ct ConsumptionType) (topicpb.ConsumptionType, error) {
    69  	switch ct {
    70  	case Shared:
    71  		return topicpb.ConsumptionType_SHARED, nil
    72  	case Replicated:
    73  		return topicpb.ConsumptionType_REPLICATED, nil
    74  	}
    75  	return topicpb.ConsumptionType_UNKNOWN, fmt.Errorf("invalid consumption type: %v", ct)
    76  }