werror

Documentation

Index

• Variables
• func ErrBadJobMetadata(jobName string, field string) error
• func GetStack(ignoreDepth int) *stack
• func TrySafeErr(err error) (error, int)
• func WithStack(err error) error
• type ErrNoFileName
  • func (e *ErrNoFileName) Error() string
  • func (e *ErrNoFileName) Unwrap() error
• type StackError
  • func Errorf(format string, args ...any) StackError

Variables

var ErrAlreadyWatching = errors.New("trying to watch directory that is already being watched")

var ErrBadAuth = errors.New("auth header format is unexpected")

var ErrBadAuthScheme = errors.New("invalid authorization scheme")

var ErrBadCaster = errors.New("task was given the wrong type of caster")

var ErrBadPassword = clientSafeErr{
	// contains filtered or unexported fields
}

var ErrBadReadCount = errors.New("did not read expected number of bytes from file")

var ErrBadShareType = errors.New("share has a different type than was expected")

var ErrBadTaskType = errors.New("task metadata type is not supported on attempted operation")

var ErrBadTimestamp = clientSafeErr{
	// contains filtered or unexported fields
}

var ErrBadUserOrPass = errors.New("username or password is incorrect")

var ErrBasicAuthFormat = errors.New("did not get expected encoded basic auth format")

var ErrCasterDoubleClose = errors.New("trying to close an already disabled caster")

var ErrChildTaskFailed = errors.New("a task spawned by this task has failed")

var ErrCtxMissingUser = clientSafeErr{/* contains filtered or unexported fields */}

var ErrDirAlreadyExists = clientSafeErr{
	// contains filtered or unexported fields
}

var ErrDirNotAllowed = errors.New("attempted to perform action using a directory, where the action does not support directories")

var ErrDirectoryRequired = errors.New(
	"attempted to perform an action that requires a directory, " +
		"but found regular file",
)

var ErrDuplicateCoreServer = errors.New("cannot add more than one core server to instance service")

var ErrDuplicateLocalServer = errors.New("cannot add local server to instance service, it must already exist")

var ErrEmptyMove = errors.New("refusing to perform move with same filename and same parent")

var ErrEmptyShare = errors.New("share does not expand any permissions")

var ErrEmptyZip = errors.New("cannot create a zip with no files")

var ErrExpectedShareMissing = errors.New("share that was expected to exist was not found")

var ErrFileAlreadyExists = clientSafeErr{
	// contains filtered or unexported fields
}

var ErrFileAlreadyHasTask = errors.New("file already has a task")

var ErrFileNoTask = errors.New("file does not have task")

var ErrFilenameRequired = errors.New("filename is required but is empty")

var ErrInvalidToken = errors.New("session token is invalid")

var ErrJournalServerMismatch = errors.New("journal serverId does not match the lifetime serverId")

var ErrKeyAlreadyExists = errors.New("api key already exists")

var ErrKeyInUse = clientSafeErr{
	// contains filtered or unexported fields
}

var ErrKeyNoServer = errors.New("api key is not associated with a server")

var ErrKeyNotFound = clientSafeErr{
	// contains filtered or unexported fields
}

var ErrMediaAlreadyExists = errors.New("media with given contentId already exists")

var ErrMediaBadMime = errors.New("media has missing or unrecognized mime type")

var ErrMediaHasDuration = errors.New("media of non-video type cannot have a duration")

var ErrMediaNil = errors.New("media is nil")

var ErrMediaNoDimensions = errors.New("media has a missing width or height dimension")

var ErrMediaNoDuration = errors.New("media of video type must have a duration")

var ErrMediaNoFiles = errors.New("media cannot be added with no file ids specified")

var ErrMediaNoId = errors.New("media has no contentId")

var ErrMediaNoPages = errors.New("media must have a page count of at least 1")

var ErrMediaNotVideo = errors.New("media is not a video type")

var ErrNilFile = errors.New("file is required but is nil")

var ErrNoAlbum = clientSafeErr{
	// contains filtered or unexported fields
}

var ErrNoAlbumAccess = clientSafeErr{
	// contains filtered or unexported fields
}

var ErrNoAuth = errors.New("no auth header provided")

var ErrNoBody = errors.New("trying to read http body with no content")

