extension

Documentation

Index

• func EncodeRouting(tag string, otherTags ...string) (raw []byte, err error)
• func IsAuthTypeLengthExceed(err error) bool
• func IsInvalidAuthenticationBytes(err error) bool
• func ParseRoutingTags(bs []byte) (tags []string, err error)
• type Authentication
  • func MustNewAuthentication(authType string, payload []byte) *Authentication
  • func NewAuthentication(authType string, payload []byte) (*Authentication, error)
  • func ParseAuthentication(raw []byte) (auth *Authentication, err error)
  • func (a Authentication) Bytes() (raw []byte)
  • func (a Authentication) IsWellKnown() (ok bool)
  • func (a Authentication) Payload() []byte
  • func (a Authentication) Type() string
• type CompositeMetadata
  • func NewCompositeMetadataBytes(raw []byte) CompositeMetadata
  • func (c CompositeMetadata) Scanner() *CompositeMetadataScanner
• type CompositeMetadataBuilder
  • func NewCompositeMetadataBuilder() *CompositeMetadataBuilder
  • func (c *CompositeMetadataBuilder) Build() (CompositeMetadata, error)
  • func (c *CompositeMetadataBuilder) Push(mimeType string, metadata []byte) *CompositeMetadataBuilder
  • func (c *CompositeMetadataBuilder) PushString(mimeType string, metadata string) *CompositeMetadataBuilder
  • func (c *CompositeMetadataBuilder) PushWellKnown(mimeType MIME, metadata []byte) *CompositeMetadataBuilder
  • func (c *CompositeMetadataBuilder) PushWellKnownString(mimeType MIME, metadata string) *CompositeMetadataBuilder
• type CompositeMetadataScanner
  • func (c *CompositeMetadataScanner) Metadata() (mimeType string, metadata []byte, err error)
  • func (c *CompositeMetadataScanner) MetadataUTF8() (mimeType string, metadata string, err error)
  • func (c *CompositeMetadataScanner) Scan() bool
• type MIME
  • func ParseMIME(str string) (mime MIME, ok bool)
  • func (p MIME) String() string

Functions

func EncodeRouting

func EncodeRouting(tag string, otherTags ...string) (raw []byte, err error)

EncodeRouting encode routing tags to raw bytes.

func IsAuthTypeLengthExceed

func IsAuthTypeLengthExceed(err error) bool

IsAuthTypeLengthExceed returns true if input error is for AuthType length exceed.

func IsInvalidAuthenticationBytes

func IsInvalidAuthenticationBytes(err error) bool

IsInvalidAuthenticationBytes returns true if input error is for invalid bytes.

func ParseRoutingTags

func ParseRoutingTags(bs []byte) (tags []string, err error)

ParseRoutingTags parse routing tags in metadata. See: https://github.com/rsocket/rsocket/blob/master/Extensions/Routing.md

Types

type Authentication

type Authentication struct {
	// contains filtered or unexported fields
}

Authentication is a necessary component to any real world application. This extension specification provides a standardized mechanism for including both the type of credentials and the credentials in metadata payloads. https://github.com/rsocket/rsocket/blob/master/Extensions/Security/WellKnownAuthTypes.md

func MustNewAuthentication

func MustNewAuthentication(authType string, payload []byte) *Authentication

MustNewAuthentication creates a new Authentication

func NewAuthentication

func NewAuthentication(authType string, payload []byte) (*Authentication, error)

NewAuthentication creates a new Authentication

func ParseAuthentication

func ParseAuthentication(raw []byte) (auth *Authentication, err error)

ParseAuthentication parse Authentication from raw bytes.

func (Authentication) Bytes

func (a Authentication) Bytes() (raw []byte)

Bytes encodes current Authentication to byte slice.

func (Authentication) IsWellKnown

func (a Authentication) IsWellKnown() (ok bool)

IsWellKnown returns true if Authentication Type is Well-Known.

func (Authentication) Payload

func (a Authentication) Payload() []byte

Payload returns payload in Authentication.

func (Authentication) Type

func (a Authentication) Type() string

Type returns type of Authentication as string.

type CompositeMetadata

type CompositeMetadata []byte

CompositeMetadata provides multi Metadata payloads with different MIME types.

