uri

Documentation

Index

• Constants
• Variables
• func Equals(a, b *URI) bool
• func IsValid(str string) bool
• type URI
  • func Must(u *URI, e error) *URI
  • func Parse(s string) (*URI, error)
  • func ParseWithBaseURI(s string, baseURI string) (*URI, error)
  • func (u *URI) GetPath() string
  • func (u *URI) String() string
  • func (u *URI) ValidateBranch() error
  • func (u *URI) ValidateFullyQualified() error
  • func (u *URI) ValidateRef() error
  • func (u *URI) ValidateRepository() error
  • func (u *URI) WithRef(ref string) *URI

Constants

const (
	LakeFSSchema          = "lakefs"
	LakeFSSchemaSeparator = "://"
	PathSeparator         = "/"
)

Variables

var (
	ErrMalformedURI     = errors.New("malformed lakefs URI")
	ErrInvalidRepoURI   = errors.New("not a valid repo URI")
	ErrInvalidRefURI    = errors.New("not a valid ref URI")
	ErrInvalidBranchURI = errors.New("not a valid branch URI")
	ErrInvalidPathURI   = errors.New("not a valid path URI")
)

Functions

func Equals

func Equals(a, b *URI) bool

func IsValid

func IsValid(str string) bool

Types

type URI

type URI struct {
	// Repository is the name of the repository being addressed
	Repository string
	// Ref represents the reference in the repository (commit, tag, branch, etc.)
	Ref string
	// Path is a path to an object (or prefix of such) in lakeFS. It *could* be null since there's a difference between
	// 	an empty path ("lakefs://repo/branch/", and no path at all e.g. "lakefs://repo/branch").
	// 	Since path is the only URI part that is allowed to be empty, it is represented as a pointer.
	Path *string
}

func Must

func Must(u *URI, e error) *URI

func Parse

func Parse(s string) (*URI, error)

func ParseWithBaseURI

func ParseWithBaseURI(s string, baseURI string) (*URI, error)

ParseWithBaseURI parse URI uses base URI as prefix when set and input doesn't start with lakeFS protocol

func (*URI) GetPath

func (u *URI) GetPath() string

func (*URI) String

func (u *URI) String() string

func (*URI) ValidateBranch

func (u *URI) ValidateBranch() error

func (*URI) ValidateFullyQualified

func (u *URI) ValidateFullyQualified() error

func (*URI) ValidateRef

func (u *URI) ValidateRef() error

func (*URI) ValidateRepository

func (u *URI) ValidateRepository() error

func (*URI) WithRef

func (u *URI) WithRef(ref string) *URI

WithRef returns a new URI from u replacing the Reference part with the given ref