package option

Import Path
	go.pact.im/x/option (on go.dev)

Dependency Relation
	imports 0 packages, and imported by 3 packages

Involved Source Files

	   #d option.go
		Package option implements optional values to represent the lack of value
		without pointers.
Package-Level Type Names (only one, which is exported)

	/* sort exporteds by: alphabet | popularity */
	 type Of[T] (struct)

		Type Parameters:
			T: any

		Of represents an optional value that may be nil.

		Fields (total 2, neither is exported)
			/* 2 unexporteds ... *//* 2 unexporteds: */
			isSet bool
			value T
		Methods (only one, which is exported)
			( Of[T]) Unwrap() (T, bool)
				Unwrap returns the underlying value and a boolean flag indicating whether it
				is set.

		As Outputs Of (at least 4, all are exported)
			func Map[T, U](opt Of[T], f func(T) U) Of[U]
			func Nil[T]() Of[T]
			func Value[T](v T) Of[T]
			func go.pact.im/x/phcformat/encode.Nil() Of[encode.Appender]
		As Inputs Of (at least 9, in which 8 are exported)
			func IsNil[T](opt Of[T]) bool
			func Map[T, U](opt Of[T], f func(T) U) Of[U]
			func UnwrapOrZero[T](opt Of[T]) T
			func go.pact.im/x/phcformat.Append[NameAppender, VersionAppender, ParamsAppender, SaltAppender, OutputAppender](dst []byte, name NameAppender, version Of[VersionAppender], params Of[ParamsAppender], salt Of[SaltAppender], output Of[OutputAppender]) []byte
			func go.pact.im/x/phcformat.Append[NameAppender, VersionAppender, ParamsAppender, SaltAppender, OutputAppender](dst []byte, name NameAppender, version Of[VersionAppender], params Of[ParamsAppender], salt Of[SaltAppender], output Of[OutputAppender]) []byte
			func go.pact.im/x/phcformat.Append[NameAppender, VersionAppender, ParamsAppender, SaltAppender, OutputAppender](dst []byte, name NameAppender, version Of[VersionAppender], params Of[ParamsAppender], salt Of[SaltAppender], output Of[OutputAppender]) []byte
			func go.pact.im/x/phcformat.Append[NameAppender, VersionAppender, ParamsAppender, SaltAppender, OutputAppender](dst []byte, name NameAppender, version Of[VersionAppender], params Of[ParamsAppender], salt Of[SaltAppender], output Of[OutputAppender]) []byte
			func go.pact.im/x/phcformat/encode.NewOption[T](opt Of[T]) encode.Option[T]
			/* at least one unexported ... *//* at least one unexported: */
			func go.pact.im/x/phcformat.optionAppenderWithPrefix[PrefixAppender, OptionAppender](prefix PrefixAppender, opt Of[OptionAppender]) encode.Option[encode.Concat[PrefixAppender, OptionAppender]]


Package-Level Functions (total 5, all are exported)

	 func IsNil[T](opt Of[T]) bool

		Type Parameters:
			T: any

		IsNil returns true if the value is nil.

	 func Map[T, U](opt Of[T], f func(T) U) Of[U]

		Type Parameters:
			T: any
			U: any

		Map applies function f to the underlying option value if it is set.

	 func Nil[T]() Of[T]

		Type Parameters:
			T: any

		Nil returns nil option with type T.

	 func UnwrapOrZero[T](opt Of[T]) T

		Type Parameters:
			T: any

		UnwrapOrZero returns the option value or its zero value if it is not set.

	 func Value[T](v T) Of[T]

		Type Parameters:
			T: any

		Value returns an option with the given value.

The pages are generated with Golds v0.4.9. (GOOS=linux GOARCH=amd64)