coretaskinfo

package
v1.3.55 Latest Latest
Warning

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

Go to latest
Published: Apr 7, 2022 License: MIT Imports: 4 Imported by: 9

Documentation

Index

Constants

This section is empty.

Variables

View Source
var (
	New = newCreator{}
)

Functions

This section is empty.

Types

type ExcludingOptions

type ExcludingOptions struct {
	IsExcludeRootName,
	IsExcludeDescription,
	IsExcludeUrl,
	IsExcludeHintUrl,
	IsExcludeErrorUrl,
	IsExcludeAdditionalErrorWrap,
	IsExcludeExampleUrl,
	IsExcludeSingleExample,
	IsExcludeExamples,
	IsSecureText bool // indicates secure text, invert means log payload, plain text. it will not log payload
}

func (ExcludingOptions) Clone added in v1.3.30

func (*ExcludingOptions) ClonePtr added in v1.3.35

func (it *ExcludingOptions) ClonePtr() *ExcludingOptions

func (*ExcludingOptions) IsEmpty added in v1.3.30

func (it *ExcludingOptions) IsEmpty() bool

func (*ExcludingOptions) IsIncludeAdditionalErrorWrap

func (it *ExcludingOptions) IsIncludeAdditionalErrorWrap() bool

func (*ExcludingOptions) IsIncludeDescription

func (it *ExcludingOptions) IsIncludeDescription() bool

func (*ExcludingOptions) IsIncludeErrorUrl

func (it *ExcludingOptions) IsIncludeErrorUrl() bool

func (*ExcludingOptions) IsIncludeExampleUrl

func (it *ExcludingOptions) IsIncludeExampleUrl() bool

func (*ExcludingOptions) IsIncludeExamples

func (it *ExcludingOptions) IsIncludeExamples() bool

func (*ExcludingOptions) IsIncludeHintUrl

func (it *ExcludingOptions) IsIncludeHintUrl() bool

func (*ExcludingOptions) IsIncludePayloads

func (it *ExcludingOptions) IsIncludePayloads() bool

func (*ExcludingOptions) IsIncludeRootName

func (it *ExcludingOptions) IsIncludeRootName() bool

func (*ExcludingOptions) IsIncludeSingleExample added in v1.3.30

func (it *ExcludingOptions) IsIncludeSingleExample() bool

func (*ExcludingOptions) IsIncludeUrl

func (it *ExcludingOptions) IsIncludeUrl() bool

func (*ExcludingOptions) IsSafeExcludeAdditionalErrorWrap added in v1.3.55

func (it *ExcludingOptions) IsSafeExcludeAdditionalErrorWrap() bool

func (*ExcludingOptions) IsSafeExcludeDescription added in v1.3.55

func (it *ExcludingOptions) IsSafeExcludeDescription() bool

func (*ExcludingOptions) IsSafeExcludeErrorUrl added in v1.3.55

func (it *ExcludingOptions) IsSafeExcludeErrorUrl() bool

func (*ExcludingOptions) IsSafeExcludeExampleUrl added in v1.3.55

func (it *ExcludingOptions) IsSafeExcludeExampleUrl() bool

func (*ExcludingOptions) IsSafeExcludeExamples added in v1.3.55

func (it *ExcludingOptions) IsSafeExcludeExamples() bool

func (*ExcludingOptions) IsSafeExcludeHintUrl added in v1.3.55

func (it *ExcludingOptions) IsSafeExcludeHintUrl() bool

func (*ExcludingOptions) IsSafeExcludeRootName added in v1.3.55

func (it *ExcludingOptions) IsSafeExcludeRootName() bool

func (*ExcludingOptions) IsSafeExcludeSingleExample added in v1.3.55

func (it *ExcludingOptions) IsSafeExcludeSingleExample() bool

func (*ExcludingOptions) IsSafeExcludeUrl added in v1.3.55

func (it *ExcludingOptions) IsSafeExcludeUrl() bool

func (*ExcludingOptions) IsSafeSecureText added in v1.3.55

func (it *ExcludingOptions) IsSafeSecureText() bool

func (*ExcludingOptions) IsZero added in v1.3.30

func (it *ExcludingOptions) IsZero() bool

func (*ExcludingOptions) SetPlainText added in v1.3.30

func (it *ExcludingOptions) SetPlainText() *ExcludingOptions

func (*ExcludingOptions) SetSecure added in v1.3.30

func (it *ExcludingOptions) SetSecure() *ExcludingOptions

func (ExcludingOptions) ToNonPtr added in v1.3.30

func (it ExcludingOptions) ToNonPtr() ExcludingOptions

func (ExcludingOptions) ToPtr added in v1.3.30

func (it ExcludingOptions) ToPtr() *ExcludingOptions

type Info