var ErrNoCache = errors.New("could not find or generate requested media cache file")

var ErrNoChildren = errors.New("file does not have any children")

var ErrNoContentId = errors.New("file does not have a content id")

var ErrNoCoreAddress = errors.New("core server cannot be added with no address")

var ErrNoCreator = errors.New("instances must have a creator id")

var ErrNoExiftool = errors.New("exiftool not initialized")

var ErrNoFile = clientSafeErr{
	// contains filtered or unexported fields
}

var ErrNoFileAccess = clientSafeErr{
	// contains filtered or unexported fields
}

var ErrNoFileAction = clientSafeErr{
	// contains filtered or unexported fields
}

var ErrNoFileTree = clientSafeErr{
	// contains filtered or unexported fields
}

var ErrNoInstance = errors.New("instance not found")

var ErrNoJournal = clientSafeErr{
	// contains filtered or unexported fields
}

var ErrNoLifetime = clientSafeErr{
	// contains filtered or unexported fields
}

var ErrNoLocal = errors.New("could not get local server")

var ErrNoMedia = clientSafeErr{
	// contains filtered or unexported fields
}

var ErrNoPublicUser = clientSafeErr{
	// contains filtered or unexported fields
}

var ErrNoServerId = errors.New("server must have an id")

var ErrNoServerKey = errors.New("server has no key specified")

var ErrNoServerName = errors.New("no server name specified")

var ErrNoShare = errors.New("share not found")

var ErrNoShareAccess = clientSafeErr{
	// contains filtered or unexported fields
}

var ErrNoUser = clientSafeErr{
	// contains filtered or unexported fields
}

var ErrNoUserLogin = clientSafeErr{
	// contains filtered or unexported fields
}

var ErrNonDisplayable = errors.New("attempt to process non-displayable file")

var ErrNotAdmin = clientSafeErr{
	// contains filtered or unexported fields
}

var ErrNotOwner = clientSafeErr{
	// contains filtered or unexported fields
}

var ErrServerIsBackup = errors.New("this operation cannot be performed on a backup server")

var ErrServerNotInitialized = clientSafeErr{
	// contains filtered or unexported fields
}

var ErrShareAlreadyExists = clientSafeErr{
	// contains filtered or unexported fields
}

var ErrSubscriptionNotFound = errors.New("subscription not found")

var ErrTaskError = errors.New("task generated an error")

var ErrTaskExit = errors.New("task exit")

var ErrTaskTimeout = errors.New("task timed out")

var ErrTokenExpired = clientSafeErr{
	// contains filtered or unexported fields
}

var ErrUserAlreadyExists = clientSafeErr{/* contains filtered or unexported fields */}

var ErrUserNotActive = errors.New("user is not active")

var ErrUserNotAuthorized = clientSafeErr{
	// contains filtered or unexported fields
}

var NewErrNoFileName = func(name string) error {
	return &ErrNoFileName{
		Name: name,
		Err:  ErrNoFile,
	}
}

var NotImplemented = func(note string) error {
	return &withStack{
		err:   fmt.Errorf("not implemented: %s", note),
		stack: callers(3),
	}
}

Functions

func ErrBadJobMetadata

func ErrBadJobMetadata(jobName string, field string) error

func GetStack

func GetStack(ignoreDepth int) *stack

func TrySafeErr

func TrySafeErr(err error) (error, int)

SafeErr unpackages an error, if possible, to find the error inside that is safe to send to the client. If the error is not a clientSafeErr, it will trace the original error in the server logs, and return a generic error and a 500 to the client The reasoning behind this is, for example, if a user tries to access a file that they aren't allowed to, WE want to know (and log) they were not allowed to. Then, we want to tell the client (lie) that the file doesn't exist. This way, we don't give the forbidden user any information about the file.

func WithStack

func WithStack(err error) error

Types

type ErrNoFileName

type ErrNoFileName struct {
	Name string
	Err  error
}

func (*ErrNoFileName) Error

func (e *ErrNoFileName) Error() string

func (*ErrNoFileName) Unwrap

func (e *ErrNoFileName) Unwrap() error

type StackError

type StackError interface {
	Error() string
	Stack() string
}

func Errorf

func Errorf(format string, args ...any) StackError