utils

Documentation

Index

• Constants
• func AggRateLimits(rlimits []chat1.RateLimit) (res []chat1.RateLimit)
• func AggRateLimitsP(rlimits []*chat1.RateLimit) (res []chat1.RateLimit)
• func AllChatConversationStatuses() (res []chat1.ConversationStatus)
• func Collar(lower int, ideal int, upper int) int
• func FilterByType(msgs []chat1.MessageUnboxed, query *chat1.GetThreadQuery, ...) (res []chat1.MessageUnboxed)
• func GetSupersedes(msg chat1.MessageUnboxed) ([]chat1.MessageID, error)
• func GetUnverifiedConv(ctx context.Context, g *globals.Context, uid gregor1.UID, ...) (chat1.Conversation, *chat1.RateLimit, error)
• func IsConvEmpty(conv chat1.Conversation) bool
• func IsVisibleChatMessageType(messageType chat1.MessageType) bool
• func NewChatTopicID() (id []byte, err error)
• func ParseDurationExtended(s string) (d time.Duration, err error)
• func ParseTimeFromRFC3339OrDurationFromPast(g *globals.Context, s string) (t time.Time, err error)
• func PluckMessageIDs(msgs []chat1.MessageSummary) []chat1.MessageID
• func ReorderParticipants(ctx context.Context, uloader ReorderUsernameSource, tlfname string, ...) (writerNames []string, readerNames []string, err error)
• func VisibleChatConversationStatuses() (res []chat1.ConversationStatus)
• func VisibleChatMessageTypes() []chat1.MessageType
• type BadTLFNameError
  • func (e BadTLFNameError) Error() string
• type ConversationStatusBehavior
  • func GetConversationStatusBehavior(s chat1.ConversationStatus) ConversationStatusBehavior
• type DebugLabeler
  • func NewDebugLabeler(g *globals.Context, label string, verbose bool) DebugLabeler
  • func (d DebugLabeler) Debug(ctx context.Context, msg string, args ...interface{})
  • func (d DebugLabeler) Trace(ctx context.Context, f func() error, msg string) func()
• type NoSuchNameError
  • func (e NoSuchNameError) Error() string
• type NoSuchUserError
  • func (e NoSuchUserError) Error() string
  • func (e NoSuchUserError) ToStatus() keybase1.Status
• type ReorderUsernameSource
• type TlfNameNotCanonical
  • func (e TlfNameNotCanonical) Error() string

Constants

const (
	// ReaderSep is the string that separates readers from writers in a
	// TLF name.
	ReaderSep = "#"

	// TlfHandleExtensionSep is the string that separates the folder
	// participants from an extension suffix in the TLF name.
	TlfHandleExtensionSep = " "

	// PublicUIDName is the name given to keybase1.PublicUID.  This string
	// should correspond to an illegal or reserved Keybase user name.
	PublicUIDName = "_public"
)

const (
	ChatTopicIDLen    = 16
	ChatTopicIDSuffix = 0x20
)

Functions

func AggRateLimits

func AggRateLimits(rlimits []chat1.RateLimit) (res []chat1.RateLimit)

func AggRateLimitsP

func AggRateLimitsP(rlimits []*chat1.RateLimit) (res []chat1.RateLimit)

AggRateLimitsP takes a list of rate limit responses and dedups them to the last one received of each category

func AllChatConversationStatuses

func AllChatConversationStatuses() (res []chat1.ConversationStatus)

func Collar

func Collar(lower int, ideal int, upper int) int

upper bounds takes higher priority

func FilterByType

func FilterByType(msgs []chat1.MessageUnboxed, query *chat1.GetThreadQuery, includeAllErrors bool) (res []chat1.MessageUnboxed)

FilterByType filters messages based on a query. If includeAllErrors then MessageUnboxedError are all returned. Otherwise, they are filtered based on type. Messages whose type cannot be determined are considered errors.

func GetSupersedes

func GetSupersedes(msg chat1.MessageUnboxed) ([]chat1.MessageID, error)

GetSupersedes must be called with a valid msg

func GetUnverifiedConv

func GetUnverifiedConv(ctx context.Context, g *globals.Context, uid gregor1.UID,
	convID chat1.ConversationID, useLocalData bool) (chat1.Conversation, *chat1.RateLimit, error)

