snyk_errors

Documentation

Overview

* © 2024 Snyk Limited * * Licensed under the Apache License, Version 2.0 (the 'License'); * you may not use this file except in compliance with the License. * You may obtain a copy of the License at * * https://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, software * distributed under the License is distributed on an 'AS IS' BASIS, * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. * See the License for the specific language governing permissions and * limitations under the License.

* © 2024 Snyk Limited * * Licensed under the Apache License, Version 2.0 (the 'License'); * you may not use this file except in compliance with the License. * You may obtain a copy of the License at * * https://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, software * distributed under the License is distributed on an 'AS IS' BASIS, * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. * See the License for the specific language governing permissions and * limitations under the License.

Index

• type Error
  • func (e Error) Error() string
  • func (e Error) MarshalToJSONAPIError(w io.Writer, instance string) error
  • func (e Error) Unwrap() error
• type Option
  • func WithCause(cause error) Option
  • func WithLogs(logs []string) Option
  • func WithMeta(key string, value any) Option

Types

type Error

type Error struct {
	ID             string
	Type           string
	Title          string
	StatusCode     int
	ErrorCode      string
	Description    string
	Level          string
	Links          []string
	Detail         string
	Meta           map[string]any
	Cause          error
	Classification string
	Logs           []string
}

func (Error) Error

func (e Error) Error() string

func (Error) MarshalToJSONAPIError

func (e Error) MarshalToJSONAPIError(w io.Writer, instance string) error

func (Error) Unwrap

func (e Error) Unwrap() error

type Option

type Option func(e *Error)

func WithCause

func WithCause(cause error) Option

func WithLogs

func WithLogs(logs []string) Option

func WithMeta

func WithMeta(key string, value any) Option