type Info struct {
	RootName       string            `json:"RootName,omitempty"`
	Description    string            `json:"Description,omitempty"`
	Url            string            `json:"Url,omitempty"`
	HintUrl        string            `json:"HintUrl,omitempty"`
	ErrorUrl       string            `json:"ErrorUrl,omitempty"`
	ExampleUrl     string            `json:"ExampleUrl,omitempty"`
	SingleExample  string            `json:"SingleExample,omitempty"`
	Examples       []string          `json:"Examples,omitempty"` // proves sample examples to call things correctly
	ExcludeOptions *ExcludingOptions `json:"ExcludeOptions,omitempty"`
	// contains filtered or unexported fields
}

func (Info) AsJsonContractsBinder

func (it Info) AsJsonContractsBinder() corejson.JsonContractsBinder

func (Info) Clone

func (it Info) Clone() Info

func (*Info) ClonePtr

func (it *Info) ClonePtr() *Info

func (*Info) Deserialize added in v1.3.30

func (it *Info) Deserialize(toPtr interface{}) (parsingErr error)

func (*Info) ExamplesAsSlice added in v1.3.33

func (it *Info) ExamplesAsSlice() *corestr.SimpleSlice

func (*Info) ExamplesAsString added in v1.3.30

func (it *Info) ExamplesAsString() (compiledString string)

func (*Info) HasAnyItem

func (it *Info) HasAnyItem() bool

func (*Info) HasAnyName

func (it *Info) HasAnyName() bool

func (*Info) HasChainingExample added in v1.3.30

func (it *Info) HasChainingExample() bool

func (*Info) HasDescription added in v1.3.30

func (it *Info) HasDescription() bool

func (*Info) HasErrorUrl added in v1.3.30

func (it *Info) HasErrorUrl() bool

func (*Info) HasExampleUrl added in v1.3.30

func (it *Info) HasExampleUrl() bool

func (*Info) HasExamples added in v1.3.30

func (it *Info) HasExamples() bool

func (*Info) HasExcludeOptions added in v1.3.30

func (it *Info) HasExcludeOptions() bool

func (*Info) HasHintUrl added in v1.3.30

func (it *Info) HasHintUrl() bool

func (*Info) HasRootName added in v1.3.30

func (it *Info) HasRootName() bool

func (*Info) HasUrl added in v1.3.30

func (it *Info) HasUrl() bool

func (*Info) IsDefined

func (it *Info) IsDefined() bool

func (*Info) IsEmpty

func (it *Info) IsEmpty() bool

func (*Info) IsEmptyDescription added in v1.3.30

func (it *Info) IsEmptyDescription() bool

func (*Info) IsEmptyErrorUrl added in v1.3.30

func (it *Info) IsEmptyErrorUrl() bool

func (*Info) IsEmptyExampleUrl added in v1.3.30

func (it *Info) IsEmptyExampleUrl() bool

func (*Info) IsEmptyExamples added in v1.3.30

func (it *Info) IsEmptyExamples() bool

func (*Info) IsEmptyExcludeOptions added in v1.3.30

func (it *Info) IsEmptyExcludeOptions() bool

func (*Info) IsEmptyHintUrl added in v1.3.30

func (it *Info) IsEmptyHintUrl() bool

func (*Info) IsEmptyName added in v1.3.30

func (it *Info) IsEmptyName() bool

func (*Info) IsEmptySingleExample added in v1.3.30

func (it *Info) IsEmptySingleExample() bool

func (*Info) IsEmptyUrl added in v1.3.30

func (it *Info) IsEmptyUrl() bool

func (*Info) IsExcludeAdditionalErrorWrap added in v1.3.34

func (it *Info) IsExcludeAdditionalErrorWrap() bool

IsExcludeAdditionalErrorWrap

returns true on defined (not null) and
it.ExcludeOptions.IsExcludeAdditionalErrorWrap

return false on null

func (*Info) IsExcludeDescription added in v1.3.34

func (it *Info) IsExcludeDescription() bool

IsExcludeDescription

returns true on defined (not null) and
it.ExcludeOptions.IsExcludeDescription

return false on null

func (*Info) IsExcludeErrorUrl added in v1.3.34

func (it *Info) IsExcludeErrorUrl() bool

IsExcludeErrorUrl

returns true on defined (not null) and
it.ExcludeOptions.IsExcludeErrorUrl

return false on null

func (*Info) IsExcludeExampleUrl added in v1.3.34

func (it *Info) IsExcludeExampleUrl() bool

IsExcludeExampleUrl

return true on null

func (*Info) IsExcludeExamples added in v1.3.34

func (it *Info) IsExcludeExamples() bool

IsExcludeExamples

return true on null

func (*Info) IsExcludeHintUrl added in v1.3.34

func (it *Info) IsExcludeHintUrl() bool

IsExcludeHintUrl

returns true on defined (not null) and
it.ExcludeOptions.IsExcludeHintUrl

return false on null

func (*Info) IsExcludePayload added in v1.3.35

func (it *Info) IsExcludePayload() bool

func (*Info) IsExcludeRootName added in v1.3.34

func (it *Info) IsExcludeRootName() bool

IsExcludeRootName

