aboutsummaryrefslogtreecommitdiff
path: root/BackEnd/Timeline/Services/Exceptions/ImageException.cs
blob: 20dd48ae2a9370cb5537117e9db8cffe5ff29b46 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
using System;
using System.Globalization;

namespace Timeline.Services.Exceptions
{
    [Serializable]
    public class ImageException : Exception
    {
        public enum ErrorReason
        {
            /// <summary>
            /// Decoding image failed.
            /// </summary>
            CantDecode,
            /// <summary>
            /// Decoding succeeded but the real type is not the specified type.
            /// </summary>
            UnmatchedFormat,
            /// <summary>
            /// Image is not of required size.
            /// </summary>
            NotSquare,
            /// <summary>
            /// Other unknown errer.
            /// </summary>
            Unknown
        }

        public ImageException() : this(null) { }
        public ImageException(string? message) : this(message, null) { }
        public ImageException(string? message, Exception? inner) : this(ErrorReason.Unknown, null, null, null, message, inner) { }

        public ImageException(ErrorReason error, byte[]? data, string? requestType = null, string? realType = null, string? message = null, Exception? inner = null) : base(MakeMessage(error).AppendAdditionalMessage(message), inner) { Error = error; ImageData = data; RequestType = requestType; RealType = realType; }

        protected ImageException(
          System.Runtime.Serialization.SerializationInfo info,
          System.Runtime.Serialization.StreamingContext context) : base(info, context) { }

        private static string MakeMessage(ErrorReason? reason) =>
            string.Format(CultureInfo.InvariantCulture, Resources.Services.Exceptions.ImageException, reason switch
            {
                ErrorReason.CantDecode => Resources.Services.Exceptions.ImageExceptionCantDecode,
                ErrorReason.UnmatchedFormat => Resources.Services.Exceptions.ImageExceptionUnmatchedFormat,
                ErrorReason.NotSquare => Resources.Services.Exceptions.ImageExceptionBadSize,
                _ => Resources.Services.Exceptions.ImageExceptionUnknownError
            });

        public ErrorReason Error { get; }
#pragma warning disable CA1819 // Properties should not return arrays
        public byte[]? ImageData { get; }
#pragma warning restore CA1819 // Properties should not return arrays
        public string? RequestType { get; }

        // This field will be null if decoding failed.
        public string? RealType { get; }
    }
}