nexus

package

Go to main page

Versions in this module

v0

v0.1.1

Jan 14, 2025

Changes in this version

type HandlerStartOperationResultSync

+ Links []Link

v0.1.0

Dec 9, 2024

Changes in this version

type CompletionHandlerOptions

+ FailureConverter FailureConverter

type CompletionRequest

+ Error error

+ Links []Link

+ type FailureConverter interface

+ ErrorToFailure func(error) Failure

+ FailureToError func(Failure) error

+ func DefaultFailureConverter() FailureConverter

+ type FailureError struct

+ Failure Failure

+ func (e *FailureError) Error() string

+ type HTTPClient struct

+ func NewHTTPClient(options HTTPClientOptions) (*HTTPClient, error)

+ func (c *HTTPClient) ExecuteOperation(ctx context.Context, operation string, input any, ...) (*LazyValue, error)

+ func (c *HTTPClient) NewHandle(operation string, operationID string) (*OperationHandle[*LazyValue], error)

+ func (c *HTTPClient) StartOperation(ctx context.Context, operation string, input any, ...) (*ClientStartOperationResult[*LazyValue], error)

+ type HTTPClientOptions struct

+ BaseURL string

+ FailureConverter FailureConverter

+ HTTPCaller func(*http.Request) (*http.Response, error)

+ Serializer Serializer

+ Service string

type HandlerError

+ Cause error

+ func (e *HandlerError) Unwrap() error

type HandlerOptions

+ FailureConverter FailureConverter

type OperationCompletionSuccessful

+ Links []Link

+ Reader *Reader

type OperationCompletionSuccessfulOptions

+ Links []Link

type OperationCompletionUnsuccessful

+ Links []Link

+ func NewOperationCompletionUnsuccessful(error *UnsuccessfulOperationError, ...) (*OperationCompletionUnsuccessful, error)

+ type OperationCompletionUnsuccessfulOptions struct

+ FailureConverter FailureConverter

+ Links []Link

+ OperationID string

+ StartTime time.Time

type Serializer

+ func DefaultSerializer() Serializer

type UnexpectedResponseError

+ Details any

type UnsuccessfulOperationError

+ Cause error

+ func NewCanceledOperationError(err error) *UnsuccessfulOperationError

+ func NewFailedOperationError(err error) *UnsuccessfulOperationError

+ func (e *UnsuccessfulOperationError) Unwrap() error

v0.0.12

Nov 27, 2024

Changes in this version

+ const HeaderOperationID

type CompletionRequest

+ OperationID string

+ StartLinks []Link

+ StartTime time.Time

type Header

+ func (h Header) Set(k, v string)

type OperationCompletionSuccessful

+ OperationID string

+ StartLinks []Link

+ StartTime time.Time

type OperationCompletionSuccessfulOptions

+ OperationID string

+ StartLinks []Link

+ StartTime time.Time

type OperationCompletionUnsuccessful

+ OperationID string

+ StartLinks []Link

+ StartTime time.Time

v0.0.11

Oct 23, 2024

Changes in this version

+ const HeaderOperationTimeout

+ const StatusUpstreamTimeout

type HandlerErrorType

+ const HandlerErrorTypeUpstreamTimeout

+ type OperationCompletionSuccessfulOptions struct

+ Serializer Serializer

type OperationReference

+ InputType func() reflect.Type

+ OutputType func() reflect.Type

type Service

+ func (s *Service) Operation(name string) RegisterableOperation

type UnimplementedOperation

+ func (*UnimplementedOperation[I, O]) InputType() reflect.Type

+ func (*UnimplementedOperation[I, O]) OutputType() reflect.Type

v0.0.10

Aug 23, 2024

Changes in this version

type ClientStartOperationResult

+ Links []Link

type ExecuteOperationOptions

+ Links []Link

type HandlerStartOperationResultAsync

+ Links []Link

+ type Link struct

+ Type string

+ URL *url.URL

type StartOperationOptions

+ Links []Link

v0.0.9

Jul 22, 2024

v0.0.8

Jun 17, 2024

Changes in this version

+ const HeaderRequestTimeout

type ClientOptions

+ BaseURL string

+ Service string

type LazyValue

+ func NewLazyValue(serializer Serializer, reader *Reader) *LazyValue

+ type Service struct

+ Name string

+ func NewService(name string) *Service

+ func (s *Service) Register(operations ...RegisterableOperation) error

+ type ServiceRegistry struct

+ func NewServiceRegistry() *ServiceRegistry

+ func (r *ServiceRegistry) NewHandler() (Handler, error)

+ func (r *ServiceRegistry) Register(services ...*Service) error

v0.0.7

Mar 21, 2024

Changes in this version

type ExecuteOperationOptions

+ CallbackHeader Header

type HandlerErrorType

