id

Documentation

Index

• Variables
• func DecodeUserLocalpart(str string) (string, error)
• func EncodeUserLocalpart(str string) string
• type ContentURI
  • func MustParseContentURI(uri string) ContentURI
  • func ParseContentURI(uri string) (parsed ContentURI, err error)
  • func (uri *ContentURI) CUString() ContentURIString
  • func (uri *ContentURI) IsEmpty() bool
  • func (uri *ContentURI) MarshalJSON() ([]byte, error)
  • func (uri *ContentURI) String() string
  • func (uri *ContentURI) UnmarshalJSON(raw []byte) (err error)
• type ContentURIString
  • func (uriString ContentURIString) Parse() (ContentURI, error)
• type DeviceID
  • func (deviceID DeviceID) String() string
• type DeviceKeyID
  • func NewDeviceKeyID(algorithm string, deviceID DeviceID) DeviceKeyID
  • func (keyID DeviceKeyID) String() string
• type EventID
  • func (eventID EventID) String() string
• type KeyID
  • func NewKeyID(algorithm, keyID string) KeyID
• type RoomAlias
  • func (roomAlias RoomAlias) String() string
• type RoomID
  • func (roomID RoomID) String() string
• type UserID
  • func NewEncodedUserID(localpart, homeserver string) UserID
  • func NewUserID(localpart, homeserver string) UserID
  • func (userID UserID) Parse() (localpart, homeserver string, err error)
  • func (userID UserID) ParseAndDecode() (localpart, homeserver string, err error)
  • func (userID UserID) String() string

Variables

var InvalidContentURI = errors.New("invalid Matrix content URI")

Functions

func DecodeUserLocalpart

func DecodeUserLocalpart(str string) (string, error)

DecodeUserLocalpart decodes the given string back into the original input string. Returns an error if the given string is not a valid user ID localpart encoding. See http://matrix.org/docs/spec/intro.html#mapping-from-other-character-sets

This decodes quoted-printable bytes back into UTF8, and unescapes casing. For example:

_alph=40_bet=5f50up  =>  Alph@Bet_50up

Returns an error if the input string contains characters outside the range "a-z0-9._=-", has an invalid quote-printable byte (e.g. not hex), or has an invalid _ escaped byte (e.g. "_5").

func EncodeUserLocalpart

func EncodeUserLocalpart(str string) string

EncodeUserLocalpart encodes the given string into Matrix-compliant user ID localpart form. See http://matrix.org/docs/spec/intro.html#mapping-from-other-character-sets

This returns a string with only the characters "a-z0-9._=-". The uppercase range A-Z are encoded using leading underscores ("_"). Characters outside the aforementioned ranges (including literal underscores ("_") and equals ("=")) are encoded as UTF8 code points (NOT NCRs) and converted to lower-case hex with a leading "=". For example:

Alph@Bet_50up  => _alph=40_bet=5f50up

Types

type ContentURI

type ContentURI struct {
	Homeserver string
	FileID     string
}

ContentURI represents a Matrix content URI. https://matrix.org/docs/spec/client_server/r0.6.0#matrix-content-mxc-uris

func MustParseContentURI

func MustParseContentURI(uri string) ContentURI

func ParseContentURI

func ParseContentURI(uri string) (parsed ContentURI, err error)

ParseContentURI parses a Matrix content URI.

func (*ContentURI) CUString

func (uri *ContentURI) CUString() ContentURIString

func (*ContentURI) IsEmpty

func (uri *ContentURI) IsEmpty() bool

func (*ContentURI) MarshalJSON

func (uri *ContentURI) MarshalJSON() ([]byte, error)

func (*ContentURI) String

func (uri *ContentURI) String() string

func (*ContentURI) UnmarshalJSON

func (uri *ContentURI) UnmarshalJSON(raw []byte) (err error)

type ContentURIString

type ContentURIString string

ContentURIString is a string that's expected to be a Matrix content URI. It's useful for delaying the parsing of the content URI to move errors from the event content JSON parsing step to a later step where more appropriate errors can be produced.

func (ContentURIString) Parse

func (uriString ContentURIString) Parse() (ContentURI, error)

type DeviceID

type DeviceID string

A DeviceID is an arbitrary string that references a specific device.

func (DeviceID) String

func (deviceID DeviceID) String() string

type DeviceKeyID

type DeviceKeyID string

A DeviceKeyID is a string formatted as <algorithm>:<device_id> that is used as the key in deviceid-key mappings.

func NewDeviceKeyID

func NewDeviceKeyID(algorithm string, deviceID DeviceID) DeviceKeyID

func (DeviceKeyID) String

func (keyID DeviceKeyID) String() string

type EventID

type EventID string

An EventID is a string starting with $ that references a specific event.

https://matrix.org/docs/spec/appendices#room-ids-and-event-ids https://matrix.org/docs/spec/rooms/v4#event-ids

func (EventID) String

func (eventID EventID) String() string

type KeyID

type KeyID string

A KeyID a string formatted as <algorithm>:<key_id> that is used as the key in one-time-key mappings.

func NewKeyID

func NewKeyID(algorithm, keyID string) KeyID

type RoomAlias

type RoomAlias string

A RoomAlias is a string starting with # that can be resolved into. https://matrix.org/docs/spec/appendices#room-aliases

func (RoomAlias) String

func (roomAlias RoomAlias) String() string

type RoomID

type RoomID string

A RoomID is a string starting with ! that references a specific room. https://matrix.org/docs/spec/appendices#room-ids-and-event-ids

func (RoomID) String

func (roomID RoomID) String() string

type UserID

type UserID string

UserID represents a Matrix user ID. https://matrix.org/docs/spec/appendices#user-identifiers

func NewEncodedUserID

func NewEncodedUserID(localpart, homeserver string) UserID

func NewUserID

func NewUserID(localpart, homeserver string) UserID

func (UserID) Parse

func (userID UserID) Parse() (localpart, homeserver string, err error)

Parse parses the user ID into the localpart and server name. See http://matrix.org/docs/spec/intro.html#user-identifiers

func (UserID) ParseAndDecode

func (userID UserID) ParseAndDecode() (localpart, homeserver string, err error)

func (UserID) String

func (userID UserID) String() string