returns true on defined (not null) and
it.ExcludeOptions.IsExcludeRootName

return false on null

func (*Info) IsExcludeSingleExample added in v1.3.34

func (it *Info) IsExcludeSingleExample() bool

IsExcludeSingleExample

return true on null

func (*Info) IsExcludeUrl added in v1.3.34

func (it *Info) IsExcludeUrl() bool

IsExcludeUrl

returns true on defined (not null) and
it.ExcludeOptions.IsExcludeUrl

return false on null

func (*Info) IsIncludeAdditionalErrorWrap

func (it *Info) IsIncludeAdditionalErrorWrap() bool

IsIncludeAdditionalErrorWrap

returns true on null or it.ExcludeOptions.IsIncludeAdditionalErrorWrap

func (*Info) IsIncludeDescription

func (it *Info) IsIncludeDescription() bool

func (*Info) IsIncludeErrorUrl

func (it *Info) IsIncludeErrorUrl() bool

func (*Info) IsIncludeExampleUrl

func (it *Info) IsIncludeExampleUrl() bool

func (*Info) IsIncludeExamples

func (it *Info) IsIncludeExamples() bool

func (*Info) IsIncludeHintUrl

func (it *Info) IsIncludeHintUrl() bool

func (*Info) IsIncludePayloads

func (it *Info) IsIncludePayloads() bool

func (*Info) IsIncludeRootName

func (it *Info) IsIncludeRootName() bool

func (*Info) IsIncludeSingleExample added in v1.3.30

func (it *Info) IsIncludeSingleExample() bool

func (*Info) IsIncludeUrl

func (it *Info) IsIncludeUrl() bool

func (*Info) IsName

func (it *Info) IsName(name string) bool

func (*Info) IsNull

func (it *Info) IsNull() bool

func (*Info) IsPlainText

func (it *Info) IsPlainText() bool

func (*Info) IsSecure

func (it *Info) IsSecure() bool

func (Info) Json

func (it Info) Json() corejson.Result

func (*Info) JsonParseSelfInject

func (it *Info) JsonParseSelfInject(
	jsonResult *corejson.Result,
) error

func (Info) JsonPtr

func (it Info) JsonPtr() *corejson.Result

func (Info) JsonString

func (it Info) JsonString() string

func (Info) JsonStringMust

func (it Info) JsonStringMust() string

func (*Info) LazyMap added in v1.3.30

func (it *Info) LazyMap() map[string]string

func (*Info) LazyMapPrettyJsonString added in v1.3.30

func (it *Info) LazyMapPrettyJsonString() string

func (*Info) LazyMapWithPayload added in v1.3.35

func (it *Info) LazyMapWithPayload(
	payloads []byte,
) map[string]string

func (*Info) LazyMapWithPayloadAsAny added in v1.3.35

func (it *Info) LazyMapWithPayloadAsAny(
	payloadsAny interface{},
) map[string]string

func (*Info) Map added in v1.3.30

func (it *Info) Map() map[string]string

func (*Info) MapWithPayload added in v1.3.31

func (it *Info) MapWithPayload(
	payloads []byte,
) map[string]string

func (*Info) MapWithPayloadAsAny added in v1.3.35

func (it *Info) MapWithPayloadAsAny(
	payloadsAny interface{},
) map[string]string

func (*Info) Name

func (it *Info) Name() string

func (*Info) Options

func (it *Info) Options() *ExcludingOptions

func (*Info) PrettyJsonString added in v1.3.30

func (it *Info) PrettyJsonString() string

func (*Info) PrettyJsonStringWithPayloads added in v1.3.31

func (it *Info) PrettyJsonStringWithPayloads(
	payloads []byte,
) string

func (*Info) SafeChainingExample added in v1.3.30

func (it *Info) SafeChainingExample() string

func (*Info) SafeDescription added in v1.3.30

func (it *Info) SafeDescription() string

func (*Info) SafeErrorUrl added in v1.3.30

func (it *Info) SafeErrorUrl() string

func (*Info) SafeExampleUrl added in v1.3.30

func (it *Info) SafeExampleUrl() string

func (*Info) SafeHintUrl added in v1.3.30

func (it *Info) SafeHintUrl() string

func (*Info) SafeName added in v1.3.30

func (it *Info) SafeName() string

func (*Info) SafeUrl added in v1.3.30

func (it *Info) SafeUrl() string

func (*Info) Serialize added in v1.3.30

func (it *Info) Serialize() ([]byte, error)

func (*Info) SetPlain added in v1.3.33

func (it *Info) SetPlain() *Info

SetPlain

on nil creates and returns
new info which is plain not secure

func (*Info) SetSecure added in v1.3.30

func (it *Info) SetSecure() *Info

SetSecure

on nil creates and returns new info with secure flag

func (*Info) String

func (it *Info) String() string

func (Info) ToNonPtr

func (it Info) ToNonPtr() Info

func (Info) ToPtr

func (it Info) ToPtr() *Info

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL