user

Documentation

Overview

Package user provides the ability for inserting Vela user resources into or extracting Vela user resources from the middleware chain for the API.

Usage:

import "github.com/go-vela/worker/router/middleware/user"

Index

• func Establish() gin.HandlerFunc
• func FromContext(c context.Context) *library.User
• func Retrieve(c *gin.Context) *library.User
• func ToContext(c Setter, u *library.User)
• type Setter

Functions

func Establish

func Establish() gin.HandlerFunc

Establish sets the user in the given context.

func FromContext

func FromContext(c context.Context) *library.User

FromContext returns the User associated with this context.

func Retrieve

func Retrieve(c *gin.Context) *library.User

Retrieve gets the user in the given context.

func ToContext

func ToContext(c Setter, u *library.User)

ToContext adds the User to this context if it supports the Setter interface.

Types

type Setter

type Setter interface {
	Set(string, interface{})
}

Setter defines a context that enables setting values.