strfmt

package
v0.0.0-...-589584f Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Sep 10, 2025 License: Apache-2.0, Apache-2.0 Imports: 15 Imported by: 27

Documentation

Overview

Package strfmt contains custom string formats

TODO: add info on how to define and register a custom format

Index

Constants

View Source 
const (
	// HostnamePattern http://json-schema.org/latest/json-schema-validation.html#anchor114
	//  A string instance is valid against this attribute if it is a valid
	//  representation for an Internet host name, as defined by RFC 1034, section 3.1 [RFC1034].
	//  http://tools.ietf.org/html/rfc1034#section-3.5
	//  <digit> ::= any one of the ten digits 0 through 9
	//  var digit = /[0-9]/;
	//  <letter> ::= any one of the 52 alphabetic characters A through Z in upper case and a through z in lower case
	//  var letter = /[a-zA-Z]/;
	//  <let-dig> ::= <letter> | <digit>
	//  var letDig = /[0-9a-zA-Z]/;
	//  <let-dig-hyp> ::= <let-dig> | "-"
	//  var letDigHyp = /[-0-9a-zA-Z]/;
	//  <ldh-str> ::= <let-dig-hyp> | <let-dig-hyp> <ldh-str>
	//  var ldhStr = /[-0-9a-zA-Z]+/;
	//  <label> ::= <letter> [ [ <ldh-str> ] <let-dig> ]
	//  var label = /[a-zA-Z](([-0-9a-zA-Z]+)?[0-9a-zA-Z])?/;
	//  <subdomain> ::= <label> | <subdomain> "." <label>
	//  var subdomain = /^[a-zA-Z](([-0-9a-zA-Z]+)?[0-9a-zA-Z])?(\.[a-zA-Z](([-0-9a-zA-Z]+)?[0-9a-zA-Z])?)*$/;
	//  <domain> ::= <subdomain> | " "
	//
	// Additional validations:
	//   - for FDQNs, top-level domain (e.g. ".com"), is at least to letters long (no special characters here)
	//   - hostnames may start with a digit [RFC1123]
	//   - special registered names with an underscore ('_') are not allowed in this context
	//   - dashes are permitted, but not at the start or the end of a segment
	//   - long top-level domain names (e.g. example.london) are permitted
	//   - symbol unicode points are permitted (e.g. emoji) (not for top-level domain)
	HostnamePattern = `` /* 166-byte string literal not displayed */
	// UUIDPattern Regex for UUID that allows uppercase
	UUIDPattern = `(?i)^[0-9a-f]{8}-?[0-9a-f]{4}-?[0-9a-f]{4}-?[0-9a-f]{4}-?[0-9a-f]{12}$`
	// UUID3Pattern Regex for UUID3 that allows uppercase
	UUID3Pattern = `(?i)^[0-9a-f]{8}-?[0-9a-f]{4}-?3[0-9a-f]{3}-?[0-9a-f]{4}-?[0-9a-f]{12}$`
	// UUID4Pattern Regex for UUID4 that allows uppercase
	UUID4Pattern = `(?i)^[0-9a-f]{8}-?[0-9a-f]{4}-?4[0-9a-f]{3}-?[89ab][0-9a-f]{3}-?[0-9a-f]{12}$`
	// UUID5Pattern Regex for UUID5 that allows uppercase
	UUID5Pattern = `(?i)^[0-9a-f]{8}-?[0-9a-f]{4}-?5[0-9a-f]{3}-?[89ab][0-9a-f]{3}-?[0-9a-f]{12}$`
)
View Source 
const (
	// RFC3339Millis represents a ISO8601 format to millis instead of to nanos
	RFC3339Millis = "2006-01-02T15:04:05.000Z07:00"
	// RFC3339Micro represents a ISO8601 format to micro instead of to nano
	RFC3339Micro = "2006-01-02T15:04:05.000000Z07:00"
	// ISO8601LocalTime represents a ISO8601 format to ISO8601 in local time (no timezone)
	ISO8601LocalTime = "2006-01-02T15:04:05"
	// DateTimePattern pattern to match for the date-time format from http://tools.ietf.org/html/rfc3339#section-5.6
	DateTimePattern = `^([0-9]{2}):([0-9]{2}):([0-9]{2})(.[0-9]+)?(z|([+-][0-9]{2}:[0-9]{2}))$`
)
View Source 
const LongNameMaxLength int = 253

LongNameMaxLength is a subdomain's max length in DNS (RFC 1123)

