common

Documentation

Overview

Package common contains common functions and types used by BindPlane.

Index

• Constants
• Variables
• func GetHome() string
• func GetProfilesFolder() string
• func ValidatePort(port string) error
• func ValidateURL(urlString string, validSchemes []string) error

Constants

const (
	// ProfilesFolderName is the name of the profiles folder.
	ProfilesFolderName = "profiles"

	// DefaultHomeName is the default directory name for bindplane.
	DefaultHomeName = ".bindplane"

	// DefaultProfileName is the name of the default profile
	DefaultProfileName = "default"

	// HomeEnv is the environment variable for the bindplane home path.
	HomeEnv = "BINDPLANE_CONFIG_HOME"
)

Variables

var (
	// ValidHTTPSchemes are the valid http schemes to be used with ValidateURL function
	ValidHTTPSchemes = []string{"http", "https"}

	// ValidWSSchemes are the valid websocket schemes to be used with ValidateURL function
	ValidWSSchemes = []string{"ws", "wss"}
)

list of valid schemes for different protocols

Functions

func GetHome

func GetHome() string

GetHome returns the bindplane home path.

func GetProfilesFolder

func GetProfilesFolder() string

GetProfilesFolder returns the profiles folder path.

func ValidatePort

func ValidatePort(port string) error

ValidatePort validates the port

func ValidateURL

func ValidateURL(urlString string, validSchemes []string) error

ValidateURL validates the URL and ensures the scheme matches one of the valid schemes in the list