func IsConvEmpty

func IsConvEmpty(conv chat1.Conversation) bool

func IsVisibleChatMessageType

func IsVisibleChatMessageType(messageType chat1.MessageType) bool

func NewChatTopicID

func NewChatTopicID() (id []byte, err error)

func ParseDurationExtended

func ParseDurationExtended(s string) (d time.Duration, err error)

parseDurationExtended is like time.ParseDuration, but adds "d" unit. "1d" is one day, defined as 24*time.Hour. Only whole days are supported for "d" unit, but it can be followed by smaller units, e.g., "1d1h".

func ParseTimeFromRFC3339OrDurationFromPast

func ParseTimeFromRFC3339OrDurationFromPast(g *globals.Context, s string) (t time.Time, err error)

func PluckMessageIDs

func PluckMessageIDs(msgs []chat1.MessageSummary) []chat1.MessageID

func ReorderParticipants

func ReorderParticipants(ctx context.Context, uloader ReorderUsernameSource, tlfname string, activeList []gregor1.UID) (writerNames []string, readerNames []string, err error)

Reorder participants based on the order in activeList. Only allows usernames from tlfname in the output. This never fails, worse comes to worst it just returns the split of tlfname.

func VisibleChatConversationStatuses

func VisibleChatConversationStatuses() (res []chat1.ConversationStatus)

Which convs show in the inbox.

func VisibleChatMessageTypes

func VisibleChatMessageTypes() []chat1.MessageType

Types

type BadTLFNameError

type BadTLFNameError struct {
	Name string
}

BadTLFNameError indicates a top-level folder name that has an incorrect format.

func (BadTLFNameError) Error

func (e BadTLFNameError) Error() string

Error implements the error interface for BadTLFNameError.

type ConversationStatusBehavior

type ConversationStatusBehavior struct {
	// Whether to show the conv in the inbox
	ShowInInbox bool
	// Whether sending to this conv sets it back to UNFILED
	SendingRemovesStatus bool
	// Whether any incoming activity sets it back to UNFILED
	ActivityRemovesStatus bool
	// Whether to show desktop notifications
	DesktopNotifications bool
	// Whether to send push notifications
	PushNotifications bool
	// Whether to show as part of badging
	ShowBadges bool
}

ConversationStatusBehavior describes how a ConversationStatus behaves

func GetConversationStatusBehavior

func GetConversationStatusBehavior(s chat1.ConversationStatus) ConversationStatusBehavior

When changing these, be sure to update gregor's postMessage as well

type DebugLabeler

type DebugLabeler struct {
	globals.Contextified
	// contains filtered or unexported fields
}

func NewDebugLabeler

func NewDebugLabeler(g *globals.Context, label string, verbose bool) DebugLabeler

func (DebugLabeler) Debug

func (d DebugLabeler) Debug(ctx context.Context, msg string, args ...interface{})

func (DebugLabeler) Trace

func (d DebugLabeler) Trace(ctx context.Context, f func() error, msg string) func()

type NoSuchNameError

type NoSuchNameError struct {
	Name string
}

NoSuchNameError indicates that the user tried to access a subdirectory entry that doesn't exist.

func (NoSuchNameError) Error

func (e NoSuchNameError) Error() string

Error implements the error interface for NoSuchNameError

type NoSuchUserError

type NoSuchUserError struct {
	Input string
}

NoSuchUserError indicates that the given user couldn't be resolved.

func (NoSuchUserError) Error

func (e NoSuchUserError) Error() string

Error implements the error interface for NoSuchUserError

func (NoSuchUserError) ToStatus

func (e NoSuchUserError) ToStatus() keybase1.Status

ToStatus implements the keybase1.ToStatusAble interface for NoSuchUserError

type ReorderUsernameSource

type ReorderUsernameSource interface {
	LookupUsername(ctx context.Context, uid keybase1.UID) (libkb.NormalizedUsername, error)
}

type TlfNameNotCanonical

type TlfNameNotCanonical struct {
	Name, NameToTry string
}

TlfNameNotCanonical indicates that a name isn't a canonical, and that another (not necessarily canonical) name should be tried.

func (TlfNameNotCanonical) Error

func (e TlfNameNotCanonical) Error() string