View Source 
const (
	// RFC3339FullDate represents a full-date as specified by RFC3339
	// See: http://goo.gl/xXOvVd
	RFC3339FullDate = "2006-01-02"
)
View Source 
const ShortNameMaxLength int = 63

ShortNameMaxLength is a label's max length in DNS (RFC 1123)

Variables

View Source 
var Default = NewSeededFormats(nil, nil)

Default is the default formats registry

View Source 
var (

	// MarshalFormat sets the time resolution format used for marshaling time (set to milliseconds)
	MarshalFormat = RFC3339Millis
)

Functions

func DefaultNameNormalizer 

func DefaultNameNormalizer(name string) string

DefaultNameNormalizer removes all dashes

func IsBSONObjectID 

func IsBSONObjectID(str string) bool

IsBSONObjectID returns true when the string is a valid BSON.ObjectId

func IsDate 

func IsDate(str string) bool

IsDate returns true when the string is a valid date

func IsDateTime 

func IsDateTime(str string) bool

IsDateTime returns true when the string is a valid date-time

func IsDuration 

func IsDuration(str string) bool

IsDuration returns true if the provided string is a valid duration

func IsEmail 

func IsEmail(str string) bool

IsEmail validates an email address.

func IsHostname 

func IsHostname(str string) bool

IsHostname returns true when the string is a valid hostname

func IsLongName 

func IsLongName(value string) bool

IsLongName checks if a string is a valid LongName.

func IsShortName 

func IsShortName(value string) bool

IsShortName checks if a string is a valid ShortName.

func IsUUID 

func IsUUID(str string) bool

IsUUID returns true is the string matches a UUID, upper case is allowed

func IsUUID3 

func IsUUID3(str string) bool

IsUUID3 returns true is the string matches a UUID, upper case is allowed

func IsUUID4 

func IsUUID4(str string) bool

IsUUID4 returns true is the string matches a UUID, upper case is allowed

func IsUUID5 

func IsUUID5(str string) bool

IsUUID5 returns true is the string matches a UUID, upper case is allowed

func ParseDuration 

func ParseDuration(cand string) (time.Duration, error)

ParseDuration parses a duration from a string, compatible with scala duration syntax

Types

type Base64 

type Base64 []byte

Base64 represents a base64 encoded string, using URLEncoding alphabet

swagger:strfmt byte

func (*Base64) DeepCopy 

func (b *Base64) DeepCopy() *Base64

DeepCopy copies the receiver into a new Base64.

func (*Base64) DeepCopyInto 

func (b *Base64) DeepCopyInto(out *Base64)

DeepCopyInto copies the receiver and writes its value into out.

func (Base64) MarshalJSON 

func (b Base64) MarshalJSON() ([]byte, error)

MarshalJSON returns the Base64 as JSON

func (Base64) MarshalText 

func (b Base64) MarshalText() ([]byte, error)

MarshalText turns this instance into text

func (Base64) String 

func (b Base64) String() string

func (*Base64) UnmarshalJSON 

func (b *Base64) UnmarshalJSON(data []byte) error

UnmarshalJSON sets the Base64 from JSON

func (*Base64) UnmarshalText 

func (b *Base64) UnmarshalText(data []byte) error

UnmarshalText hydrates this instance from text

type CIDR 

type CIDR string

CIDR represents a Classless Inter-Domain Routing notation

swagger:strfmt cidr

func (*CIDR) DeepCopy 

func (u *CIDR) DeepCopy() *CIDR

DeepCopy copies the receiver into a new CIDR.

func (*CIDR) DeepCopyInto 

func (u *CIDR) DeepCopyInto(out *CIDR)

DeepCopyInto copies the receiver and writes its value into out.

func (CIDR) MarshalJSON 

func (u CIDR) MarshalJSON() ([]byte, error)

MarshalJSON returns the CIDR as JSON

func (CIDR) MarshalText 

func (u CIDR) MarshalText() ([]byte, error)

MarshalText turns this instance into text

func (CIDR) String 

func (u CIDR) String() string

func (*CIDR) UnmarshalJSON 

func (u *CIDR) UnmarshalJSON(data []byte) error

UnmarshalJSON sets the CIDR from JSON

func (*CIDR) UnmarshalText 

func (u *CIDR) UnmarshalText(data []byte) error

UnmarshalText hydrates this instance from text

type CreditCard 

type CreditCard string

CreditCard represents a credit card string format

swagger:strfmt creditcard

func (*CreditCard) DeepCopy 

func (u *CreditCard) DeepCopy() *CreditCard

