OrcaErrors.swift

//
//  Copyright 2024 Picovoice Inc.
//  You may not use this file except in compliance with the license. A copy of the license is located in the "LICENSE"
//  file accompanying this source.
//  Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on
//  an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the
//  specific language governing permissions and limitations under the License.
//

public class OrcaError: LocalizedError {
    private let message: String
    private let messageStack: [String]

    public init (_ message: String, _ messageStack: [String] = []) {
        self.message = message
        self.messageStack = messageStack
    }

    public var errorDescription: String? {
        var messageString = message
        if messageStack.count > 0 {
            messageString += ":"
            for i in 0..<messageStack.count {
                messageString += "\n  [\(i)] \(messageStack[i])"
            }
        }
        return messageString
    }

    public var name: String {
        get {
            return String(describing: type(of: self))
        }
    }
}

public class OrcaMemoryError: OrcaError {}

public class OrcaIOError: OrcaError {}

public class OrcaInvalidArgumentError: OrcaError {}

public class OrcaStopIterationError: OrcaError {}

public class OrcaKeyError: OrcaError {}

public class OrcaInvalidStateError: OrcaError {}

public class OrcaRuntimeError: OrcaError {}

public class OrcaActivationError: OrcaError {}

public class OrcaActivationLimitError: OrcaError {}

public class OrcaActivationThrottledError: OrcaError {}

public class OrcaActivationRefusedError: OrcaError {}