step

Documentation

Overview

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

Usage:

import "github.com/go-vela/server/router/middleware/step"

Index

• func Establish() gin.HandlerFunc
• func FromContext(c context.Context) *api.Step
• func Retrieve(c *gin.Context) *api.Step
• func ToContext(c Setter, s *api.Step)
• type Setter

Functions

func Establish

func Establish() gin.HandlerFunc

Establish sets the step in the given context.

func FromContext

func FromContext(c context.Context) *api.Step

FromContext returns the Step associated with this context.

func Retrieve

func Retrieve(c *gin.Context) *api.Step

Retrieve gets the step in the given context.

func ToContext

func ToContext(c Setter, s *api.Step)

ToContext adds the Step 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.