mirror of
https://github.com/optim-enterprises-bv/kubernetes.git
synced 2025-11-04 04:08:16 +00:00
61 lines
2.0 KiB
Go
61 lines
2.0 KiB
Go
/*
|
|
Copyright 2015 The Kubernetes Authors.
|
|
|
|
Licensed under the Apache License, Version 2.0 (the "License");
|
|
you may not use this file except in compliance with the License.
|
|
You may obtain a copy of the License at
|
|
|
|
http://www.apache.org/licenses/LICENSE-2.0
|
|
|
|
Unless required by applicable law or agreed to in writing, software
|
|
distributed under the License is distributed on an "AS IS" BASIS,
|
|
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
See the License for the specific language governing permissions and
|
|
limitations under the License.
|
|
*/
|
|
|
|
package types
|
|
|
|
import (
|
|
"fmt"
|
|
"strings"
|
|
)
|
|
|
|
// NamespacedName comprises a resource name, with a mandatory namespace,
|
|
// rendered as "<namespace>/<name>". Being a type captures intent and
|
|
// helps make sure that UIDs, namespaced names and non-namespaced names
|
|
// do not get conflated in code. For most use cases, namespace and name
|
|
// will already have been format validated at the API entry point, so we
|
|
// don't do that here. Where that's not the case (e.g. in testing),
|
|
// consider using NamespacedNameOrDie() in testing.go in this package.
|
|
|
|
type NamespacedName struct {
|
|
Namespace string
|
|
Name string
|
|
}
|
|
|
|
const (
|
|
Separator = '/'
|
|
)
|
|
|
|
// String returns the general purpose string representation
|
|
func (n NamespacedName) String() string {
|
|
return fmt.Sprintf("%s%c%s", n.Namespace, Separator, n.Name)
|
|
}
|
|
|
|
// NewNamespacedNameFromString parses the provided string and returns a NamespacedName.
|
|
// The expected format is as per String() above.
|
|
// If the input string is invalid, the returned NamespacedName has all empty string field values.
|
|
// This allows a single-value return from this function, while still allowing error checks in the caller.
|
|
// Note that an input string which does not include exactly one Separator is not a valid input (as it could never
|
|
// have neem returned by String() )
|
|
func NewNamespacedNameFromString(s string) NamespacedName {
|
|
nn := NamespacedName{}
|
|
result := strings.Split(s, string(Separator))
|
|
if len(result) == 2 {
|
|
nn.Namespace = result[0]
|
|
nn.Name = result[1]
|
|
}
|
|
return nn
|
|
}
|