DeepCopy copies the receiver into a new CreditCard.

func (*CreditCard) DeepCopyInto 

func (u *CreditCard) DeepCopyInto(out *CreditCard)

DeepCopyInto copies the receiver and writes its value into out.

func (CreditCard) MarshalJSON 

func (u CreditCard) MarshalJSON() ([]byte, error)

MarshalJSON returns the CreditCard as JSON

func (CreditCard) MarshalText 

func (u CreditCard) MarshalText() ([]byte, error)

MarshalText turns this instance into text

func (CreditCard) String 

func (u CreditCard) String() string

func (*CreditCard) UnmarshalJSON 

func (u *CreditCard) UnmarshalJSON(data []byte) error

UnmarshalJSON sets the CreditCard from JSON

func (*CreditCard) UnmarshalText 

func (u *CreditCard) UnmarshalText(data []byte) error

UnmarshalText hydrates this instance from text

type Date 

type Date time.Time

Date represents a date from the API

swagger:strfmt date

func (*Date) DeepCopy 

func (d *Date) DeepCopy() *Date

DeepCopy copies the receiver into a new Date.

func (*Date) DeepCopyInto 

func (d *Date) DeepCopyInto(out *Date)

DeepCopyInto copies the receiver and writes its value into out.

func (Date) MarshalJSON 

func (d Date) MarshalJSON() ([]byte, error)

MarshalJSON returns the Date as JSON

func (Date) MarshalText 

func (d Date) MarshalText() ([]byte, error)

MarshalText serializes this date type to string

func (Date) String 

func (d Date) String() string

String converts this date into a string

func (*Date) UnmarshalJSON 

func (d *Date) UnmarshalJSON(data []byte) error

UnmarshalJSON sets the Date from JSON

func (*Date) UnmarshalText 

func (d *Date) UnmarshalText(text []byte) error

UnmarshalText parses a text representation into a date type

type DateTime 

type DateTime time.Time

DateTime is a time but it serializes to ISO8601 format with millis It knows how to read 3 different variations of a RFC3339 date time. Most APIs we encounter want either millisecond or second precision times. This just tries to make it worry-free.

swagger:strfmt date-time

func NewDateTime 

func NewDateTime() DateTime

NewDateTime is a representation of zero value for DateTime type

func ParseDateTime 

func ParseDateTime(data string) (DateTime, error)

ParseDateTime parses a string that represents an ISO8601 time or a unix epoch

func (*DateTime) DeepCopy 

func (t *DateTime) DeepCopy() *DateTime

DeepCopy copies the receiver into a new DateTime.

func (*DateTime) DeepCopyInto 

func (t *DateTime) DeepCopyInto(out *DateTime)

DeepCopyInto copies the receiver and writes its value into out.

func (DateTime) MarshalJSON 

func (t DateTime) MarshalJSON() ([]byte, error)

MarshalJSON returns the DateTime as JSON

func (DateTime) MarshalText 

func (t DateTime) MarshalText() ([]byte, error)

MarshalText implements the text marshaller interface

func (DateTime) String 

func (t DateTime) String() string

String converts this time to a string

func (*DateTime) UnmarshalJSON 

func (t *DateTime) UnmarshalJSON(data []byte) error

UnmarshalJSON sets the DateTime from JSON

func (*DateTime) UnmarshalText 

func (t *DateTime) UnmarshalText(text []byte) error

UnmarshalText implements the text unmarshaller interface

type Duration 

type Duration time.Duration

Duration represents a duration

Duration stores a period of time as a nanosecond count, with the largest repesentable duration being approximately 290 years.

swagger:strfmt duration

func (*Duration) DeepCopy 

func (d *Duration) DeepCopy() *Duration

DeepCopy copies the receiver into a new Duration.

func (*Duration) DeepCopyInto 

func (d *Duration) DeepCopyInto(out *Duration)

DeepCopyInto copies the receiver and writes its value into out.

func (Duration) MarshalJSON 

func (d Duration) MarshalJSON() ([]byte, error)

MarshalJSON returns the Duration as JSON

func (Duration) MarshalText 

func (d Duration) MarshalText() ([]byte, error)

MarshalText turns this instance into text

func (Duration) String 

func (d Duration) String() string

String converts this duration to a string

func (*Duration) UnmarshalJSON 

func (d *Duration) UnmarshalJSON(data []byte) error

UnmarshalJSON sets the Duration from JSON

func (*Duration) UnmarshalText 

func (d *Duration) UnmarshalText(data []byte) error

UnmarshalText hydrates this instance from text

