kbfs

Documentation

Index

• Constants
• func NormalizeAssertionOrName(s string) (string, error)
• func NormalizeNamesInTLF(writerNames, readerNames []string, extensionSuffix string) (string, error)
• func SplitAndNormalizeTLFName(name string, public bool) (writerNames, readerNames []string, extensionSuffix string, err error)
• type BadTLFNameError
  • func (e BadTLFNameError) Error() string
• type NoSuchNameError
  • func (e NoSuchNameError) Error() string
• type NoSuchUserError
  • func (e NoSuchUserError) Error() string
  • func (e NoSuchUserError) ToStatus() keybase1.Status
• 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"
)

Functions

func NormalizeAssertionOrName

func NormalizeAssertionOrName(s string) (string, error)

TODO: this function can likely be replaced with a call to AssertionParseAndOnly when CORE-2967 and CORE-2968 are fixed.

func NormalizeNamesInTLF

func NormalizeNamesInTLF(writerNames, readerNames []string,
	extensionSuffix string) (string, error)

normalizeNamesInTLF takes a split TLF name and, without doing any resolutions or identify calls, normalizes all elements of the name. It then returns the normalized name.

func SplitAndNormalizeTLFName

func SplitAndNormalizeTLFName(name string, public bool) (
	writerNames, readerNames []string,
	extensionSuffix string, err error)

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 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 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