uri

README

Protocol Documentation

Table of Contents

• uri/uri.proto

  • URI

  • Scheme

Top

uri/uri.proto

URI

URI Uniform Resource Identifier (URI) https://tools.ietf.org/html/rfc3986.

This class is a simple parser which creates the basic component parts (http://tools.ietf.org/html/rfc3986#section-3) with minimal validation and encoding.

   foo://example.com:8042/over/there?name=ferret#nose
   \_/   \______________/\_________/ \_________/ \__/
    |           |            |            |        |
 scheme     authority       path        query   fragment
    |   _____________________|__
   / \ /                        \
   urn:example:animal:ferret:nose

Field	Type	Label	Description
uri	string

Scheme

Scheme is the generic URI syntax scheme. (-- api-linter: core::0126::upper-snake-values=disabled --)

Name	Number	Description
SCHEME_UNSPECIFIED	0	Conventional default for enums. Do not use this.
file	1	File schema of filesystem path.
http	2	HTTP schema of http.
https	3	HTTPS schema of https.

Documentation

Index

• Variables
• type Scheme
  • func (Scheme) Descriptor() protoreflect.EnumDescriptor
  • func (x Scheme) Enum() *Scheme
  • func (Scheme) EnumDescriptor() ([]byte, []int)
  • func (x Scheme) Number() protoreflect.EnumNumber
  • func (x Scheme) String() string
  • func (Scheme) Type() protoreflect.EnumType
• type URI
  • func (*URI) Descriptor() ([]byte, []int)
  • func (x *URI) GetUri() string
  • func (*URI) ProtoMessage()
  • func (x *URI) ProtoReflect() protoreflect.Message
  • func (x *URI) Reset()
  • func (x *URI) String() string

Variables

var (
	Scheme_name = map[int32]string{
		0: "SCHEME_UNSPECIFIED",
		1: "file",
		2: "http",
		3: "https",
	}
	Scheme_value = map[string]int32{
		"SCHEME_UNSPECIFIED": 0,
		"file":               1,
		"http":               2,
		"https":              3,
	}
)

Enum value maps for Scheme.

var File_uri_uri_proto protoreflect.FileDescriptor

Types

type Scheme

type Scheme int32

Scheme is the generic URI syntax scheme. (-- api-linter: core::0126::upper-snake-values=disabled --)

const (
	// Conventional default for enums. Do not use this.
	Scheme_SCHEME_UNSPECIFIED Scheme = 0
	// File schema of filesystem path.
	Scheme_file Scheme = 1
	// HTTP schema of http.
	Scheme_http Scheme = 2
	// HTTPS schema of https.
	Scheme_https Scheme = 3
)

func (Scheme) Descriptor

func (Scheme) Descriptor() protoreflect.EnumDescriptor

func (Scheme) Enum

func (x Scheme) Enum() *Scheme

func (Scheme) EnumDescriptor

func (Scheme) EnumDescriptor() ([]byte, []int)

Deprecated: Use Scheme.Descriptor instead.

func (Scheme) Number

func (x Scheme) Number() protoreflect.EnumNumber

func (Scheme) String

func (x Scheme) String() string

func (Scheme) Type

func (Scheme) Type() protoreflect.EnumType

type URI

type URI struct {
	Uri string `protobuf:"bytes,1,opt,name=uri,proto3" json:"uri,omitempty"`
	// contains filtered or unexported fields
}

URI Uniform Resource Identifier (URI) https://tools.ietf.org/html/rfc3986.

This class is a simple parser which creates the basic component parts (http://tools.ietf.org/html/rfc3986#section-3) with minimal validation and encoding.

  foo://example.com:8042/over/there?name=ferret#nose
  \_/   \______________/\_________/ \_________/ \__/
   |           |            |            |        |
scheme     authority       path        query   fragment
   |   _____________________|__
  / \ /                        \
  urn:example:animal:ferret:nose

func (*URI) Descriptor

func (*URI) Descriptor() ([]byte, []int)

Deprecated: Use URI.ProtoReflect.Descriptor instead.

func (*URI) GetUri

func (x *URI) GetUri() string

func (*URI) ProtoMessage

func (*URI) ProtoMessage()

func (*URI) ProtoReflect

func (x *URI) ProtoReflect() protoreflect.Message

func (*URI) Reset

func (x *URI) Reset()

func (*URI) String

func (x *URI) String() string