SentrySpanStatus.h

#import <Foundation/Foundation.h>

/**
 * Describes the status of the Span/Transaction.
 */
typedef NS_ENUM(NSUInteger, SentrySpanStatus) {
    /**
     * An undefined status.
     */
    kSentrySpanStatusUndefined,

    /**
     * Not an error, returned on success.
     */
    kSentrySpanStatusOk,

    /**
     * The deadline expired before the operation could succeed.
     */
    kSentrySpanStatusDeadlineExceeded,

    /**
     * The requester doesn't have valid authentication credentials for the operation.
     */
    kSentrySpanStatusUnauthenticated,

    /**
     * The caller doesn't have permission to execute the specified operation.
     */
    kSentrySpanStatusPermissionDenied,

    /**
     * Content was not found or request was denied for an entire class of users.
     */
    kSentrySpanStatusNotFound,

    /**
     * The resource has been exhausted e.g. per-user quota exhausted, file system out of space.
     */
    kSentrySpanStatusResourceExhausted,

    /**
     * The client specified an invalid argument.
     */
    kSentrySpanStatusInvalidArgument,

    /**
     * 501 Not Implemented.
     */
    kSentrySpanStatusUnimplemented,

    /**
     * The operation is not implemented or is not supported/enabled for this operation.
     */
    kSentrySpanStatusUnavailable,

    /**
     * Some invariants expected by the underlying system have been broken. This code is reserved for
     * serious errors.
     */
    kSentrySpanStatusInternalError,

    /**
     * An unknown error raised by APIs that don't return enough error information.
     */
    kSentrySpanStatusUnknownError,

    /**
     * The operation was cancelled, typically by the caller.
     */
    kSentrySpanStatusCancelled,

    /**
     * The entity attempted to be created already exists.
     */
    kSentrySpanStatusAlreadyExists,

    /**
     * The client shouldn't retry until the system state has been explicitly handled.
     */
    kSentrySpanStatusFailedPrecondition,

    /**
     * The operation was aborted.
     */
    kSentrySpanStatusAborted,

    /**
     * The operation was attempted past the valid range e.g. seeking past the end of a file.
     */
    kSentrySpanStatusOutOfRange,

    /**
     * Unrecoverable data loss or corruption.
     */
    kSentrySpanStatusDataLoss,
};

static DEPRECATED_MSG_ATTRIBUTE(
    "Use nameForSentrySpanStatus() instead.") NSString *_Nonnull const SentrySpanStatusNames[]
    = { @"undefined", @"ok", @"deadline_exceeded", @"unauthenticated", @"permission_denied",
          @"not_found", @"resource_exhausted", @"invalid_argument", @"unimplemented",
          @"unavailable", @"internal_error", @"unknown_error", @"cancelled", @"already_exists",
          @"failed_precondition", @"aborted", @"out_of_range", @"data_loss" };

NS_ASSUME_NONNULL_BEGIN

FOUNDATION_EXPORT NSString *const kSentrySpanStatusNameUndefined;
FOUNDATION_EXPORT NSString *const kSentrySpanStatusNameOk;
FOUNDATION_EXPORT NSString *const kSentrySpanStatusNameDeadlineExceeded;
FOUNDATION_EXPORT NSString *const kSentrySpanStatusNameUnauthenticated;
FOUNDATION_EXPORT NSString *const kSentrySpanStatusNamePermissionDenied;
FOUNDATION_EXPORT NSString *const kSentrySpanStatusNameNotFound;
FOUNDATION_EXPORT NSString *const kSentrySpanStatusNameResourceExhausted;
FOUNDATION_EXPORT NSString *const kSentrySpanStatusNameInvalidArgument;
FOUNDATION_EXPORT NSString *const kSentrySpanStatusNameUnimplemented;
FOUNDATION_EXPORT NSString *const kSentrySpanStatusNameUnavailable;
FOUNDATION_EXPORT NSString *const kSentrySpanStatusNameInternalError;
FOUNDATION_EXPORT NSString *const kSentrySpanStatusNameUnknownError;
FOUNDATION_EXPORT NSString *const kSentrySpanStatusNameCancelled;
FOUNDATION_EXPORT NSString *const kSentrySpanStatusNameAlreadyExists;
FOUNDATION_EXPORT NSString *const kSentrySpanStatusNameFailedPrecondition;
FOUNDATION_EXPORT NSString *const kSentrySpanStatusNameAborted;
FOUNDATION_EXPORT NSString *const kSentrySpanStatusNameOutOfRange;
FOUNDATION_EXPORT NSString *const kSentrySpanStatusNameDataLoss;

NSString *nameForSentrySpanStatus(SentrySpanStatus status);

NS_ASSUME_NONNULL_END