go.chromium.org/luci@v0.0.0-20240309015107-7cdc2e660f33/common/flag/stringslice.go (about)

     1  // Copyright 2018 The LUCI Authors.
     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 flag
    16  
    17  import (
    18  	"flag"
    19  	"strings"
    20  )
    21  
    22  // stringSliceFlag is a flag.Getter implementation representing a []string.
    23  type stringSliceFlag []string
    24  
    25  // String returns a comma-separated string representation of the flag values.
    26  func (f stringSliceFlag) String() string {
    27  	return strings.Join(f, ", ")
    28  }
    29  
    30  // Set records seeing a flag value.
    31  func (f *stringSliceFlag) Set(val string) error {
    32  	*f = append(*f, val)
    33  	return nil
    34  }
    35  
    36  // Get retrieves the flag value.
    37  func (f stringSliceFlag) Get() any {
    38  	return []string(f)
    39  }
    40  
    41  // StringSlice returns a flag.Getter which reads flags into the given []string pointer.
    42  func StringSlice(s *[]string) flag.Getter {
    43  	return (*stringSliceFlag)(s)
    44  }