func NewCompositeMetadataBytes

func NewCompositeMetadataBytes(raw []byte) CompositeMetadata

NewCompositeMetadataBytes returns a CompositeMetadata.

func (CompositeMetadata) Scanner

func (c CompositeMetadata) Scanner() *CompositeMetadataScanner

Scanner returns a entry scanner.

type CompositeMetadataBuilder

type CompositeMetadataBuilder struct {
	// contains filtered or unexported fields
}

CompositeMetadataBuilder can be used to build a CompositeMetadata.

func NewCompositeMetadataBuilder

func NewCompositeMetadataBuilder() *CompositeMetadataBuilder

NewCompositeMetadataBuilder returns a CompositeMetadata builder.

func (*CompositeMetadataBuilder) Build

func (c *CompositeMetadataBuilder) Build() (CompositeMetadata, error)

Build build a new CompositeMetadata.

func (*CompositeMetadataBuilder) Push

func (c *CompositeMetadataBuilder) Push(mimeType string, metadata []byte) *CompositeMetadataBuilder

Push push a custom MimeType and metadata bytes.

func (*CompositeMetadataBuilder) PushString

func (c *CompositeMetadataBuilder) PushString(mimeType string, metadata string) *CompositeMetadataBuilder

PushString push a custom MimeType and metadata string.

func (*CompositeMetadataBuilder) PushWellKnown

func (c *CompositeMetadataBuilder) PushWellKnown(mimeType MIME, metadata []byte) *CompositeMetadataBuilder

PushWellKnown push a WellKnownMimeType and metadata bytes.

func (*CompositeMetadataBuilder) PushWellKnownString

func (c *CompositeMetadataBuilder) PushWellKnownString(mimeType MIME, metadata string) *CompositeMetadataBuilder

PushWellKnownString push a WellKnownMimeType and metadata string.

type CompositeMetadataScanner

type CompositeMetadataScanner struct {
	// contains filtered or unexported fields
}

CompositeMetadataScanner can be used to scan entry in CompositeMetadata.

func (*CompositeMetadataScanner) Metadata

func (c *CompositeMetadataScanner) Metadata() (mimeType string, metadata []byte, err error)

Metadata returns current metadata bytes.

func (*CompositeMetadataScanner) MetadataUTF8

func (c *CompositeMetadataScanner) MetadataUTF8() (mimeType string, metadata string, err error)

MetadataUTF8 returns current metadata in utf8 string.

func (*CompositeMetadataScanner) Scan

func (c *CompositeMetadataScanner) Scan() bool

Scan returns true when scanner has more content.

type MIME

type MIME int8

MIME is MIME types in number. Please see: https://github.com/rsocket/rsocket/blob/master/Extensions/WellKnownMimeTypes.md

const (
	ApplicationAvro MIME = iota
	ApplicationCBOR
	ApplicationGraphql
	ApplicationGzip
	ApplicationJavascript
	ApplicationJSON
	ApplicationOctetStream
	ApplicationPDF
	ApplicationThrift
	ApplicationProtobuf
	ApplicationXML
	ApplicationZip
	AudioAAC
	AudioMP3
	AudioMP4
	AudioMPEG3
	AudioMPEG
	AudioOGG
	AudioOpus
	AudioVorbis
	ImageBMP
	ImageGIF
	ImageHEICSequence
	ImageHEIC
	ImageHEIFSequence
	ImageHEIF
	ImageJPEG
	ImagePNG
	ImageTIFF
	MultipartMixed
	TextCSS
	TextCSV
	TextHTML
	TextPlain
	TextXML
	VideoH264
	VideoH265
	VideoVP8
	Hessian
	JavaObject
	CloudEventsJSON
	MessageMimeType          MIME = 0x7A
	MessageAcceptMimeTypes   MIME = 0x7B
	MessageAuthentication    MIME = 0x7C
	MessageZipkin            MIME = 0x7D
	MessageRouting           MIME = 0x7E
	MessageCompositeMetadata MIME = 0x7F
)

All MIMEs

func ParseMIME

func ParseMIME(str string) (mime MIME, ok bool)

ParseMIME parse a string to MIME.

func (MIME) String

func (p MIME) String() string