shared

Documentation

Index

• Constants
• func Delay(ctx context.Context, delay time.Duration) error
• func ExtractModuleName(clientName string) (string, string, error)
• func NonRetriableError(err error) error
• func RetryAfter(resp *http.Response) time.Duration
• func TypeOfT[T any]() reflect.Type
• func ValidateModVer(moduleVersion string) error
• type CtxAPINameKey
• type CtxIncludeResponseKey
• type CtxWithHTTPHeaderKey
• type CtxWithRetryOptionsKey
• type CtxWithTracingTracer
• type TransportFunc
  • func (pf TransportFunc) Do(req *http.Request) (*http.Response, error)

Constants

const (
	ContentTypeAppJSON   = "application/json"
	ContentTypeAppXML    = "application/xml"
	ContentTypeTextPlain = "text/plain"
)

const (
	HeaderAuthorization          = "Authorization"
	HeaderAuxiliaryAuthorization = "x-ms-authorization-auxiliary"
	HeaderAzureAsync             = "Azure-AsyncOperation"
	HeaderContentLength          = "Content-Length"
	HeaderContentType            = "Content-Type"
	HeaderFakePollerStatus       = "Fake-Poller-Status"
	HeaderLocation               = "Location"
	HeaderOperationLocation      = "Operation-Location"
	HeaderRetryAfter             = "Retry-After"
	HeaderUserAgent              = "User-Agent"
	HeaderWWWAuthenticate        = "WWW-Authenticate"
	HeaderXMSClientRequestID     = "x-ms-client-request-id"
	HeaderXMSRequestID           = "x-ms-request-id"
	HeaderXMSErrorCode           = "x-ms-error-code"
)

const (
	// Module is the name of the calling module used in telemetry data.
	Module = "azcore"

	// Version is the semantic version (see http://semver.org) of this module.
	Version = "v1.8.0-beta.1"
)

const BearerTokenPrefix = "Bearer "

Functions

func Delay

func Delay(ctx context.Context, delay time.Duration) error

Delay waits for the duration to elapse or the context to be cancelled.

func ExtractModuleName

func ExtractModuleName(clientName string) (string, string, error)

ExtractModuleName returns "module", "package.Client" from "module/package.Client" or "package", "package.Client" from "package.Client" when there's no "module/" prefix. If clientName is malformed, an error is returned.

func NonRetriableError

func NonRetriableError(err error) error

NonRetriableError marks the specified error as non-retriable.

func RetryAfter

func RetryAfter(resp *http.Response) time.Duration

RetryAfter returns non-zero if the response contains a Retry-After header value.

func TypeOfT

func TypeOfT[T any]() reflect.Type

TypeOfT returns the type of the generic type param.

func ValidateModVer

func ValidateModVer(moduleVersion string) error

ValidateModVer verifies that moduleVersion is a valid semver 2.0 string.

Types

type CtxAPINameKey

type CtxAPINameKey struct{}

CtxAPINameKey is used as a context key for adding/retrieving the API name.

type CtxIncludeResponseKey

type CtxIncludeResponseKey struct{}

CtxIncludeResponseKey is used as a context key for retrieving the raw response.

type CtxWithHTTPHeaderKey

type CtxWithHTTPHeaderKey struct{}

CtxWithHTTPHeaderKey is used as a context key for adding/retrieving http.Header.

type CtxWithRetryOptionsKey

type CtxWithRetryOptionsKey struct{}

CtxWithRetryOptionsKey is used as a context key for adding/retrieving RetryOptions.

type CtxWithTracingTracer

type CtxWithTracingTracer struct{}

CtxWithTracingTracer is used as a context key for adding/retrieving tracing.Tracer.

type TransportFunc

type TransportFunc func(*http.Request) (*http.Response, error)

TransportFunc is a helper to use a first-class func to satisfy the Transporter interface.

func (TransportFunc) Do

func (pf TransportFunc) Do(req *http.Request) (*http.Response, error)

Do implements the Transporter interface for the TransportFunc type.