errors

Documentation

Index

• Variables
• func As(err error, target any) bool
• func Ignore(fn func() error)
• func Is(err, target error) bool
• func Join(errs ...error) error
• func New(text string, module ...string) contractserrors.Error
• func Unwrap(err error) error

Variables

var (
	ApplicationNotSet       = New("application instance is not initialized")
	CacheFacadeNotSet       = New("cache facade is not initialized")
	ConfigFacadeNotSet      = New("config facade is not initialized")
	ConsoleFacadeNotSet     = New("console facade is not initialized, skipping artisan command execution")
	DBFacadeNotSet          = New("db facade is not initialized")
	JSONParserNotSet        = New("JSON parser is not initialized")
	LogFacadeNotSet         = New("log facade is not initialized")
	OrmFacadeNotSet         = New("orm facade is not initialized")
	QueueFacadeNotSet       = New("queue facade is not initialized")
	RateLimiterFacadeNotSet = New("rate limiter facade is not initialized")
	ScheduleFacadeNotSet    = New("schedule facade is not initialized")
	StorageFacadeNotSet     = New("storage facade is not initialized")
	InvalidHttpContext      = New("invalid http context")
	RouteFacadeNotSet       = New("route facade is not initialized")
	SessionFacadeNotSet     = New("session facade is not initialized")
	ServiceProviderCycle    = New("circular dependency detected between providers: %s")

	AuthEmptySecret             = New("authentication secret is missing or required")
	AuthInvalidClaims           = New("authentication token contains invalid claims")
	AuthInvalidKey              = New("authentication key is invalid")
	AuthInvalidToken            = New("authentication token is invalid")
	AuthNoPrimaryKeyField       = New("no primary key field found in the model, ensure primary key is set, e.g., orm.Model")
	AuthParseTokenFirst         = New("authentication token must be parsed first")
	AuthRefreshTimeExceeded     = New("authentication refresh time limit exceeded")
	AuthTokenDisabled           = New("authentication token has been disabled")
	AuthTokenExpired            = New("authentication token has expired")
	AuthGuardDriverNotFound     = New("driver %s for guard %s was not found")
	AuthProviderDriverNotFound  = New("driver %s for user provider %s was not found")
	AuthUnsupportedDriverMethod = New("The method was not supported for the driver %s")

	CacheDriverNotSupported           = New("invalid driver: %s, only support memory, custom")
	CacheForeverFailed                = New("cache forever is failed")
	CacheMemoryDriverNotSupportDocker = New("memory driver doesn't support docker")
	CacheMemoryInvalidIntValueType    = New("value type of %s is not *atomic.Int64 or *int64 or *atomic.Int32 or *int32")
	CacheStoreContractNotFulfilled    = New("%s doesn't implement contracts/cache/store")

	ConsoleProvidersNotArray = New("the app.providers configuration is not of type []foundation.ServiceProvider, skipping registering service providers")

	ConsoleCommandRegisterFailed = New("command register failed: %v")
	ConsoleDropAllTablesFailed   = New("drop all tables failed: %v")
	ConsoleDropAllTypesFailed    = New("drop all types failed: %v")
	ConsoleDropAllViewsFailed    = New("drop all views failed: %v")
	ConsoleEmptyDatabaseConfig   = New("please fill database config first")
	ConsoleEmptyFieldValue       = New("the %s name cannot be empty")
	ConsoleFileAlreadyExists     = New("the %s already exists. Use the --force or -f flag to overwrite")
	ConsoleFailedToConfirm       = New("failed to confirm the action: %v")
	ConsolePruneFailed           = New("prune failed: %v")
	ConsoleRunInProduction       = New("please use the --force option if you want to run the command in production")

	CryptAppKeyNotSet        = New("APP_KEY is required in artisan environment")
	CryptInvalidAppKeyLength = New("invalid APP_KEY length: %d bytes")
	CryptMissingIVKey        = New("decrypt payload error: missing iv key")
	CryptMissingValueKey     = New("decrypt payload error: missing value key")

	DatabaseConfigNotFound              = New("not found database configuration")
	DatabaseTableIsRequired             = New("table is required")
	DatabaseForceIsRequiredInProduction = New("application in production use --force to run this command")
	DatabaseSeederNotFound              = New("not found %s seeder")
	DatabaseSeederRegisterFailed        = New("seeder register failed: %v")
	DatabaseFailToRunSeeder             = New("fail to run seeder: %v")
	DatabaseUnsupportedType             = New("unsupported type: %s, expected %s")
	DatabaseInvalidArgumentNumber       = New("invalid argument number: %s, expected %s")
	DatabaseTransactionNotStarted       = New("transaction not started")
	DatabaseFailedToGetSql              = New("failed to get sql: %v")
	DatabaseDataIsEmpty                 = New("data can't be empty")

	DockerUnknownContainerType           = New("unknown container type")
	DockerInsufficientDatabaseContainers = New("the number of database container is not enough, expect: %d, got: %d")
	DockerDatabaseContainerCountZero     = New("the number of database container must be greater than 0")
	DockerMissingContainerId             = New("no container id return when creating %s docker")

	EventListenerNotBind = New("event %v doesn't bind listeners")

	FilesystemDefaultDiskNotSet   = New("please set default disk")
	FilesystemDeleteDirectory     = New("can't delete directory, please use DeleteDirectory")
	FilesystemDriverNotSupported  = New("invalid driver: %s, only support local, custom")
	FilesystemFileNotExist        = New("file doesn't exist")
	FilesystemInvalidCustomDriver = New("init %s disk fail: via must be implement filesystem.Driver or func() (filesystem.Driver, error)")

	FileAlreadyExists = New("file %s already exists")

	GrpcEmptyClientHost         = New("client's host can't be empty")
	GrpcEmptyClientPort         = New("client's port can't be empty")
	GrpcEmptyServerHost         = New("host can't be empty")
	GrpcEmptyServerPort         = New("port can't be empty")
	GrpcInvalidInterceptorsType = New("the type of clients.%s.interceptors must be []string")

	HttpRateLimitFailedToTakeToken     = New("failed to take token")
	HttpRateLimitFailedToCheckThrottle = New("failed to check throttle: %s")

	LangFileNotExist      = New("translation file does not exist")
	LangNoLoaderAvailable = New("no translation loader available")

	LogDriverCircularReference = New("%s driver can't include self channel").SetModule(ModuleLog)
	LogDriverNotSupported      = New("invalid driver: %s, only support stack, single, daily, custom").SetModule(ModuleLog)
	LogEmptyLogFilePath        = New("empty log file path").SetModule(ModuleLog)

	MigrationCreateFailed    = New("create migration failed: %v")
	MigrationFreshFailed     = New("migration fresh failed: %v")
	MigrationGetStatusFailed = New("get migration status failed: %v")
	MigrationMigrateFailed   = New("migrate failed: %v")
	MigrationNameIsRequired  = New("migration name cannot be empty")
	MigrationRefreshFailed   = New("migration refresh failed: %v")
	MigrationRegisterFailed  = New("migration register failed: %v")
	MigrationResetFailed     = New("migration reset failed: %v")
	MigrationRollbackFailed  = New("migration rollback failed: %v")

	OrmDriverNotSupported          = New("invalid driver: %s, only support mysql, postgres, sqlite and sqlserver")
	OrmFailedToGenerateDNS         = New("failed to generate DSN, please check the database configuration")
	OrmFactoryMissingAttributes    = New("failed to get raw attributes")
	OrmFactoryMissingMethod        = New("%s does not find factory method")
	OrmInitConnection              = New("init %s connection error: %v")
	OrmMissingWhereClause          = New("WHERE conditions required")
	OrmNoDialectorsFound           = New("no dialectors found")
	OrmQueryAssociationsConflict   = New("cannot set orm.Associations and other fields at the same time")
	OrmQueryConditionRequired      = New("query condition is required")
	OrmQueryEmptyId                = New("id can't be empty")
	OrmQueryEmptyRelation          = New("relation can't be empty")
	OrmQueryInvalidModel           = New("invalid model %s")
	OrmQueryInvalidParameter       = New("parameter error, please check the document")
	OrmQueryModelNotPointer        = New("model must be pointer")
	OrmQuerySelectAndOmitsConflict = New("cannot set Select and Omits at the same time")
	OrmRecordNotFound              = New("record not found")
	OrmDeletedAtColumnNotFound     = New("deleted at column not found")
	OrmJsonContainsInvalidBinding  = New("invalid value for JSON contains: %v")
	OrmJsonColumnUpdateInvalid     = New("invalid value for JSON column update: %v")

	PackageConfigKeyExists       = New("config key '%s' already exists,using ReplaceConfig instead if you want to update it")
	PackageFacadeNotFound        = New("facade %s not found")
	PackageMatchGoNodeFail       = New("%d out of %d matchers did not match")
	PackageModifyGoFileFail      = New("modify go file '%s' failed: %v")
	PackageModuleNameEmpty       = New("package module name is empty, please run command with module name")
	PackageRegistrationDuplicate = New("'%s' had been registered")
	PackageRegistrationNotFound  = New("'%s' not found, cannot insert before it")

	QueueDriverFailedToPop           = New("failed to pop job from %s queue: %v")
	QueueDriverInvalid               = New("%s doesn't implement contracts/queue/driver")
	QueueDriverNoJobFound            = New("no job found in %s queue")
	QueueDriverNotSupported          = New("unknown queue driver: %s")
	QueueDriverSyncNotNeedToRun      = New("the driver of queue %s is sync, not need to run")
	QueueDuplicateJobSignature       = New("duplicate job signature: %s")
	QueueEmptyJobSignature           = New("job signature can't be empty")
	QueueFailedJobNotFound           = New("Unable to find failed job with ID [%s]")
	QueueFailedToCallJob             = New("failed to call job")
	QueueFailedToConvertTaskToJson   = New("failed to convert task to json: %v, task: %+v")
	QueueFailedToDeleteFailedJob     = New("failed to delete failed job: %+v, err: %v")
	QueueFailedToDeleteReservedJob   = New("failed to delete reserved job: %+v, err: %v")
	QueueFailedToGetFailedJob        = New("failed to get failed job: %+v, err: %v")
	QueueFailedToInsertJobToDatabase = New("failed to insert job to database: %+v, err: %v")
	QueueFailedToReserveJob          = New("failed to reserve job: %+v, err: %v")
	QueueFailedToRetryJob            = New("failed to retry job: %+v, err: %v")
	QueueFailedToRunMachinery        = New("failed to run machinery: %v")
	QueueFailedToSaveFailedJob       = New("failed to save failed job: %v")
	QueueInvalidDatabaseConnection   = New("invalid database connection: %s")
	QueueNoRetryableJobsFound        = New("no retryable jobs found")
	QueueJobNotFound                 = New("job not found: %s")
	QueueJobRegisterFailed           = New("job register failed: %v")
	QueueJobFailed                   = New("job failed: %v")
	QueueProcessingJobs              = New("Processing jobs from [%s] connection and [%s] queue")
	QueuePushingFailedJob            = New("Pushing failed queue jobs back onto the queue")
	QueueNoFailedJobsFound           = New("no failed jobs found")

	RouteDefaultDriverNotSet = New("please set default driver")
	RouteInvalidDriver       = New("init %s route driver fail: route must be implement route.Route or func() (route.Route, error)")

	SchemaDriverNotSupported   = New("driver %s is not supported")
	SchemaFailedToCreateTable  = New("failed to create %s table: %v")
	SchemaFailedToChangeTable  = New("failed to change %s table: %v")
	SchemaFailedToDropTable    = New("failed to drop %s table: %v")
	SchemaFailedToDropColumns  = New("failed to drop %s table columns: %v")
	SchemaFailedToGetTables    = New("failed to get %s tables: %v")
	SchemaFailedToRenameTable  = New("failed to rename %s table: %v")
	SchemaEmptyReferenceString = New("reference string can't be empty")
	SchemaErrorReferenceFormat = New("invalid format: too many dots in reference")
	SchemaConnectionNotFound   = New("connection %s not found")
	SchemaTableNotFound        = New("table %s not found")

	SessionDriverAlreadyExists        = New("session driver [%s] already exists")
	SessionDriverExtensionFailed      = New("session failed to extend session [%s] driver [%v]")
	SessionDriverIsNotSet             = New("session driver is not set")
	SessionDriverNotSupported         = New("session driver [%s] not supported")
	SessionDriverRegisterFailed       = New("failed to register session drivers: %v")
	SessionDriverContractNotFulfilled = New("%s doesn't implement contracts/session/driver")

	TemplateFailedToParse         = New("failed to parse template: %v")
	TemplateFailedToFormateGoCode = New("failed to format go code: %v")

	TestingImageBuildFailed   = New("init %s docker error: %v")
	TestingImageNoContainerId = New("no container id return when creating %s docker")
	TestingImageStopFailed    = New("stop %s docker error: %v")
	TestingImageReadyTimeout  = New("image %s is not ready after %s")

	UnknownFileExtension = New("unknown file extension")

	ValidationDataInvalidType      = New("data must be map[string]any or map[string][]string or struct")
	ValidationDuplicateFilter      = New("duplicate filter name: %s")
	ValidationDuplicateRule        = New("duplicate rule name: %s")
	ValidationEmptyData            = New("data can't be empty")
	ValidationEmptyRules           = New("rules can't be empty")
	ValidationFilterRegisterFailed = New("filter register failed: %v")
	ValidationRuleRegisterFailed   = New("rule register failed: %v")

	CommandEmptyPackageName = New("the package name cannot be empty")
)

var (
	ModuleAuth       = "auth"
	ModuleCache      = "cache"
	ModuleConsole    = "console"
	ModuleCrypt      = "crypt"
	ModuleDB         = "db"
	ModuleEvent      = "event"
	ModuleFacade     = "facade"
	ModuleFilesystem = "filesystem"
	ModuleGrpc       = "grpc"
	ModuleHash       = "hash"
	ModuleHttp       = "http"
	ModuleLang       = "lang"
	ModuleLog        = "log"
	ModuleMail       = "mail"
	ModuleMigration  = "migration"
	ModuleOrm        = "orm"
	ModulePackages   = "packages"
	ModuleQueue      = "queue"
	ModuleRoute      = "route"
	ModuleSchema     = "schema"
	ModuleSchedule   = "schedule"
	ModuleSession    = "session"
	ModuleTesting    = "testing"
)

Functions

func As

func As(err error, target any) bool

func Ignore

func Ignore(fn func() error)

func Is

func Is(err, target error) bool

func Join

func Join(errs ...error) error

func New

func New(text string, module ...string) contractserrors.Error

New creates a new error with the provided text and optional module

func Unwrap

func Unwrap(err error) error