type Email 

type Email string

Email represents the email string format as specified by the json schema spec

swagger:strfmt email

func (*Email) DeepCopy 

func (e *Email) DeepCopy() *Email

DeepCopy copies the receiver into a new Email.

func (*Email) DeepCopyInto 

func (e *Email) DeepCopyInto(out *Email)

DeepCopyInto copies the receiver and writes its value into out.

func (Email) MarshalJSON 

func (e Email) MarshalJSON() ([]byte, error)

MarshalJSON returns the Email as JSON

func (Email) MarshalText 

func (e Email) MarshalText() ([]byte, error)

MarshalText turns this instance into text

func (Email) String 

func (e Email) String() string

func (*Email) UnmarshalJSON 

func (e *Email) UnmarshalJSON(data []byte) error

UnmarshalJSON sets the Email from JSON

func (*Email) UnmarshalText 

func (e *Email) UnmarshalText(data []byte) error

UnmarshalText hydrates this instance from text

type Format 

type Format interface {
	String() string
	encoding.TextMarshaler
	encoding.TextUnmarshaler
}

Format represents a string format.

All implementations of Format provide a string representation and text marshaling/unmarshaling interface to be used by encoders (e.g. encoding/json).

type HexColor 

type HexColor string

HexColor represents a hex color string format

swagger:strfmt hexcolor

func (*HexColor) DeepCopy 

func (h *HexColor) DeepCopy() *HexColor

DeepCopy copies the receiver into a new HexColor.

func (*HexColor) DeepCopyInto 

func (h *HexColor) DeepCopyInto(out *HexColor)

DeepCopyInto copies the receiver and writes its value into out.

func (HexColor) MarshalJSON 

func (h HexColor) MarshalJSON() ([]byte, error)

MarshalJSON returns the HexColor as JSON

func (HexColor) MarshalText 

func (h HexColor) MarshalText() ([]byte, error)

MarshalText turns this instance into text

func (HexColor) String 

func (h HexColor) String() string

func (*HexColor) UnmarshalJSON 

func (h *HexColor) UnmarshalJSON(data []byte) error

UnmarshalJSON sets the HexColor from JSON

func (*HexColor) UnmarshalText 

func (h *HexColor) UnmarshalText(data []byte) error

UnmarshalText hydrates this instance from text

type Hostname 

type Hostname string

Hostname represents the hostname string format as specified by the json schema spec

swagger:strfmt hostname

func (*Hostname) DeepCopy 

func (h *Hostname) DeepCopy() *Hostname

DeepCopy copies the receiver into a new Hostname.

func (*Hostname) DeepCopyInto 

func (h *Hostname) DeepCopyInto(out *Hostname)

DeepCopyInto copies the receiver and writes its value into out.

func (Hostname) MarshalJSON 

func (h Hostname) MarshalJSON() ([]byte, error)

MarshalJSON returns the Hostname as JSON

func (Hostname) MarshalText 

func (h Hostname) MarshalText() ([]byte, error)

MarshalText turns this instance into text

func (Hostname) String 

func (h Hostname) String() string

func (*Hostname) UnmarshalJSON 

func (h *Hostname) UnmarshalJSON(data []byte) error

UnmarshalJSON sets the Hostname from JSON

func (*Hostname) UnmarshalText 

func (h *Hostname) UnmarshalText(data []byte) error

UnmarshalText hydrates this instance from text

type IPv4 

type IPv4 string

IPv4 represents an IP v4 address

swagger:strfmt ipv4

func (*IPv4) DeepCopy 

func (u *IPv4) DeepCopy() *IPv4

DeepCopy copies the receiver into a new IPv4.

func (*IPv4) DeepCopyInto 

func (u *IPv4) DeepCopyInto(out *IPv4)

DeepCopyInto copies the receiver and writes its value into out.

func (IPv4) MarshalJSON 

func (u IPv4) MarshalJSON() ([]byte, error)

MarshalJSON returns the IPv4 as JSON

func (IPv4) MarshalText 

func (u IPv4) MarshalText() ([]byte, error)

MarshalText turns this instance into text

func (IPv4) String 

func (u IPv4) String() string

func (*IPv4) UnmarshalJSON 

func (u *IPv4) UnmarshalJSON(data []byte) error

UnmarshalJSON sets the IPv4 from JSON

func (*IPv4) UnmarshalText 

func (u *IPv4) UnmarshalText(data []byte) error

UnmarshalText hydrates this instance from text

type IPv6 

type IPv6 string

IPv6 represents an IP v6 address

