utils

Documentation

Overview

Copyright 2023 Northern.tech AS

Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at

    http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.

Index

• Constants
• func ContainsString(val string, vals []string) bool
• func GetTextField(device *model.Device) string
• func IsScopeFullText(scope string) bool
• func JoinURL(base, url string) string
• func MakeLink(link_type string, resource string, query url.Values, page, per_page uint64) string
• func MakePageLinkHdrs(r *rest.Request, page, per_page uint64, has_next bool) []string
• func MsgQueryParmInvalid(name string) string
• func MsgQueryParmLimit(name string) string
• func MsgQueryParmMissing(name string) string
• func MsgQueryParmOneOf(name string, allowed []string) string
• func ParsePagination(r *rest.Request) (uint64, uint64, error)
• func ParseQueryParmBool(r *rest.Request, name string, required bool, def *bool) (*bool, error)
• func ParseQueryParmStr(r *rest.Request, name string, required bool, allowed []string) (string, error)
• func ParseQueryParmUInt(r *rest.Request, name string, required bool, min, max, def uint64) (uint64, error)
• func TextToKeywords(in string) string

Constants

const (
	PageName       = "page"
	PerPageName    = "per_page"
	PageMin        = 1
	PageDefault    = 1
	PerPageMin     = 1
	PerPageMax     = 500
	PerPageDefault = 20
	LinkHdr        = "Link"
	LinkTmpl       = "<%s?%s>; rel=\"%s\""
	LinkPrev       = "prev"
	LinkNext       = "next"
	LinkFirst      = "first"
	DefaultScheme  = "http"
)

pagination constants

Functions

func ContainsString

func ContainsString(val string, vals []string) bool

Check if string is presnt in an array. Would use interface{} but whatever.

func GetTextField

func GetTextField(device *model.Device) string

GetTextField returns the text field for the given device

func IsScopeFullText

func IsScopeFullText(scope string) bool

func JoinURL

func JoinURL(base, url string) string

func MakeLink

func MakeLink(link_type string, resource string, query url.Values, page, per_page uint64) string

func MakePageLinkHdrs

func MakePageLinkHdrs(r *rest.Request, page, per_page uint64, has_next bool) []string

func MsgQueryParmInvalid

func MsgQueryParmInvalid(name string) string

error msgs

func MsgQueryParmLimit

func MsgQueryParmLimit(name string) string

func MsgQueryParmMissing

func MsgQueryParmMissing(name string) string

func MsgQueryParmOneOf

func MsgQueryParmOneOf(name string, allowed []string) string

func ParsePagination

func ParsePagination(r *rest.Request) (uint64, uint64, error)

pagination helpers

func ParseQueryParmBool

func ParseQueryParmBool(r *rest.Request, name string, required bool, def *bool) (*bool, error)

func ParseQueryParmStr

func ParseQueryParmStr(
	r *rest.Request,
	name string,
	required bool,
	allowed []string,
) (string, error)

func ParseQueryParmUInt

func ParseQueryParmUInt(
	r *rest.Request,
	name string,
	required bool,
	min,
	max,
	def uint64,
) (uint64, error)

query param parsing/validation

func TextToKeywords

func TextToKeywords(in string) string

TextToKeywords converts text to keywords for full-text indexing