const (
// UUIDPattern Regex for UUID that allows uppercase
//
// Deprecated: strfmt no longer uses regular expressions to validate UUIDs.
UUIDPattern = `(?i)(^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$)|(^[0-9a-f]{32}$)`
// UUID3Pattern Regex for UUID3 that allows uppercase
//
// Deprecated: strfmt no longer uses regular expressions to validate UUIDs.
UUID3Pattern = `(?i)(^[0-9a-f]{8}-[0-9a-f]{4}-3[0-9a-f]{3}-[0-9a-f]{4}-[0-9a-f]{12}$)|(^[0-9a-f]{12}3[0-9a-f]{3}?[0-9a-f]{16}$)`
// UUID4Pattern Regex for UUID4 that allows uppercase
//
// Deprecated: strfmt no longer uses regular expressions to validate UUIDs.
UUID4Pattern = `(?i)(^[0-9a-f]{8}-[0-9a-f]{4}-4[0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$)|(^[0-9a-f]{12}4[0-9a-f]{3}[89ab][0-9a-f]{15}$)`
// UUID5Pattern Regex for UUID5 that allows uppercase
//
// Deprecated: strfmt no longer uses regular expressions to validate UUIDs.
UUID5Pattern = `(?i)(^[0-9a-f]{8}-[0-9a-f]{4}-5[0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$)|(^[0-9a-f]{12}5[0-9a-f]{3}[89ab][0-9a-f]{15}$)`
)
const (
// RFC3339Millis represents a ISO8601 format to millis instead of to nanos
RFC3339Millis = "2006-01-02T15:04:05.000Z07:00"
// RFC3339MillisNoColon represents a ISO8601 format to millis instead of to nanos
RFC3339MillisNoColon = "2006-01-02T15:04:05.000Z0700"
// RFC3339Micro represents a ISO8601 format to micro instead of to nano
RFC3339Micro = "2006-01-02T15:04:05.000000Z07:00"
// RFC3339MicroNoColon represents a ISO8601 format to micro instead of to nano
RFC3339MicroNoColon = "2006-01-02T15:04:05.000000Z0700"
// ISO8601LocalTime represents a ISO8601 format to ISO8601 in local time (no timezone)
ISO8601LocalTime = "2006-01-02T15:04:05"
// ISO8601TimeWithReducedPrecision represents a ISO8601 format with reduced precision (dropped secs)
ISO8601TimeWithReducedPrecision = "2006-01-02T15:04Z"
// ISO8601TimeWithReducedPrecisionLocaltime represents a ISO8601 format with reduced precision and no timezone (dropped seconds + no timezone)
ISO8601TimeWithReducedPrecisionLocaltime = "2006-01-02T15:04"
// ISO8601TimeUniversalSortableDateTimePattern represents a ISO8601 universal sortable date time pattern.
ISO8601TimeUniversalSortableDateTimePattern = "2006-01-02 15:04:05"
// short form of ISO8601TimeUniversalSortableDateTimePattern
ISO8601TimeUniversalSortableDateTimePatternShortForm = "2006-01-02"
// 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}))$`
)
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 = `^([a-zA-Z0-9\p{S}\p{L}]((-?[a-zA-Z0-9\p{S}\p{L}]{0,62})?)|([a-zA-Z0-9\p{S}\p{L}](([a-zA-Z0-9-\p{S}\p{L}]{0,61}[a-zA-Z0-9\p{S}\p{L}])?)(\.)){1,}([a-zA-Z\p{L}]){2,63})$`
)
const (
// RFC3339FullDate represents a full-date as specified by RFC3339
// See: http://goo.gl/xXOvVd
RFC3339FullDate = "2006-01-02"
)
var (
// DateTimeFormats is the collection of formats used by ParseDateTime()
DateTimeFormats = []string{RFC3339Micro, RFC3339MicroNoColon, RFC3339Millis, RFC3339MillisNoColon, time.RFC3339, time.RFC3339Nano, ISO8601LocalTime, ISO8601TimeWithReducedPrecision, ISO8601TimeWithReducedPrecisionLocaltime, ISO8601TimeUniversalSortableDateTimePattern, ISO8601TimeUniversalSortableDateTimePatternShortForm}
// MarshalFormat sets the time resolution format used for marshaling time (set to milliseconds)
MarshalFormat = RFC3339Millis
// NormalizeTimeForMarshal provides a normalization function on time befeore marshalling (e.g. time.UTC).
// By default, the time value is not changed.
NormalizeTimeForMarshal = func(t time.Time) time.Time { return t }
// DefaultTimeLocation provides a location for a time when the time zone is not encoded in the string (ex: ISO8601 Local variants).
DefaultTimeLocation = time.UTC
)
var (
ULIDScanDefaultFunc = func(raw interface{}) (ULID, error) {
u := NewULIDZero()
switch x := raw.(type) {
case nil:
return u, nil
case string:
if x == "" {
return u, nil
}
return u, u.UnmarshalText([]byte(x))
case []byte:
return u, u.UnmarshalText(x)
}
return u, fmt.Errorf("cannot sql.Scan() strfmt.ULID from: %#v: %w", raw, ulid.ErrScanValue)
}
// ULIDScanOverrideFunc allows you to override the Scan method of the ULID type
ULIDScanOverrideFunc = ULIDScanDefaultFunc
ULIDValueDefaultFunc = func(u ULID) (driver.Value, error) {
return driver.Value(u.String()), nil
}
// ULIDValueOverrideFunc allows you to override the Value method of the ULID type
ULIDValueOverrideFunc = ULIDValueDefaultFunc
)
Default is the default formats registry
var Default = NewSeededFormats(nil, nil)
var (
// UnixZero sets the zero unix timestamp we want to compare against.
// Unix 0 for an EST timezone is not equivalent to a UTC timezone.
UnixZero = time.Unix(0, 0).UTC()
)
func DefaultNameNormalizer(name string) string
DefaultNameNormalizer removes all dashes
func IsBSONObjectID(str string) bool
IsBSONObjectID returns true when the string is a valid BSON.ObjectId
func IsDate(str string) bool
IsDate returns true when the string is a valid date
func IsDateTime(str string) bool
IsDateTime returns true when the string is a valid date-time
func IsDuration(str string) bool
IsDuration returns true if the provided string is a valid duration
func IsEmail(str string) bool
IsEmail validates an email address.
func IsHostname(str string) bool
IsHostname returns true when the string is a valid hostname
func IsULID(str string) bool
IsULID checks if provided string is ULID format Be noticed that this function considers overflowed ULID as non-ulid. For more details see https://github.com/ulid/spec
func IsUUID(str string) bool
IsUUID returns true is the string matches a UUID (in any version, including v6 and v7), upper case is allowed
func IsUUID3(str string) bool
IsUUID3 returns true is the string matches a UUID v3, upper case is allowed
func IsUUID4(str string) bool
IsUUID4 returns true is the string matches a UUID v4, upper case is allowed
func IsUUID5(str string) bool
IsUUID5 returns true is the string matches a UUID v5, upper case is allowed
func ParseDuration(cand string) (time.Duration, error)
ParseDuration parses a duration from a string, compatible with scala duration syntax
Base64 represents a base64 encoded string, using URLEncoding alphabet
swagger:strfmt byte
type Base64 []byte
func (b *Base64) DeepCopy() *Base64
DeepCopy copies the receiver into a new Base64.
func (b *Base64) DeepCopyInto(out *Base64)
DeepCopyInto copies the receiver and writes its value into out.
func (b Base64) MarshalBSON() ([]byte, error)
MarshalBSON document from this value
func (b Base64) MarshalJSON() ([]byte, error)
MarshalJSON returns the Base64 as JSON
func (b Base64) MarshalText() ([]byte, error)
MarshalText turns this instance into text
func (b *Base64) Scan(raw interface{}) error
Scan read a value from a database driver
func (b Base64) String() string
func (b *Base64) UnmarshalBSON(data []byte) error
UnmarshalBSON document into this value
func (b *Base64) UnmarshalJSON(data []byte) error
UnmarshalJSON sets the Base64 from JSON
func (b *Base64) UnmarshalText(data []byte) error
UnmarshalText hydrates this instance from text
func (b Base64) Value() (driver.Value, error)
Value converts a value to a database driver value
CIDR represents a Classless Inter-Domain Routing notation
swagger:strfmt cidr
type CIDR string
func (u *CIDR) DeepCopy() *CIDR
DeepCopy copies the receiver into a new CIDR.
func (u *CIDR) DeepCopyInto(out *CIDR)
DeepCopyInto copies the receiver and writes its value into out.
func (u CIDR) MarshalBSON() ([]byte, error)
MarshalBSON document from this value
func (u CIDR) MarshalJSON() ([]byte, error)
MarshalJSON returns the CIDR as JSON
func (u CIDR) MarshalText() ([]byte, error)
MarshalText turns this instance into text
func (u *CIDR) Scan(raw interface{}) error
Scan read a value from a database driver
func (u CIDR) String() string
func (u *CIDR) UnmarshalBSON(data []byte) error
UnmarshalBSON document into this value
func (u *CIDR) UnmarshalJSON(data []byte) error
UnmarshalJSON sets the CIDR from JSON
func (u *CIDR) UnmarshalText(data []byte) error
UnmarshalText hydrates this instance from text
func (u CIDR) Value() (driver.Value, error)
Value converts a value to a database driver value
CreditCard represents a credit card string format
swagger:strfmt creditcard
type CreditCard string
func (u *CreditCard) DeepCopy() *CreditCard
DeepCopy copies the receiver into a new CreditCard.
func (u *CreditCard) DeepCopyInto(out *CreditCard)
DeepCopyInto copies the receiver and writes its value into out.
func (u CreditCard) MarshalBSON() ([]byte, error)
MarshalBSON document from this value
func (u CreditCard) MarshalJSON() ([]byte, error)
MarshalJSON returns the CreditCard as JSON
func (u CreditCard) MarshalText() ([]byte, error)
MarshalText turns this instance into text
func (u *CreditCard) Scan(raw interface{}) error
Scan read a value from a database driver
func (u CreditCard) String() string
func (u *CreditCard) UnmarshalBSON(data []byte) error
UnmarshalBSON document into this value
func (u *CreditCard) UnmarshalJSON(data []byte) error
UnmarshalJSON sets the CreditCard from JSON
func (u *CreditCard) UnmarshalText(data []byte) error
UnmarshalText hydrates this instance from text
func (u CreditCard) Value() (driver.Value, error)
Value converts a value to a database driver value
Date represents a date from the API
swagger:strfmt date
type Date time.Time
func (d *Date) DeepCopy() *Date
DeepCopy copies the receiver into a new Date.
func (d *Date) DeepCopyInto(out *Date)
DeepCopyInto copies the receiver and writes its value into out.
func (d Date) Equal(d2 Date) bool
Equal checks if two Date instances are equal
func (d *Date) GobDecode(data []byte) error
GobDecode implements the gob.GobDecoder interface.
func (d Date) GobEncode() ([]byte, error)
GobEncode implements the gob.GobEncoder interface.
func (d Date) MarshalBSON() ([]byte, error)
func (d Date) MarshalBinary() ([]byte, error)
MarshalBinary implements the encoding.BinaryMarshaler interface.
func (d Date) MarshalJSON() ([]byte, error)
MarshalJSON returns the Date as JSON
func (d Date) MarshalText() ([]byte, error)
MarshalText serializes this date type to string
func (d *Date) Scan(raw interface{}) error
Scan scans a Date value from database driver type.
func (d Date) String() string
String converts this date into a string
func (d *Date) UnmarshalBSON(data []byte) error
func (d *Date) UnmarshalBinary(data []byte) error
UnmarshalBinary implements the encoding.BinaryUnmarshaler interface.
func (d *Date) UnmarshalJSON(data []byte) error
UnmarshalJSON sets the Date from JSON
func (d *Date) UnmarshalText(text []byte) error
UnmarshalText parses a text representation into a date type
func (d Date) Value() (driver.Value, error)
Value converts Date to a primitive value ready to written to a database.
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
type DateTime time.Time
func NewDateTime() DateTime
NewDateTime is a representation of zero value for DateTime type
func ParseDateTime(data string) (DateTime, error)
ParseDateTime parses a string that represents an ISO8601 time or a unix epoch
func (t *DateTime) DeepCopy() *DateTime
DeepCopy copies the receiver into a new DateTime.
func (t *DateTime) DeepCopyInto(out *DateTime)
DeepCopyInto copies the receiver and writes its value into out.
func (t DateTime) Equal(t2 DateTime) bool
Equal checks if two DateTime instances are equal using time.Time's Equal method
func (t *DateTime) GobDecode(data []byte) error
GobDecode implements the gob.GobDecoder interface.
func (t DateTime) GobEncode() ([]byte, error)
GobEncode implements the gob.GobEncoder interface.
func (t *DateTime) IsUnixZero() bool
IsUnixZerom returns whether the date time is equivalent to time.Unix(0, 0).UTC().
func (t *DateTime) IsZero() bool
IsZero returns whether the date time is a zero value
func (t DateTime) MarshalBSON() ([]byte, error)
MarshalBSON renders the DateTime as a BSON document
func (t DateTime) MarshalBSONValue() (bsontype.Type, []byte, error)
MarshalBSONValue is an interface implemented by types that can marshal themselves into a BSON document represented as bytes. The bytes returned must be a valid BSON document if the error is nil. Marshals a DateTime as a bsontype.DateTime, an int64 representing milliseconds since epoch.
func (t DateTime) MarshalBinary() ([]byte, error)
MarshalBinary implements the encoding.BinaryMarshaler interface.
func (t DateTime) MarshalJSON() ([]byte, error)
MarshalJSON returns the DateTime as JSON
func (t DateTime) MarshalText() ([]byte, error)
MarshalText implements the text marshaller interface
func (t *DateTime) Scan(raw interface{}) error
Scan scans a DateTime value from database driver type.
func (t DateTime) String() string
String converts this time to a string
func (t *DateTime) UnmarshalBSON(data []byte) error
UnmarshalBSON reads the DateTime from a BSON document
func (t *DateTime) UnmarshalBSONValue(tpe bsontype.Type, data []byte) error
UnmarshalBSONValue is an interface implemented by types that can unmarshal a BSON value representation of themselves. The BSON bytes and type can be assumed to be valid. UnmarshalBSONValue must copy the BSON value bytes if it wishes to retain the data after returning.
func (t *DateTime) UnmarshalBinary(data []byte) error
UnmarshalBinary implements the encoding.BinaryUnmarshaler interface.
func (t *DateTime) UnmarshalJSON(data []byte) error
UnmarshalJSON sets the DateTime from JSON
func (t *DateTime) UnmarshalText(text []byte) error
UnmarshalText implements the text unmarshaller interface
func (t DateTime) Value() (driver.Value, error)
Value converts DateTime to a primitive value ready to written to a database.
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
type Duration time.Duration
func (d *Duration) DeepCopy() *Duration
DeepCopy copies the receiver into a new Duration.
func (d *Duration) DeepCopyInto(out *Duration)
DeepCopyInto copies the receiver and writes its value into out.
func (d Duration) MarshalBSON() ([]byte, error)
func (d Duration) MarshalJSON() ([]byte, error)
MarshalJSON returns the Duration as JSON
func (d Duration) MarshalText() ([]byte, error)
MarshalText turns this instance into text
func (d *Duration) Scan(raw interface{}) error
Scan reads a Duration value from database driver type.
func (d Duration) String() string
String converts this duration to a string
func (d *Duration) UnmarshalBSON(data []byte) error
func (d *Duration) UnmarshalJSON(data []byte) error
UnmarshalJSON sets the Duration from JSON
func (d *Duration) UnmarshalText(data []byte) error
UnmarshalText hydrates this instance from text
func (d Duration) Value() (driver.Value, error)
Value converts Duration to a primitive value ready to be written to a database.
Email represents the email string format as specified by the json schema spec
swagger:strfmt email
type Email string
func (e *Email) DeepCopy() *Email
DeepCopy copies the receiver into a new Email.
func (e *Email) DeepCopyInto(out *Email)
DeepCopyInto copies the receiver and writes its value into out.
func (e Email) MarshalBSON() ([]byte, error)
MarshalBSON document from this value
func (e Email) MarshalJSON() ([]byte, error)
MarshalJSON returns the Email as JSON
func (e Email) MarshalText() ([]byte, error)
MarshalText turns this instance into text
func (e *Email) Scan(raw interface{}) error
Scan read a value from a database driver
func (e Email) String() string
func (e *Email) UnmarshalBSON(data []byte) error
UnmarshalBSON document into this value
func (e *Email) UnmarshalJSON(data []byte) error
UnmarshalJSON sets the Email from JSON
func (e *Email) UnmarshalText(data []byte) error
UnmarshalText hydrates this instance from text
func (e Email) Value() (driver.Value, error)
Value converts a value to a database driver value
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 Format interface {
String() string
encoding.TextMarshaler
encoding.TextUnmarshaler
}
HexColor represents a hex color string format
swagger:strfmt hexcolor
type HexColor string
func (h *HexColor) DeepCopy() *HexColor
DeepCopy copies the receiver into a new HexColor.
func (h *HexColor) DeepCopyInto(out *HexColor)
DeepCopyInto copies the receiver and writes its value into out.
func (h HexColor) MarshalBSON() ([]byte, error)
MarshalBSON document from this value
func (h HexColor) MarshalJSON() ([]byte, error)
MarshalJSON returns the HexColor as JSON
func (h HexColor) MarshalText() ([]byte, error)
MarshalText turns this instance into text
func (h *HexColor) Scan(raw interface{}) error
Scan read a value from a database driver
func (h HexColor) String() string
func (h *HexColor) UnmarshalBSON(data []byte) error
UnmarshalBSON document into this value
func (h *HexColor) UnmarshalJSON(data []byte) error
UnmarshalJSON sets the HexColor from JSON
func (h *HexColor) UnmarshalText(data []byte) error
UnmarshalText hydrates this instance from text
func (h HexColor) Value() (driver.Value, error)
Value converts a value to a database driver value
Hostname represents the hostname string format as specified by the json schema spec
swagger:strfmt hostname
type Hostname string
func (h *Hostname) DeepCopy() *Hostname
DeepCopy copies the receiver into a new Hostname.
func (h *Hostname) DeepCopyInto(out *Hostname)
DeepCopyInto copies the receiver and writes its value into out.
func (h Hostname) MarshalBSON() ([]byte, error)
MarshalBSON document from this value
func (h Hostname) MarshalJSON() ([]byte, error)
MarshalJSON returns the Hostname as JSON
func (h Hostname) MarshalText() ([]byte, error)
MarshalText turns this instance into text
func (h *Hostname) Scan(raw interface{}) error
Scan read a value from a database driver
func (h Hostname) String() string
func (h *Hostname) UnmarshalBSON(data []byte) error
UnmarshalBSON document into this value
func (h *Hostname) UnmarshalJSON(data []byte) error
UnmarshalJSON sets the Hostname from JSON
func (h *Hostname) UnmarshalText(data []byte) error
UnmarshalText hydrates this instance from text
func (h Hostname) Value() (driver.Value, error)
Value converts a value to a database driver value
IPv4 represents an IP v4 address
swagger:strfmt ipv4
type IPv4 string
func (u *IPv4) DeepCopy() *IPv4
DeepCopy copies the receiver into a new IPv4.
func (u *IPv4) DeepCopyInto(out *IPv4)
DeepCopyInto copies the receiver and writes its value into out.
func (u IPv4) MarshalBSON() ([]byte, error)
MarshalBSON document from this value
func (u IPv4) MarshalJSON() ([]byte, error)
MarshalJSON returns the IPv4 as JSON
func (u IPv4) MarshalText() ([]byte, error)
MarshalText turns this instance into text
func (u *IPv4) Scan(raw interface{}) error
Scan read a value from a database driver
func (u IPv4) String() string
func (u *IPv4) UnmarshalBSON(data []byte) error
UnmarshalBSON document into this value
func (u *IPv4) UnmarshalJSON(data []byte) error
UnmarshalJSON sets the IPv4 from JSON
func (u *IPv4) UnmarshalText(data []byte) error
UnmarshalText hydrates this instance from text
func (u IPv4) Value() (driver.Value, error)
Value converts a value to a database driver value
IPv6 represents an IP v6 address
swagger:strfmt ipv6
type IPv6 string
func (u *IPv6) DeepCopy() *IPv6
DeepCopy copies the receiver into a new IPv6.
func (u *IPv6) DeepCopyInto(out *IPv6)
DeepCopyInto copies the receiver and writes its value into out.
func (u IPv6) MarshalBSON() ([]byte, error)
MarshalBSON document from this value
func (u IPv6) MarshalJSON() ([]byte, error)
MarshalJSON returns the IPv6 as JSON
func (u IPv6) MarshalText() ([]byte, error)
MarshalText turns this instance into text
func (u *IPv6) Scan(raw interface{}) error
Scan read a value from a database driver
func (u IPv6) String() string
func (u *IPv6) UnmarshalBSON(data []byte) error
UnmarshalBSON document into this value
func (u *IPv6) UnmarshalJSON(data []byte) error
UnmarshalJSON sets the IPv6 from JSON
func (u *IPv6) UnmarshalText(data []byte) error
UnmarshalText hydrates this instance from text
func (u IPv6) Value() (driver.Value, error)
Value converts a value to a database driver value
ISBN represents an isbn string format
swagger:strfmt isbn
type ISBN string
func (u *ISBN) DeepCopy() *ISBN
DeepCopy copies the receiver into a new ISBN.
func (u *ISBN) DeepCopyInto(out *ISBN)
DeepCopyInto copies the receiver and writes its value into out.
func (u ISBN) MarshalBSON() ([]byte, error)
MarshalBSON document from this value
func (u ISBN) MarshalJSON() ([]byte, error)
MarshalJSON returns the ISBN as JSON
func (u ISBN) MarshalText() ([]byte, error)
MarshalText turns this instance into text
func (u *ISBN) Scan(raw interface{}) error
Scan read a value from a database driver
func (u ISBN) String() string
func (u *ISBN) UnmarshalBSON(data []byte) error
UnmarshalBSON document into this value
func (u *ISBN) UnmarshalJSON(data []byte) error
UnmarshalJSON sets the ISBN from JSON
func (u *ISBN) UnmarshalText(data []byte) error
UnmarshalText hydrates this instance from text
func (u ISBN) Value() (driver.Value, error)
Value converts a value to a database driver value
ISBN10 represents an isbn 10 string format
swagger:strfmt isbn10
type ISBN10 string
func (u *ISBN10) DeepCopy() *ISBN10
DeepCopy copies the receiver into a new ISBN10.
func (u *ISBN10) DeepCopyInto(out *ISBN10)
DeepCopyInto copies the receiver and writes its value into out.
func (u ISBN10) MarshalBSON() ([]byte, error)
MarshalBSON document from this value
func (u ISBN10) MarshalJSON() ([]byte, error)
MarshalJSON returns the ISBN10 as JSON
func (u ISBN10) MarshalText() ([]byte, error)
MarshalText turns this instance into text
func (u *ISBN10) Scan(raw interface{}) error
Scan read a value from a database driver
func (u ISBN10) String() string
func (u *ISBN10) UnmarshalBSON(data []byte) error
UnmarshalBSON document into this value
func (u *ISBN10) UnmarshalJSON(data []byte) error
UnmarshalJSON sets the ISBN10 from JSON
func (u *ISBN10) UnmarshalText(data []byte) error
UnmarshalText hydrates this instance from text
func (u ISBN10) Value() (driver.Value, error)
Value converts a value to a database driver value
ISBN13 represents an isbn 13 string format
swagger:strfmt isbn13
type ISBN13 string
func (u *ISBN13) DeepCopy() *ISBN13
DeepCopy copies the receiver into a new ISBN13.
func (u *ISBN13) DeepCopyInto(out *ISBN13)
DeepCopyInto copies the receiver and writes its value into out.
func (u ISBN13) MarshalBSON() ([]byte, error)
MarshalBSON document from this value
func (u ISBN13) MarshalJSON() ([]byte, error)
MarshalJSON returns the ISBN13 as JSON
func (u ISBN13) MarshalText() ([]byte, error)
MarshalText turns this instance into text
func (u *ISBN13) Scan(raw interface{}) error
Scan read a value from a database driver
func (u ISBN13) String() string
func (u *ISBN13) UnmarshalBSON(data []byte) error
UnmarshalBSON document into this value
func (u *ISBN13) UnmarshalJSON(data []byte) error
UnmarshalJSON sets the ISBN13 from JSON
func (u *ISBN13) UnmarshalText(data []byte) error
UnmarshalText hydrates this instance from text
func (u ISBN13) Value() (driver.Value, error)
Value converts a value to a database driver value
MAC represents a 48 bit MAC address
swagger:strfmt mac
type MAC string
func (u *MAC) DeepCopy() *MAC
DeepCopy copies the receiver into a new MAC.
func (u *MAC) DeepCopyInto(out *MAC)
DeepCopyInto copies the receiver and writes its value into out.
func (u MAC) MarshalBSON() ([]byte, error)
MarshalBSON document from this value
func (u MAC) MarshalJSON() ([]byte, error)
MarshalJSON returns the MAC as JSON
func (u MAC) MarshalText() ([]byte, error)
MarshalText turns this instance into text
func (u *MAC) Scan(raw interface{}) error
Scan read a value from a database driver
func (u MAC) String() string
func (u *MAC) UnmarshalBSON(data []byte) error
UnmarshalBSON document into this value
func (u *MAC) UnmarshalJSON(data []byte) error
UnmarshalJSON sets the MAC from JSON
func (u *MAC) UnmarshalText(data []byte) error
UnmarshalText hydrates this instance from text
func (u MAC) Value() (driver.Value, error)
Value converts a value to a database driver value
NameNormalizer is a function that normalizes a format name.
type NameNormalizer func(string) string
ObjectId represents a BSON object ID (alias to go.mongodb.org/mongo-driver/bson/primitive.ObjectID)
swagger:strfmt bsonobjectid
type ObjectId bsonprim.ObjectID //nolint:revive,stylecheck
func NewObjectId(hex string) ObjectId
NewObjectId creates a ObjectId from a Hex String
func (id *ObjectId) DeepCopy() *ObjectId
DeepCopy copies the receiver into a new ObjectId.
func (id *ObjectId) DeepCopyInto(out *ObjectId)
DeepCopyInto copies the receiver and writes its value into out.
func (id ObjectId) MarshalBSON() ([]byte, error)
MarshalBSON renders the object id as a BSON document
func (id ObjectId) MarshalBSONValue() (bsontype.Type, []byte, error)
MarshalBSONValue is an interface implemented by types that can marshal themselves into a BSON document represented as bytes. The bytes returned must be a valid BSON document if the error is nil.
func (id ObjectId) MarshalJSON() ([]byte, error)
MarshalJSON returns the ObjectId as JSON
func (id ObjectId) MarshalText() ([]byte, error)
MarshalText turns this instance into text
func (id *ObjectId) Scan(raw interface{}) error
Scan read a value from a database driver
func (id ObjectId) String() string
func (id *ObjectId) UnmarshalBSON(data []byte) error
UnmarshalBSON reads the objectId from a BSON document
func (id *ObjectId) UnmarshalBSONValue(_ bsontype.Type, data []byte) error
UnmarshalBSONValue is an interface implemented by types that can unmarshal a BSON value representation of themselves. The BSON bytes and type can be assumed to be valid. UnmarshalBSONValue must copy the BSON value bytes if it wishes to retain the data after returning.
func (id *ObjectId) UnmarshalJSON(data []byte) error
UnmarshalJSON sets the ObjectId from JSON
func (id *ObjectId) UnmarshalText(data []byte) error
UnmarshalText hydrates this instance from text
func (id ObjectId) Value() (driver.Value, error)
Value converts a value to a database driver value
Password represents a password. This has no validations and is mainly used as a marker for UI components.
swagger:strfmt password
type Password string
func (r *Password) DeepCopy() *Password
DeepCopy copies the receiver into a new Password.
func (r *Password) DeepCopyInto(out *Password)
DeepCopyInto copies the receiver and writes its value into out.
func (r Password) MarshalBSON() ([]byte, error)
MarshalBSON document from this value
func (r Password) MarshalJSON() ([]byte, error)
MarshalJSON returns the Password as JSON
func (r Password) MarshalText() ([]byte, error)
MarshalText turns this instance into text
func (r *Password) Scan(raw interface{}) error
Scan read a value from a database driver
func (r Password) String() string
func (r *Password) UnmarshalBSON(data []byte) error
UnmarshalBSON document into this value
func (r *Password) UnmarshalJSON(data []byte) error
UnmarshalJSON sets the Password from JSON
func (r *Password) UnmarshalText(data []byte) error
UnmarshalText hydrates this instance from text
func (r Password) Value() (driver.Value, error)
Value converts a value to a database driver value
RGBColor represents a RGB color string format
swagger:strfmt rgbcolor
type RGBColor string
func (r *RGBColor) DeepCopy() *RGBColor
DeepCopy copies the receiver into a new RGBColor.
func (r *RGBColor) DeepCopyInto(out *RGBColor)
DeepCopyInto copies the receiver and writes its value into out.
func (r RGBColor) MarshalBSON() ([]byte, error)
MarshalBSON document from this value
func (r RGBColor) MarshalJSON() ([]byte, error)
MarshalJSON returns the RGBColor as JSON
func (r RGBColor) MarshalText() ([]byte, error)
MarshalText turns this instance into text
func (r *RGBColor) Scan(raw interface{}) error
Scan read a value from a database driver
func (r RGBColor) String() string
func (r *RGBColor) UnmarshalBSON(data []byte) error
UnmarshalBSON document into this value
func (r *RGBColor) UnmarshalJSON(data []byte) error
UnmarshalJSON sets the RGBColor from JSON
func (r *RGBColor) UnmarshalText(data []byte) error
UnmarshalText hydrates this instance from text
func (r RGBColor) Value() (driver.Value, error)
Value converts a value to a database driver value
Registry is a registry of string formats, with a validation method.
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)
MapStructureHookFunc() mapstructure.DecodeHookFunc
}
func NewFormats() Registry
NewFormats creates a new formats registry seeded with the values from the default
func NewSeededFormats(seeds []knownFormat, normalizer NameNormalizer) Registry
NewSeededFormats creates a new formats registry
SSN represents a social security string format
swagger:strfmt ssn
type SSN string
func (u *SSN) DeepCopy() *SSN
DeepCopy copies the receiver into a new SSN.
func (u *SSN) DeepCopyInto(out *SSN)
DeepCopyInto copies the receiver and writes its value into out.
func (u SSN) MarshalBSON() ([]byte, error)
MarshalBSON document from this value
func (u SSN) MarshalJSON() ([]byte, error)
MarshalJSON returns the SSN as JSON
func (u SSN) MarshalText() ([]byte, error)
MarshalText turns this instance into text
func (u *SSN) Scan(raw interface{}) error
Scan read a value from a database driver
func (u SSN) String() string
func (u *SSN) UnmarshalBSON(data []byte) error
UnmarshalBSON document into this value
func (u *SSN) UnmarshalJSON(data []byte) error
UnmarshalJSON sets the SSN from JSON
func (u *SSN) UnmarshalText(data []byte) error
UnmarshalText hydrates this instance from text
func (u SSN) Value() (driver.Value, error)
Value converts a value to a database driver value
ULID represents a ulid string format ref:
https://github.com/ulid/spec
impl:
https://github.com/oklog/ulid
swagger:strfmt ulid
type ULID struct {
ulid.ULID
}
func NewULID() (ULID, error)
NewULID generates new unique ULID value and a error if any
func NewULIDZero() ULID
NewULIDZero returns a zero valued ULID type
func ParseULID(str string) (ULID, error)
ParseULID parses a string that represents an valid ULID
func (u *ULID) DeepCopy() *ULID
DeepCopy copies the receiver into a new ULID.
func (u *ULID) DeepCopyInto(out *ULID)
DeepCopyInto copies the receiver and writes its value into out.
func (u ULID) Equal(other ULID) bool
Equal checks if two ULID instances are equal by their underlying type
func (u *ULID) GetULID() interface{}
GetULID returns underlying instance of ULID
func (u *ULID) GobDecode(data []byte) error
GobDecode implements the gob.GobDecoder interface.
func (u ULID) GobEncode() ([]byte, error)
GobEncode implements the gob.GobEncoder interface.
func (u ULID) MarshalBSON() ([]byte, error)
MarshalBSON document from this value
func (u ULID) MarshalBinary() ([]byte, error)
MarshalBinary implements the encoding.BinaryMarshaler interface.
func (u ULID) MarshalJSON() ([]byte, error)
MarshalJSON returns the ULID as JSON
func (u ULID) MarshalText() ([]byte, error)
MarshalText returns this instance into text
func (u *ULID) Scan(raw interface{}) error
Scan reads a value from a database driver
func (u ULID) String() string
func (u *ULID) UnmarshalBSON(data []byte) error
UnmarshalBSON document into this value
func (u *ULID) UnmarshalBinary(data []byte) error
UnmarshalBinary implements the encoding.BinaryUnmarshaler interface.
func (u *ULID) UnmarshalJSON(data []byte) error
UnmarshalJSON sets the ULID from JSON
func (u *ULID) UnmarshalText(data []byte) error
UnmarshalText hydrates this instance from text
func (u ULID) Value() (driver.Value, error)
Value converts a value to a database driver value
URI represents the uri string format as specified by the json schema spec
swagger:strfmt uri
type URI string
func (u *URI) DeepCopy() *URI
DeepCopy copies the receiver into a new URI.
func (u *URI) DeepCopyInto(out *URI)
DeepCopyInto copies the receiver and writes its value into out.
func (u URI) MarshalBSON() ([]byte, error)
MarshalBSON document from this value
func (u URI) MarshalJSON() ([]byte, error)
MarshalJSON returns the URI as JSON
func (u URI) MarshalText() ([]byte, error)
MarshalText turns this instance into text
func (u *URI) Scan(raw interface{}) error
Scan read a value from a database driver
func (u URI) String() string
func (u *URI) UnmarshalBSON(data []byte) error
UnmarshalBSON document into this value
func (u *URI) UnmarshalJSON(data []byte) error
UnmarshalJSON sets the URI from JSON
func (u *URI) UnmarshalText(data []byte) error
UnmarshalText hydrates this instance from text
func (u URI) Value() (driver.Value, error)
Value converts a value to a database driver value
UUID represents a uuid string format
swagger:strfmt uuid
type UUID string
func (u *UUID) DeepCopy() *UUID
DeepCopy copies the receiver into a new UUID.
func (u *UUID) DeepCopyInto(out *UUID)
DeepCopyInto copies the receiver and writes its value into out.
func (u UUID) MarshalBSON() ([]byte, error)
MarshalBSON document from this value
func (u UUID) MarshalJSON() ([]byte, error)
MarshalJSON returns the UUID as JSON
func (u UUID) MarshalText() ([]byte, error)
MarshalText turns this instance into text
func (u *UUID) Scan(raw interface{}) error
Scan read a value from a database driver
func (u UUID) String() string
func (u *UUID) UnmarshalBSON(data []byte) error
UnmarshalBSON document into this value
func (u *UUID) UnmarshalJSON(data []byte) error
UnmarshalJSON sets the UUID from JSON
func (u *UUID) UnmarshalText(data []byte) error
UnmarshalText hydrates this instance from text
func (u UUID) Value() (driver.Value, error)
Value converts a value to a database driver value
UUID3 represents a uuid3 string format
swagger:strfmt uuid3
type UUID3 string
func (u *UUID3) DeepCopy() *UUID3
DeepCopy copies the receiver into a new UUID3.
func (u *UUID3) DeepCopyInto(out *UUID3)
DeepCopyInto copies the receiver and writes its value into out.
func (u UUID3) MarshalBSON() ([]byte, error)
MarshalBSON document from this value
func (u UUID3) MarshalJSON() ([]byte, error)
MarshalJSON returns the UUID as JSON
func (u UUID3) MarshalText() ([]byte, error)
MarshalText turns this instance into text
func (u *UUID3) Scan(raw interface{}) error
Scan read a value from a database driver
func (u UUID3) String() string
func (u *UUID3) UnmarshalBSON(data []byte) error
UnmarshalBSON document into this value
func (u *UUID3) UnmarshalJSON(data []byte) error
UnmarshalJSON sets the UUID from JSON
func (u *UUID3) UnmarshalText(data []byte) error
UnmarshalText hydrates this instance from text
func (u UUID3) Value() (driver.Value, error)
Value converts a value to a database driver value
UUID4 represents a uuid4 string format
swagger:strfmt uuid4
type UUID4 string
func (u *UUID4) DeepCopy() *UUID4
DeepCopy copies the receiver into a new UUID4.
func (u *UUID4) DeepCopyInto(out *UUID4)
DeepCopyInto copies the receiver and writes its value into out.
func (u UUID4) MarshalBSON() ([]byte, error)
MarshalBSON document from this value
func (u UUID4) MarshalJSON() ([]byte, error)
MarshalJSON returns the UUID as JSON
func (u UUID4) MarshalText() ([]byte, error)
MarshalText turns this instance into text
func (u *UUID4) Scan(raw interface{}) error
Scan read a value from a database driver
func (u UUID4) String() string
func (u *UUID4) UnmarshalBSON(data []byte) error
UnmarshalBSON document into this value
func (u *UUID4) UnmarshalJSON(data []byte) error
UnmarshalJSON sets the UUID from JSON
func (u *UUID4) UnmarshalText(data []byte) error
UnmarshalText hydrates this instance from text
func (u UUID4) Value() (driver.Value, error)
Value converts a value to a database driver value
UUID5 represents a uuid5 string format
swagger:strfmt uuid5
type UUID5 string
func (u *UUID5) DeepCopy() *UUID5
DeepCopy copies the receiver into a new UUID5.
func (u *UUID5) DeepCopyInto(out *UUID5)
DeepCopyInto copies the receiver and writes its value into out.
func (u UUID5) MarshalBSON() ([]byte, error)
MarshalBSON document from this value
func (u UUID5) MarshalJSON() ([]byte, error)
MarshalJSON returns the UUID as JSON
func (u UUID5) MarshalText() ([]byte, error)
MarshalText turns this instance into text
func (u *UUID5) Scan(raw interface{}) error
Scan read a value from a database driver
func (u UUID5) String() string
func (u *UUID5) UnmarshalBSON(data []byte) error
UnmarshalBSON document into this value
func (u *UUID5) UnmarshalJSON(data []byte) error
UnmarshalJSON sets the UUID from JSON
func (u *UUID5) UnmarshalText(data []byte) error
UnmarshalText hydrates this instance from text
func (u UUID5) Value() (driver.Value, error)
Value converts a value to a database driver value
Validator represents a validator for a string format.
type Validator func(string) bool