swagger:strfmt ipv6

func (*IPv6) DeepCopy 

func (u *IPv6) DeepCopy() *IPv6

DeepCopy copies the receiver into a new IPv6.

func (*IPv6) DeepCopyInto 

func (u *IPv6) DeepCopyInto(out *IPv6)

DeepCopyInto copies the receiver and writes its value into out.

func (IPv6) MarshalJSON 

func (u IPv6) MarshalJSON() ([]byte, error)

MarshalJSON returns the IPv6 as JSON

func (IPv6) MarshalText 

func (u IPv6) MarshalText() ([]byte, error)

MarshalText turns this instance into text

func (IPv6) String 

func (u IPv6) String() string

func (*IPv6) UnmarshalJSON 

func (u *IPv6) UnmarshalJSON(data []byte) error

UnmarshalJSON sets the IPv6 from JSON

func (*IPv6) UnmarshalText 

func (u *IPv6) UnmarshalText(data []byte) error

UnmarshalText hydrates this instance from text

type ISBN 

type ISBN string

ISBN represents an isbn string format

swagger:strfmt isbn

func (*ISBN) DeepCopy 

func (u *ISBN) DeepCopy() *ISBN

DeepCopy copies the receiver into a new ISBN.

func (*ISBN) DeepCopyInto 

func (u *ISBN) DeepCopyInto(out *ISBN)

DeepCopyInto copies the receiver and writes its value into out.

func (ISBN) MarshalJSON 

func (u ISBN) MarshalJSON() ([]byte, error)

MarshalJSON returns the ISBN as JSON

func (ISBN) MarshalText 

func (u ISBN) MarshalText() ([]byte, error)

MarshalText turns this instance into text

func (ISBN) String 

func (u ISBN) String() string

func (*ISBN) UnmarshalJSON 

func (u *ISBN) UnmarshalJSON(data []byte) error

UnmarshalJSON sets the ISBN from JSON

func (*ISBN) UnmarshalText 

func (u *ISBN) UnmarshalText(data []byte) error

UnmarshalText hydrates this instance from text

type ISBN10 

type ISBN10 string

ISBN10 represents an isbn 10 string format

swagger:strfmt isbn10

func (*ISBN10) DeepCopy 

func (u *ISBN10) DeepCopy() *ISBN10

DeepCopy copies the receiver into a new ISBN10.

func (*ISBN10) DeepCopyInto 

func (u *ISBN10) DeepCopyInto(out *ISBN10)

DeepCopyInto copies the receiver and writes its value into out.

func (ISBN10) MarshalJSON 

func (u ISBN10) MarshalJSON() ([]byte, error)

MarshalJSON returns the ISBN10 as JSON

func (ISBN10) MarshalText 

func (u ISBN10) MarshalText() ([]byte, error)

MarshalText turns this instance into text

func (ISBN10) String 

func (u ISBN10) String() string

func (*ISBN10) UnmarshalJSON 

func (u *ISBN10) UnmarshalJSON(data []byte) error

UnmarshalJSON sets the ISBN10 from JSON

func (*ISBN10) UnmarshalText 

func (u *ISBN10) UnmarshalText(data []byte) error

UnmarshalText hydrates this instance from text

type ISBN13 

type ISBN13 string

ISBN13 represents an isbn 13 string format

swagger:strfmt isbn13

func (*ISBN13) DeepCopy 

func (u *ISBN13) DeepCopy() *ISBN13

DeepCopy copies the receiver into a new ISBN13.

func (*ISBN13) DeepCopyInto 

func (u *ISBN13) DeepCopyInto(out *ISBN13)

DeepCopyInto copies the receiver and writes its value into out.

func (ISBN13) MarshalJSON 

func (u ISBN13) MarshalJSON() ([]byte, error)

MarshalJSON returns the ISBN13 as JSON

func (ISBN13) MarshalText 

func (u ISBN13) MarshalText() ([]byte, error)

MarshalText turns this instance into text

func (ISBN13) String 

func (u ISBN13) String() string

func (*ISBN13) UnmarshalJSON 

func (u *ISBN13) UnmarshalJSON(data []byte) error

UnmarshalJSON sets the ISBN13 from JSON

func (*ISBN13) UnmarshalText 

func (u *ISBN13) UnmarshalText(data []byte) error

UnmarshalText hydrates this instance from text

type LongName 

type LongName string

LongName is a name, up to 253 characters long, composed of dot-separated segments; each segment uses only alphanumerics and dashes (no leading/trailing).

