kitetorrent/io.github.yuroyami.kitetorrent.alert/FileRenameFailedAlert

FileRenameFailedAlert

data class FileRenameFailedAlert(val torrentName: String?, val index: Int, val errorMessage: String) : TorrentAlert

Posted in response to rename_file() when the rename fails. Ported from libtorrent::file_rename_failed_alert (alert_type 8).

libtorrent renders <name>: failed to rename file <index>: <errorMessage>.

Constructors

FileRenameFailedAlert

constructor(torrentName: String?, index: Int, errorMessage: String)

Types

object Companion

Properties

open override val category: Int

The bitmask of AlertCategory flags this alert belongs to. Mirrors alert::category(), which returns the concrete alert's static_category.

val errorMessage: String

the filesystem error description.

the index of the file that was to be renamed.

open override val torrentName: String?

the torrent's name, or null when the handle would be invalid (rendered as " - ", matching libtorrent).

open override val type: Int

An integer unique to this alert type, matching the C++ alert_type static constant. It can be compared against a concrete alert's ALERT_TYPE to determine the runtime type. Mirrors alert::type().

open override val what: String

A short string literal naming the alert type (e.g. "torrent_finished"). It carries no bundled information. Mirrors alert::what(), which in libtorrent returns alert_name(alert_type).

Functions

open override fun message(): String

A string describing the alert and the information bundled with it. Intended for debugging/development, not localization. Mirrors alert::message().