contextutil

Documentation

Index

• Constants
• func Account(ctx context.Context) (config.Account, error)
• func AccountDID(ctx context.Context) (identity.DID, error)
• func Context(ctx context.Context, cs config.Service) (context.Context, error)
• func Copy(ctx context.Context) context.Context
• func DIDFromContext(ctx context.Context) (did identity.DID, err error)
• func Job(ctx context.Context) jobs.JobID
• func New(ctx context.Context, cfg config.Account) (context.Context, error)
• func Nonce(ctx context.Context) (uint32, error)
• func WithJob(ctx context.Context, jobID jobs.JobID) context.Context
• func WithNonce(ctx context.Context, n uint32) context.Context

Constants

const (
	// ErrSelfNotFound must be used when self value is not found in the context
	ErrSelfNotFound = errors.Error("self value not found in the context")

	// ErrNonceNotFound must be used when nonce value is not found in context
	ErrNonceNotFound = errors.Error("nonce value not found in the context")

	// ErrDIDMissingFromContext sentinel error when did is missing from the context.
	ErrDIDMissingFromContext = errors.Error("failed to extract did from context")
)

Functions

func Account

func Account(ctx context.Context) (config.Account, error)

Account extracts the TenantConfig from the given context value

func AccountDID

func AccountDID(ctx context.Context) (identity.DID, error)

AccountDID extracts the AccountConfig DID from the given context value

func Context

func Context(ctx context.Context, cs config.Service) (context.Context, error)

Context updates a context with account info using the configstore, must only be used for api handlers

func Copy

func Copy(ctx context.Context) context.Context

Copy creates a copy of the given context with relevant values

func DIDFromContext

func DIDFromContext(ctx context.Context) (did identity.DID, err error)

DIDFromContext returns did from the context.

func Job

func Job(ctx context.Context) jobs.JobID

Job returns current jobID

func New

func New(ctx context.Context, cfg config.Account) (context.Context, error)

New creates new instance of the request headers.

func Nonce

func Nonce(ctx context.Context) (uint32, error)

Nonce extracts the nonce value from the given context

func WithJob

func WithJob(ctx context.Context, jobID jobs.JobID) context.Context

WithJob returns a context with Job ID

func WithNonce

func WithNonce(ctx context.Context, n uint32) context.Context

WithNonce returns a context with Nonce value