Documentation
¶
Index ¶
- func ValidateDescription(description string) error
- func ValidateID(name string) error
- type Display
- type Duration
- func (d Duration) MarshalJSON() ([]byte, error)
- func (d *Duration) MarshalText() ([]byte, error)
- func (d Duration) MarshalYAML() (any, error)
- func (d *Duration) Set(s string) error
- func (d Duration) String() string
- func (d *Duration) Type() string
- func (d *Duration) UnmarshalJSON(bytes []byte) error
- func (d *Duration) UnmarshalText(text []byte) error
- func (d *Duration) UnmarshalYAML(unmarshal func(any) error) error
- type DurationString
- type JSONRef
- type Regexp
- type URL
- func (u *URL) IsNilOrEmpty() bool
- func (u URL) MarshalJSON() ([]byte, error)
- func (u *URL) MarshalText() ([]byte, error)
- func (u URL) MarshalYAML() (any, error)
- func (u *URL) String() string
- func (u *URL) UnmarshalJSON(data []byte) error
- func (u *URL) UnmarshalText(text []byte) error
- func (u *URL) UnmarshalYAML(unmarshal func(any) error) error
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
func ValidateDescription ¶
ValidateDescription checks for forbidden items in substring used inside description
func ValidateID ¶
ValidateID checks for forbidden items in substring used inside id
Types ¶
type Duration ¶
Duration wraps time.Duration. It is used to parse the custom duration format from YAML. This type should not propagate beyond the scope of input/output processing. +kubebuilder:validation:Type=string +kubebuilder:validation:Format=duration +kubebuilder:validation:Pattern=`^(([0-9]+)y)?(([0-9]+)w)?(([0-9]+)d)?(([0-9]+)h)?(([0-9]+)m)?(([0-9]+)s)?(([0-9]+)ms)?$`
func ParseDuration ¶
ParseDuration parses a string into a time.Duration, assuming that a year always has 365d, a week always has 7d, and a day always has 24h.
func (Duration) MarshalJSON ¶
MarshalJSON implements the json.Marshaler interface.
func (*Duration) MarshalText ¶
MarshalText implements the encoding.TextMarshaler interface.
func (Duration) MarshalYAML ¶
MarshalYAML implements the yaml.Marshaler interface.
func (*Duration) UnmarshalJSON ¶
UnmarshalJSON implements the json.Unmarshaler interface.
func (*Duration) UnmarshalText ¶
UnmarshalText implements the encoding.TextUnmarshaler interface.
type DurationString ¶
type DurationString string
DurationString is a string that represents a duration, such as "1h", "30m", "15s", etc. It is used to unmarshal a duration string from JSON or YAML, and validate that it is a valid duration string.
Not converting the duration string into a time.Duration type allows us to avoid the issue of changing the initial input with an alias. This is something that happens when we use Duration type, because when the duration is unmarshalled then marshaled again, the input can be changed with an equivalent duration. For example "14d" will be changed to "2w".
So, use DurationString instead of Duration when you want to preserve the original input string. If, for any reason, you need to convert the DurationString to a time.Duration, you can use the ParseDuration function.
+kubebuilder:validation:Type=string +kubebuilder:validation:Format=duration +kubebuilder:validation:Pattern=`^(([0-9]+)y)?(([0-9]+)w)?(([0-9]+)d)?(([0-9]+)h)?(([0-9]+)m)?(([0-9]+)s)?(([0-9]+)ms)?$`
func (*DurationString) UnmarshalJSON ¶
func (d *DurationString) UnmarshalJSON(bytes []byte) error
func (*DurationString) UnmarshalYAML ¶
func (d *DurationString) UnmarshalYAML(unmarshal func(any) error) error
type JSONRef ¶
type JSONRef struct {
// Ref is the JSON reference.
// That's the only thing used during the marshalling / unmarshalling process.
// Other attributes are ignored during these processes.
Ref string `json:"$ref" yaml:"$ref"`
// Path is a list of string that will be used to find from the root of the struct the object pointed.
Path []string `json:"-" yaml:"-"`
// Object will contain the pointer to the actual object referenced by Ref
Object any `json:"-" yaml:"-"`
}
func (*JSONRef) UnmarshalJSON ¶
type Regexp ¶
Regexp encapsulates a regexp.Regexp and makes it JSON/YAML marshalable.
func MustNewRegexp ¶
MustNewRegexp works like NewRegexp, but panics if the regular expression does not compile.
func NewRegexp ¶
NewRegexp creates a new anchored Regexp and returns an error if the passed-in regular expression does not compile.
func (Regexp) MarshalJSON ¶
func (Regexp) MarshalYAML ¶
func (*Regexp) UnmarshalJSON ¶
type URL ¶
+kubebuilder:validation:Schemaless +kubebuilder:validation:Type=string +kubebuilder:validation:Format=uri
func MustParseURL ¶
func (*URL) IsNilOrEmpty ¶
func (URL) MarshalJSON ¶
MarshalJSON implements the json.Marshaler interface for URL.
func (*URL) MarshalText ¶
MarshalText implements the encoding.TextMarshaler interface.
func (URL) MarshalYAML ¶
MarshalYAML implements the yaml.Marshaler interface for URLs.
func (*URL) UnmarshalJSON ¶
UnmarshalJSON implements the json.Marshaler interface for URL.
func (*URL) UnmarshalText ¶
UnmarshalText implements the encoding.TextUnmarshaler interface.
Source Files