errors

Documentation

Index

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

Variables

var (
	ApplicationNotSet    = New("application instance is not initialized")
	ArtisanFacadeNotSet  = New("artisan facade is not initialized")
	CacheFacadeNotSet    = New("cache facade is not initialized")
	ConfigFacadeNotSet   = New("config 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")
	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")

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

	CacheDriverNotSupported        = New("invalid driver: %s, only support memory, custom")
	CacheForeverFailed             = New("cache forever is failed")
	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")
	CacheSupportRequired           = New("cache support is required")

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

	DBForceIsRequiredInProduction = New("application in production use --force to run this command")
	DBSeederNotFound              = New("not found %s seeder")
	DBFailToRunSeeder             = New("fail to run seeder: %v")

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

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

	LangFileNotExist = New("translation file does not exist")

	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")
	MigrationResetFailed       = New("migration reset failed: %v")
	MigrationRollbackFailed    = New("migration rollback failed: %v")
	MigrationSqlMigratorInit   = New("failed to init sql migration driver: %s")
	MigrationUnsupportedDriver = New("unsupported migration driver: %s")

	OrmDatabaseConfigNotFound      = New("not found database configuration")
	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")

	QueueDriverNotSupported     = New("unknown queue driver: %s")
	QueueDuplicateJobSignature  = New("job signature duplicate: %s, the names of Job and Listener cannot be duplicated")
	QueueEmptyJobSignature      = New("the Signature of job can't be empty")
	QueueEmptyListenerSignature = New("the Signature of listener can't be empty")

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

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

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

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

Functions

func As

func As(err error, target any) bool

func Is

func Is(err, target error) bool

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