LongName almost conforms to the definition of a subdomain in DNS (RFC 1123), except that uppercase letters are not allowed, and there is no max length limit of 63 for each of the dot-separated DNS Labels that make up the subdomain.

xref: https://github.com/kubernetes/kubernetes/issues/71140 xref: https://github.com/kubernetes/kubernetes/issues/79351

swagger:strfmt k8s-long-name

func (*LongName) DeepCopy 

func (r *LongName) DeepCopy() *LongName

func (*LongName) DeepCopyInto 

func (r *LongName) DeepCopyInto(out *LongName)

func (LongName) MarshalJSON 

func (r LongName) MarshalJSON() ([]byte, error)

func (LongName) MarshalText 

func (r LongName) MarshalText() ([]byte, error)

func (LongName) String 

func (r LongName) String() string

func (*LongName) UnmarshalJSON 

func (r *LongName) UnmarshalJSON(data []byte) error

func (*LongName) UnmarshalText 

func (r *LongName) UnmarshalText(data []byte) error

type MAC 

type MAC string

MAC represents a 48 bit MAC address

swagger:strfmt mac

func (*MAC) DeepCopy 

func (u *MAC) DeepCopy() *MAC

DeepCopy copies the receiver into a new MAC.

func (*MAC) DeepCopyInto 

func (u *MAC) DeepCopyInto(out *MAC)

DeepCopyInto copies the receiver and writes its value into out.

func (MAC) MarshalJSON 

func (u MAC) MarshalJSON() ([]byte, error)

MarshalJSON returns the MAC as JSON

func (MAC) MarshalText 

func (u MAC) MarshalText() ([]byte, error)

MarshalText turns this instance into text

func (MAC) String 

func (u MAC) String() string

func (*MAC) UnmarshalJSON 

func (u *MAC) UnmarshalJSON(data []byte) error

UnmarshalJSON sets the MAC from JSON

func (*MAC) UnmarshalText 

func (u *MAC) UnmarshalText(data []byte) error

UnmarshalText hydrates this instance from text

type NameNormalizer 

type NameNormalizer func(string) string

NameNormalizer is a function that normalizes a format name.

type ObjectId 

type ObjectId bsonprim.ObjectID

ObjectId represents a BSON object ID (alias to go.mongodb.org/mongo-driver/bson/primitive.ObjectID)

swagger:strfmt bsonobjectid

func NewObjectId 

func NewObjectId(hex string) ObjectId

NewObjectId creates a ObjectId from a Hex String

func (*ObjectId) DeepCopy 

func (id *ObjectId) DeepCopy() *ObjectId

DeepCopy copies the receiver into a new ObjectId.

func (*ObjectId) DeepCopyInto 

func (id *ObjectId) DeepCopyInto(out *ObjectId)

DeepCopyInto copies the receiver and writes its value into out.

func (ObjectId) MarshalJSON 

func (id ObjectId) MarshalJSON() ([]byte, error)

MarshalJSON returns the ObjectId as JSON

func (ObjectId) MarshalText 

func (id ObjectId) MarshalText() ([]byte, error)

MarshalText turns this instance into text

func (ObjectId) String 

func (id ObjectId) String() string

func (*ObjectId) UnmarshalJSON 

func (id *ObjectId) UnmarshalJSON(data []byte) error

UnmarshalJSON sets the ObjectId from JSON

func (*ObjectId) UnmarshalText 

func (id *ObjectId) UnmarshalText(data []byte) error

UnmarshalText hydrates this instance from text

type Password 

type Password string

Password represents a password. This has no validations and is mainly used as a marker for UI components.

swagger:strfmt password

func (*Password) DeepCopy 

func (r *Password) DeepCopy() *Password

DeepCopy copies the receiver into a new Password.

func (*Password) DeepCopyInto 

func (r *Password) DeepCopyInto(out *Password)

DeepCopyInto copies the receiver and writes its value into out.

func (Password) MarshalJSON 

func (r Password) MarshalJSON() ([]byte, error)

MarshalJSON returns the Password as JSON

func (Password) MarshalText 

func (r Password) MarshalText() ([]byte, error)

MarshalText turns this instance into text

func (Password) String 

func (r Password) String() string

func (*Password) UnmarshalJSON 

func (r *Password) UnmarshalJSON(data []byte) error

UnmarshalJSON sets the Password from JSON

func (*Password) UnmarshalText 

func (r *Password) UnmarshalText(data []byte) error

UnmarshalText hydrates this instance from text

type RGBColor 

type RGBColor string

