attr

Documentation

Index

• Constants
• type Scope
  • func IntoScope(scope string) Scope
  • func ParseScope(path string) (Scope, string)
  • func (scope Scope) ConstructScopedZonedPath(zonedPath ZonedPath) ScopedZonedPath
  • func (scope Scope) IsConversation() bool
  • func (scope Scope) IsLocal() bool
  • func (scope Scope) IsPeer() bool
  • func (scope Scope) IsPublic() bool
• type ScopedZonedPath
  • func (szp ScopedZonedPath) ToString() string
• type Zone
  • func ParseZone(path string) (Zone, string)
  • func (zone Zone) ConstructZonedPath(path string) ZonedPath
• type ZonedPath
  • func (zp ZonedPath) ToString() string

Constants

const (
	// on a peer, local and peer supplied data
	LocalScope        = Scope("local")
	PeerScope         = Scope("peer")
	ConversationScope = Scope("conversation")

	// on a local profile, public data and private settings
	PublicScope = Scope("public")

	UnknownScope = Scope("unknown")
)

scopes for attributes

const (

	// ProfileZone for attributes related to profile details like name and profile image
	ProfileZone = Zone("profile")

	// LegacyGroupZone for attributes related to legacy group experiment
	LegacyGroupZone = Zone("legacygroup")

	// FilesharingZone for attributes related to file sharing
	FilesharingZone = Zone("filesharing")

	// ServerKeyZone for attributes related to Server Keys
	ServerKeyZone = Zone("serverkey")

	// ServerZone is for attributes related to the server
	ServerZone = Zone("server")

	// UnknownZone is a catch all useful for error handling
	UnknownZone = Zone("unknown")
)

const Separator = "."

Separator for scope and the rest of path

Types

type Scope

type Scope string

Scope strongly types Scope strings

func IntoScope

func IntoScope(scope string) Scope

IntoScope converts a string to a Scope

func ParseScope

func ParseScope(path string) (Scope, string)

ParseScope takes in an untyped string and returns an explicit Scope along with the rest of the untyped path

func (Scope) ConstructScopedZonedPath

func (scope Scope) ConstructScopedZonedPath(zonedPath ZonedPath) ScopedZonedPath

ConstructScopedZonedPath enforces a scope over a zoned path

func (Scope) IsConversation

func (scope Scope) IsConversation() bool

IsConversation returns true if the scope is a conversation scope

func (Scope) IsLocal

func (scope Scope) IsLocal() bool

IsLocal returns true if the scope is a local scope

func (Scope) IsPeer

func (scope Scope) IsPeer() bool

IsPeer returns true if the scope is a peer scope

func (Scope) IsPublic

func (scope Scope) IsPublic() bool

IsPublic returns true if the scope is a public scope

type ScopedZonedPath

type ScopedZonedPath string

ScopedZonedPath typed path with a scope and a zone

func (ScopedZonedPath) ToString

func (szp ScopedZonedPath) ToString() string

ToString converts a ScopedZonedPath to a string

type Zone

type Zone string

Zone forces attributes to belong to a given subsystem e.g profile or filesharing Note: Zone is different from Scope which deals with public visibility of a given attribute

func ParseZone

func ParseZone(path string) (Zone, string)

ParseZone takes in an untyped string and returns an explicit Zone along with the rest of the untyped path

func (Zone) ConstructZonedPath

func (zone Zone) ConstructZonedPath(path string) ZonedPath

ConstructZonedPath takes a path and attaches a zone to it. Note that this returns a ZonedPath which isn't directly usable, it must be given to ConstructScopedZonedPath in order to be realized into an actual attribute path.

type ZonedPath

type ZonedPath string

ZonedPath explicitly types paths that contain a zone for strongly typed APIs

func (ZonedPath) ToString

func (zp ZonedPath) ToString() string