+ const HandlerErrorTypeUnauthorized

type StartOperationOptions

+ CallbackHeader Header

v0.0.6

Jan 5, 2024

Changes in this version

type CompletionHandlerOptions

+ Serializer Serializer

type CompletionRequest

+ Result *LazyValue

+ type OperationCompletionSuccesfulOptions struct

+ Serializer Serializer

v0.0.5

Dec 5, 2023

Changes in this version

+ const StatusDownstreamError

+ const StatusDownstreamTimeout

type HandlerErrorType

+ const HandlerErrorTypeResourceExhausted

+ const HandlerErrorTypeUnavailable

v0.0.4

Nov 28, 2023

Changes in this version

type HandlerErrorType

+ const HandlerErrorTypeDownstreamError

v0.0.3

Nov 22, 2023

v0.0.2

Nov 13, 2023

Changes in this version

+ func ExecuteOperation[I, O any](ctx context.Context, client *Client, operation OperationReference[I, O], ...) (O, error)

type ClientOptions

+ Serializer Serializer

+ type ClientStartOperationResult struct

+ Pending *OperationHandle[T]

+ Successful T

+ func StartOperation[I, O any](ctx context.Context, client *Client, operation OperationReference[I, O], ...) (*ClientStartOperationResult[O], error)

+ type Content struct

+ Data []byte

+ Header Header

type HandlerError

+ Type HandlerErrorType

+ func HandlerErrorf(typ HandlerErrorType, format string, args ...any) *HandlerError

+ type HandlerErrorType string

+ const HandlerErrorTypeBadRequest

+ const HandlerErrorTypeDownstreamTimeout

+ const HandlerErrorTypeForbidden

+ const HandlerErrorTypeInternal

+ const HandlerErrorTypeNotFound

+ const HandlerErrorTypeNotImplemented

+ const HandlerErrorTypeUnauthenticated

+ const HandlerErrorTypeUpstreamError

type HandlerOptions

+ Serializer Serializer

+ type HandlerStartOperationResult interface

+ type HandlerStartOperationResultAsync struct

+ OperationID string

+ type HandlerStartOperationResultSync struct

+ Value T

+ type Header map[string]string

+ func (h Header) Get(k string) string

+ type LazyValue struct

+ Reader *Reader

+ func (l *LazyValue) Consume(v any) error

+ type NoValue *struct

+ type Operation interface

+ Cancel func(context.Context, string, CancelOperationOptions) error

+ GetInfo func(context.Context, string, GetOperationInfoOptions) (*OperationInfo, error)

+ GetResult func(context.Context, string, GetOperationResultOptions) (O, error)

+ Start func(context.Context, I, StartOperationOptions) (HandlerStartOperationResult[O], error)

+ func NewSyncOperation[I, O any](name string, ...) Operation[I, O]

type OperationHandle

+ func NewHandle[I, O any](client *Client, operation OperationReference[I, O], operationID string) (*OperationHandle[O], error)

+ type OperationReference interface

+ Name func() string

+ func NewOperationReference[I, O any](name string) OperationReference[I, O]

+ type OperationRegistry struct

+ func (r *OperationRegistry) Register(operations ...RegisterableOperation) error

+ func (r OperationRegistry) NewHandler() (Handler, error)

+ type Reader struct

+ Header Header

+ type RegisterableOperation interface

+ Name func() string

+ type Serializer interface

+ Deserialize func(*Content, any) error

+ Serialize func(any) (*Content, error)

+ type UnimplementedOperation struct

+ func (*UnimplementedOperation[I, O]) Cancel(context.Context, string, CancelOperationOptions) error

+ func (*UnimplementedOperation[I, O]) GetInfo(context.Context, string, GetOperationInfoOptions) (*OperationInfo, error)

+ func (*UnimplementedOperation[I, O]) GetResult(context.Context, string, GetOperationResultOptions) (O, error)

+ func (h *UnimplementedOperation[I, O]) Start(ctx context.Context, input I, options StartOperationOptions) (HandlerStartOperationResult[O], error)

v0.0.1

Sep 12, 2023

Changes in this version

+ var ErrOperationStillRunning = errors.New("operation still running")

+ func NewCompletionHTTPHandler(options CompletionHandlerOptions) http.Handler

+ func NewCompletionHTTPRequest(ctx context.Context, url string, completion OperationCompletion) (*http.Request, error)

+ func NewHTTPHandler(options HandlerOptions) http.Handler

+ type CancelOperationOptions struct

+ Header http.Header

+ type CancelOperationRequest struct

+ HTTPRequest *http.Request

+ Operation string

+ OperationID string

+ type Client struct

+ func NewClient(options ClientOptions) (*Client, error)

+ func (c *Client) ExecuteOperation(ctx context.Context, request ExecuteOperationOptions) (*http.Response, error)