RGBColor represents a RGB color string format

swagger:strfmt rgbcolor

func (*RGBColor) DeepCopy 

func (r *RGBColor) DeepCopy() *RGBColor

DeepCopy copies the receiver into a new RGBColor.

func (*RGBColor) DeepCopyInto 

func (r *RGBColor) DeepCopyInto(out *RGBColor)

DeepCopyInto copies the receiver and writes its value into out.

func (RGBColor) MarshalJSON 

func (r RGBColor) MarshalJSON() ([]byte, error)

MarshalJSON returns the RGBColor as JSON

func (RGBColor) MarshalText 

func (r RGBColor) MarshalText() ([]byte, error)

MarshalText turns this instance into text

func (RGBColor) String 

func (r RGBColor) String() string

func (*RGBColor) UnmarshalJSON 

func (r *RGBColor) UnmarshalJSON(data []byte) error

UnmarshalJSON sets the RGBColor from JSON

func (*RGBColor) UnmarshalText 

func (r *RGBColor) UnmarshalText(data []byte) error

UnmarshalText hydrates this instance from text

type Registry 

type Registry interface {
	Add(string, Format, Validator) bool
	DelByName(string) bool
	GetType(string) (reflect.Type, bool)
	ContainsName(string) bool
	Validates(string, string) bool
	Parse(string, string) (interface{}, error)
}

Registry is a registry of string formats, with a validation method.

func NewFormats 

func NewFormats() Registry

NewFormats creates a new formats registry seeded with the values from the default

func NewSeededFormats 

func NewSeededFormats(seeds []knownFormat, normalizer NameNormalizer) Registry

NewSeededFormats creates a new formats registry

type SSN 

type SSN string

SSN represents a social security string format

swagger:strfmt ssn

func (*SSN) DeepCopy 

func (u *SSN) DeepCopy() *SSN

DeepCopy copies the receiver into a new SSN.

func (*SSN) DeepCopyInto 

func (u *SSN) DeepCopyInto(out *SSN)

DeepCopyInto copies the receiver and writes its value into out.

func (SSN) MarshalJSON 

func (u SSN) MarshalJSON() ([]byte, error)

MarshalJSON returns the SSN as JSON

func (SSN) MarshalText 

func (u SSN) MarshalText() ([]byte, error)

MarshalText turns this instance into text

func (SSN) String 

func (u SSN) String() string

func (*SSN) UnmarshalJSON 

func (u *SSN) UnmarshalJSON(data []byte) error

UnmarshalJSON sets the SSN from JSON

func (*SSN) UnmarshalText 

func (u *SSN) UnmarshalText(data []byte) error

UnmarshalText hydrates this instance from text

type ShortName 

type ShortName string

ShortName is a name, up to 63 characters long, composed of alphanumeric characters and dashes, which cannot begin or end with a dash.

ShortName almost conforms to the definition of a label in DNS (RFC 1123), except that uppercase letters are not allowed.

xref: https://github.com/kubernetes/kubernetes/issues/71140

swagger:strfmt k8s-short-name

func (*ShortName) DeepCopy 

func (r *ShortName) DeepCopy() *ShortName

func (*ShortName) DeepCopyInto 

func (r *ShortName) DeepCopyInto(out *ShortName)

func (ShortName) MarshalJSON 

func (r ShortName) MarshalJSON() ([]byte, error)

func (ShortName) MarshalText 

func (r ShortName) MarshalText() ([]byte, error)

func (ShortName) String 

func (r ShortName) String() string

func (*ShortName) UnmarshalJSON 

func (r *ShortName) UnmarshalJSON(data []byte) error

func (*ShortName) UnmarshalText 

func (r *ShortName) UnmarshalText(data []byte) error

type URI 

type URI string

URI represents the uri string format as specified by the json schema spec

swagger:strfmt uri

func (*URI) DeepCopy 

func (u *URI) DeepCopy() *URI

DeepCopy copies the receiver into a new URI.

func (*URI) DeepCopyInto 

func (u *URI) DeepCopyInto(out *URI)

DeepCopyInto copies the receiver and writes its value into out.

func (URI) MarshalJSON 

func (u URI) MarshalJSON() ([]byte, error)

MarshalJSON returns the URI as JSON

func (URI) MarshalText 

func (u URI) MarshalText() ([]byte, error)

MarshalText turns this instance into text

func (URI) String 

func (u URI) String() string

func (*URI) UnmarshalJSON 

func (u *URI) UnmarshalJSON(data []byte) error