+ func (c *Client) NewHandle(operation string, operationID string) (*OperationHandle, error)

+ func (c *Client) StartOperation(ctx context.Context, options StartOperationOptions) (*StartOperationResult, error)

+ type ClientOptions struct

+ HTTPCaller func(*http.Request) (*http.Response, error)

+ ServiceBaseURL string

+ type CompletionHandler interface

+ CompleteOperation func(context.Context, *CompletionRequest) error

+ type CompletionHandlerOptions struct

+ Handler CompletionHandler

+ Logger *slog.Logger

+ Marshaler func(any) ([]byte, error)

+ type CompletionRequest struct

+ Failure *Failure

+ HTTPRequest *http.Request

+ State OperationState

+ type ExecuteOperationOptions struct

+ Body io.Reader

+ CallbackURL string

+ Header http.Header

+ Operation string

+ RequestID string

+ Wait time.Duration

+ func NewExecuteOperationOptions(operation string, v any) (options ExecuteOperationOptions, err error)

+ type Failure struct

+ Details json.RawMessage

+ Message string

+ Metadata map[string]string

+ type GetOperationInfoOptions struct

+ Header http.Header

+ type GetOperationInfoRequest struct

+ HTTPRequest *http.Request

+ Operation string

+ OperationID string

+ type GetOperationResultOptions struct

+ Header http.Header

+ Wait time.Duration

+ type GetOperationResultRequest struct

+ HTTPRequest *http.Request

+ Operation string

+ OperationID string

+ Wait time.Duration

+ type Handler interface

+ CancelOperation func(context.Context, *CancelOperationRequest) error

+ GetOperationInfo func(context.Context, *GetOperationInfoRequest) (*OperationInfo, error)

+ GetOperationResult func(context.Context, *GetOperationResultRequest) (*OperationResponseSync, error)

+ StartOperation func(context.Context, *StartOperationRequest) (OperationResponse, error)

+ type HandlerError struct

+ Failure *Failure

+ StatusCode int

+ func (e *HandlerError) Error() string

+ type HandlerOptions struct

+ GetResultTimeout time.Duration

+ Handler Handler

+ Logger *slog.Logger

+ type OperationCompletion interface

+ type OperationCompletionSuccessful struct

+ Body io.Reader

+ Header http.Header

+ func NewOperationCompletionSuccessful(v any) (*OperationCompletionSuccessful, error)

+ type OperationCompletionUnsuccessful struct

+ Failure *Failure

+ Header http.Header

+ State OperationState

+ type OperationHandle struct

+ ID string

+ Operation string

+ func (h *OperationHandle) Cancel(ctx context.Context, options CancelOperationOptions) error

+ func (h *OperationHandle) GetInfo(ctx context.Context, options GetOperationInfoOptions) (*OperationInfo, error)

+ func (h *OperationHandle) GetResult(ctx context.Context, options GetOperationResultOptions) (*http.Response, error)

+ type OperationInfo struct

+ ID string

+ State OperationState

+ type OperationResponse interface

+ type OperationResponseAsync struct

+ OperationID string

+ type OperationResponseSync struct

+ Body io.Reader

+ Header http.Header

+ func NewOperationResponseSync(v any) (*OperationResponseSync, error)

+ type OperationState string

+ const OperationStateCanceled

+ const OperationStateFailed

+ const OperationStateRunning

+ const OperationStateSucceeded

+ type StartOperationOptions struct

+ Body io.Reader

+ CallbackURL string

+ Header http.Header

+ Operation string

+ RequestID string

+ func NewStartOperationOptions(operation string, v any) (options StartOperationOptions, err error)

+ type StartOperationRequest struct

+ CallbackURL string

+ HTTPRequest *http.Request

+ Operation string

+ RequestID string

+ type StartOperationResult struct

+ Pending *OperationHandle

+ Successful *http.Response

+ type UnexpectedResponseError struct

+ Failure *Failure

+ Message string

+ Response *http.Response

+ func (e *UnexpectedResponseError) Error() string

+ type UnimplementedHandler struct

+ func (h *UnimplementedHandler) CancelOperation(ctx context.Context, request *CancelOperationRequest) error

+ func (h *UnimplementedHandler) GetOperationInfo(ctx context.Context, request *GetOperationInfoRequest) (*OperationInfo, error)

+ func (h *UnimplementedHandler) GetOperationResult(ctx context.Context, request *GetOperationResultRequest) (*OperationResponseSync, error)

+ func (h *UnimplementedHandler) StartOperation(ctx context.Context, request *StartOperationRequest) (OperationResponse, error)

+ type UnsuccessfulOperationError struct

+ Failure Failure

+ State OperationState

+ func (e *UnsuccessfulOperationError) Error() string

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