UnmarshalJSON sets the URI from JSON

func (*URI) UnmarshalText 

func (u *URI) UnmarshalText(data []byte) error

UnmarshalText hydrates this instance from text

type UUID 

type UUID string

UUID represents a uuid string format

swagger:strfmt uuid

func (*UUID) DeepCopy 

func (u *UUID) DeepCopy() *UUID

DeepCopy copies the receiver into a new UUID.

func (*UUID) DeepCopyInto 

func (u *UUID) DeepCopyInto(out *UUID)

DeepCopyInto copies the receiver and writes its value into out.

func (UUID) MarshalJSON 

func (u UUID) MarshalJSON() ([]byte, error)

MarshalJSON returns the UUID as JSON

func (UUID) MarshalText 

func (u UUID) MarshalText() ([]byte, error)

MarshalText turns this instance into text

func (UUID) String 

func (u UUID) String() string

func (*UUID) UnmarshalJSON 

func (u *UUID) UnmarshalJSON(data []byte) error

UnmarshalJSON sets the UUID from JSON

func (*UUID) UnmarshalText 

func (u *UUID) UnmarshalText(data []byte) error

UnmarshalText hydrates this instance from text

type UUID3 

type UUID3 string

UUID3 represents a uuid3 string format

swagger:strfmt uuid3

func (*UUID3) DeepCopy 

func (u *UUID3) DeepCopy() *UUID3

DeepCopy copies the receiver into a new UUID3.

func (*UUID3) DeepCopyInto 

func (u *UUID3) DeepCopyInto(out *UUID3)

DeepCopyInto copies the receiver and writes its value into out.

func (UUID3) MarshalJSON 

func (u UUID3) MarshalJSON() ([]byte, error)

MarshalJSON returns the UUID as JSON

func (UUID3) MarshalText 

func (u UUID3) MarshalText() ([]byte, error)

MarshalText turns this instance into text

func (UUID3) String 

func (u UUID3) String() string

func (*UUID3) UnmarshalJSON 

func (u *UUID3) UnmarshalJSON(data []byte) error

UnmarshalJSON sets the UUID from JSON

func (*UUID3) UnmarshalText 

func (u *UUID3) UnmarshalText(data []byte) error

UnmarshalText hydrates this instance from text

type UUID4 

type UUID4 string

UUID4 represents a uuid4 string format

swagger:strfmt uuid4

func (*UUID4) DeepCopy 

func (u *UUID4) DeepCopy() *UUID4

DeepCopy copies the receiver into a new UUID4.

func (*UUID4) DeepCopyInto 

func (u *UUID4) DeepCopyInto(out *UUID4)

DeepCopyInto copies the receiver and writes its value into out.

func (UUID4) MarshalJSON 

func (u UUID4) MarshalJSON() ([]byte, error)

MarshalJSON returns the UUID as JSON

func (UUID4) MarshalText 

func (u UUID4) MarshalText() ([]byte, error)

MarshalText turns this instance into text

func (UUID4) String 

func (u UUID4) String() string

func (*UUID4) UnmarshalJSON 

func (u *UUID4) UnmarshalJSON(data []byte) error

UnmarshalJSON sets the UUID from JSON

func (*UUID4) UnmarshalText 

func (u *UUID4) UnmarshalText(data []byte) error

UnmarshalText hydrates this instance from text

type UUID5 

type UUID5 string

UUID5 represents a uuid5 string format

swagger:strfmt uuid5

func (*UUID5) DeepCopy 

func (u *UUID5) DeepCopy() *UUID5

DeepCopy copies the receiver into a new UUID5.

func (*UUID5) DeepCopyInto 

func (u *UUID5) DeepCopyInto(out *UUID5)

DeepCopyInto copies the receiver and writes its value into out.

func (UUID5) MarshalJSON 

func (u UUID5) MarshalJSON() ([]byte, error)

MarshalJSON returns the UUID as JSON

func (UUID5) MarshalText 

func (u UUID5) MarshalText() ([]byte, error)

MarshalText turns this instance into text

func (UUID5) String 

func (u UUID5) String() string

func (*UUID5) UnmarshalJSON 

func (u *UUID5) UnmarshalJSON(data []byte) error

UnmarshalJSON sets the UUID from JSON

func (*UUID5) UnmarshalText 

func (u *UUID5) UnmarshalText(data []byte) error

UnmarshalText hydrates this instance from text

type Validator 

type Validator func(string) bool

Validator represents a validator for a string format.

Source Files

View all Source files

Directories

Path Synopsis

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.