[][src]Crate transmission_sys

Rust bindings for Transmission made using Rust-Bindgen.

Bindings are generated with Rust-Bindgen which means there are a number of quirks.

  • Enums are a constants in the form of enum_name_ENUM_FIELD
  • Functions are named the same as the C code and don't follow Rust naming schemes.
  • Uses C strings. See CStr in the Rust standard library.

Structs

__fsid_t
__locale_data
__locale_struct
__va_list_tag
evbuffer
event
imaxdiv_t
itimerspec
max_align_t
sigevent
timespec
timeval
tm
tr_ctor
tr_error
tr_file

@brief a part of tr_info that represents a single file of the torrent's content

tr_file_stat
tr_info

@brief information about a torrent that comes from its metainfo file

tr_log_message
tr_metainfo_builder
tr_metainfo_builder_file
tr_peer_stat

tr_peer_stat

tr_piece

@brief a part of tr_info that represents a single piece of the torrent's content

tr_session
tr_session_stats

@brief Used by tr_sessionGetStats() and tr_sessionGetCumulativeStats()

tr_stat

@brief Used by tr_torrentStat() to tell clients about a torrent's state and statistics

tr_torrent
tr_tracker_info

@brief a part of tr_info that represents a single tracker

tr_tracker_stat
tr_variant
tr_variant__bindgen_ty_1__bindgen_ty_1
tr_variant_string

Enums

_bindgen_ty_1
_bindgen_ty_2

File Priorities

_bindgen_ty_3
_bindgen_ty_4
_bindgen_ty_5
tr_completeness
tr_ctorMode

@addtogroup tr_ctor Torrent Constructors @{

tr_direction
tr_encryption_mode
tr_idlelimit

Idle Time Limits

tr_log_level

Message Logging

tr_metainfo_builder_err
tr_parse_result
tr_port_forwarding
tr_preallocation_mode
tr_ratiolimit

Ratio Limits

tr_rpc_callback_status
tr_rpc_callback_type
tr_sched_day
tr_stat_errtype
tr_string_type

@addtogroup tr_variant Variant

tr_torrent_activity

What the torrent is doing right now.

tr_tracker_state

tr_tracker_stat

tr_variant_fmt

Serialization / Deserialization

Constants

CLOCK_BOOTTIME
CLOCK_BOOTTIME_ALARM
CLOCK_MONOTONIC
CLOCK_MONOTONIC_COARSE
CLOCK_MONOTONIC_RAW
CLOCK_PROCESS_CPUTIME_ID
CLOCK_REALTIME
CLOCK_REALTIME_ALARM
CLOCK_REALTIME_COARSE
CLOCK_TAI
CLOCK_THREAD_CPUTIME_ID
DEFAULT_BLOCKLIST_FILENAME
INT8_MIN
INT8_MAX
INT16_MIN
INT16_MAX
INT32_MIN
INT32_MAX
INTPTR_MAX
INTPTR_MIN
INT_FAST8_MIN
INT_FAST8_MAX
INT_FAST16_MIN
INT_FAST16_MAX
INT_FAST32_MIN
INT_FAST32_MAX
INT_LEAST8_MIN
INT_LEAST8_MAX
INT_LEAST16_MIN
INT_LEAST16_MAX
INT_LEAST32_MIN
INT_LEAST32_MAX
PRIX8
PRIX16
PRIX32
PRIX64
PRIXFAST8
PRIXFAST16
PRIXFAST32
PRIXFAST64
PRIXLEAST8
PRIXLEAST16
PRIXLEAST32
PRIXLEAST64
PRIXMAX
PRIXPTR
PRId8
PRId16
PRId32
PRId64
PRIdFAST8
PRIdFAST16
PRIdFAST32
PRIdFAST64
PRIdLEAST8
PRIdLEAST16
PRIdLEAST32
PRIdLEAST64
PRIdMAX
PRIdPTR
PRIi8
PRIi16
PRIi32
PRIi64
PRIiFAST8
PRIiFAST16
PRIiFAST32
PRIiFAST64
PRIiLEAST8
PRIiLEAST16
PRIiLEAST32
PRIiLEAST64
PRIiMAX
PRIiPTR
PRIo8
PRIo16
PRIo32
PRIo64
PRIoFAST8
PRIoFAST16
PRIoFAST32
PRIoFAST64
PRIoLEAST8
PRIoLEAST16
PRIoLEAST32
PRIoLEAST64
PRIoMAX
PRIoPTR
PRIu8
PRIu16
PRIu32
PRIu64
PRIuFAST8
PRIuFAST16
PRIuFAST32
PRIuFAST64
PRIuLEAST8
PRIuLEAST16
PRIuLEAST32
PRIuLEAST64
PRIuMAX
PRIuPTR
PRIx8
PRIx16
PRIx32
PRIx64
PRIxFAST8
PRIxFAST16
PRIxFAST32
PRIxFAST64
PRIxLEAST8
PRIxLEAST16
PRIxLEAST32
PRIxLEAST64
PRIxMAX
PRIxPTR
PTRDIFF_MAX
PTRDIFF_MIN
SCNd8
SCNd16
SCNd32
SCNd64
SCNdFAST8
SCNdFAST16
SCNdFAST32
SCNdFAST64
SCNdLEAST8
SCNdLEAST16
SCNdLEAST32
SCNdLEAST64
SCNdMAX
SCNdPTR
SCNi8
SCNi16
SCNi32
SCNi64
SCNiFAST8
SCNiFAST16
SCNiFAST32
SCNiFAST64
SCNiLEAST8
SCNiLEAST16
SCNiLEAST32
SCNiLEAST64
SCNiMAX
SCNiPTR
SCNo8
SCNo16
SCNo32
SCNo64
SCNoFAST8
SCNoFAST16
SCNoFAST32
SCNoFAST64
SCNoLEAST8
SCNoLEAST16
SCNoLEAST32
SCNoLEAST64
SCNoMAX
SCNoPTR
SCNu8
SCNu16
SCNu32
SCNu64
SCNuFAST8
SCNuFAST16
SCNuFAST32
SCNuFAST64
SCNuLEAST8
SCNuLEAST16
SCNuLEAST32
SCNuLEAST64
SCNuMAX
SCNuPTR
SCNx8
SCNx16
SCNx32
SCNx64
SCNxFAST8
SCNxFAST16
SCNxFAST32
SCNxFAST64
SCNxLEAST8
SCNxLEAST16
SCNxLEAST32
SCNxLEAST64
SCNxMAX
SCNxPTR
SHA_DIGEST_LENGTH
SIG_ATOMIC_MAX
SIG_ATOMIC_MIN
SIZE_MAX
TIMER_ABSTIME
TIME_UTC
TR_DEFAULT_BIND_ADDRESS_IPV4
TR_DEFAULT_BIND_ADDRESS_IPV6
TR_DEFAULT_PEER_LIMIT_GLOBAL_STR
TR_DEFAULT_PEER_LIMIT_TORRENT_STR
TR_DEFAULT_PEER_PORT_STR
TR_DEFAULT_PEER_SOCKET_TOS_STR
TR_DEFAULT_RPC_HOST_WHITELIST
TR_DEFAULT_RPC_PORT_STR
TR_DEFAULT_RPC_URL_STR
TR_DEFAULT_RPC_WHITELIST
TR_ETA_NOT_AVAIL
TR_ETA_UNKNOWN
TR_INET6_ADDRSTRLEN
TR_KEY_NONE
TR_KEY_activeTorrentCount
TR_KEY_activityDate
TR_KEY_activity_date
TR_KEY_added
TR_KEY_added6
TR_KEY_added6_f
TR_KEY_addedDate
TR_KEY_added_date
TR_KEY_added_f
TR_KEY_address
TR_KEY_alt_speed_down
TR_KEY_alt_speed_enabled
TR_KEY_alt_speed_time_begin
TR_KEY_alt_speed_time_day
TR_KEY_alt_speed_time_enabled
TR_KEY_alt_speed_time_end
TR_KEY_alt_speed_up
TR_KEY_announce
TR_KEY_announceState
TR_KEY_announce_list
TR_KEY_arguments
TR_KEY_bandwidthPriority
TR_KEY_bandwidth_priority
TR_KEY_bind_address_ipv4
TR_KEY_bind_address_ipv6
TR_KEY_bitfield
TR_KEY_blocklist_date
TR_KEY_blocklist_enabled
TR_KEY_blocklist_size
TR_KEY_blocklist_updates_enabled
TR_KEY_blocklist_url
TR_KEY_blocks
TR_KEY_bytesCompleted
TR_KEY_cache_size_mb
TR_KEY_clientIsChoked
TR_KEY_clientIsInterested
TR_KEY_clientName
TR_KEY_comment
TR_KEY_comment_utf_8
TR_KEY_compact_view
TR_KEY_complete
TR_KEY_config_dir
TR_KEY_cookies
TR_KEY_corrupt
TR_KEY_corruptEver
TR_KEY_created_by
TR_KEY_created_by_utf_8
TR_KEY_creation_date
TR_KEY_creator
TR_KEY_cumulative_stats
TR_KEY_current_stats
TR_KEY_date
TR_KEY_dateCreated
TR_KEY_delete_local_data
TR_KEY_desiredAvailable
TR_KEY_destination
TR_KEY_dht_enabled
TR_KEY_display_name
TR_KEY_dnd
TR_KEY_doneDate
TR_KEY_done_date
TR_KEY_downloadCount
TR_KEY_downloadDir
TR_KEY_downloadLimit
TR_KEY_downloadLimited
TR_KEY_downloadSpeed
TR_KEY_download_dir
TR_KEY_download_dir_free_space
TR_KEY_download_queue_enabled
TR_KEY_download_queue_size
TR_KEY_downloaded
TR_KEY_downloadedBytes
TR_KEY_downloadedEver
TR_KEY_downloaded_bytes
TR_KEY_downloaders
TR_KEY_downloading_time_seconds
TR_KEY_dropped
TR_KEY_dropped6
TR_KEY_e
TR_KEY_encoding
TR_KEY_encryption
TR_KEY_error
TR_KEY_errorString
TR_KEY_eta
TR_KEY_etaIdle
TR_KEY_failure_reason
TR_KEY_fields
TR_KEY_fileStats
TR_KEY_filename
TR_KEY_files
TR_KEY_filesAdded
TR_KEY_files_added
TR_KEY_files_unwanted
TR_KEY_files_wanted
TR_KEY_filter_mode
TR_KEY_filter_text
TR_KEY_filter_trackers
TR_KEY_flagStr
TR_KEY_flags
TR_KEY_fromCache
TR_KEY_fromDht
TR_KEY_fromIncoming
TR_KEY_fromLpd
TR_KEY_fromLtep
TR_KEY_fromPex
TR_KEY_fromTracker
TR_KEY_hasAnnounced
TR_KEY_hasScraped
TR_KEY_hashString
TR_KEY_have
TR_KEY_haveUnchecked
TR_KEY_haveValid
TR_KEY_honorsSessionLimits
TR_KEY_host
TR_KEY_id
TR_KEY_idle_limit
TR_KEY_idle_mode
TR_KEY_idle_seeding_limit
TR_KEY_idle_seeding_limit_enabled
TR_KEY_ids
TR_KEY_incomplete
TR_KEY_incomplete_dir
TR_KEY_incomplete_dir_enabled
TR_KEY_info
TR_KEY_info_hash
TR_KEY_inhibit_desktop_hibernation
TR_KEY_interval
TR_KEY_ip
TR_KEY_ipv4
TR_KEY_ipv6
TR_KEY_isBackup
TR_KEY_isDownloadingFrom
TR_KEY_isEncrypted
TR_KEY_isFinished
TR_KEY_isIncoming
TR_KEY_isPrivate
TR_KEY_isStalled
TR_KEY_isUTP
TR_KEY_isUploadingTo
TR_KEY_lastAnnouncePeerCount
TR_KEY_lastAnnounceResult
TR_KEY_lastAnnounceStartTime
TR_KEY_lastAnnounceSucceeded
TR_KEY_lastAnnounceTime
TR_KEY_lastAnnounceTimedOut
TR_KEY_lastScrapeResult
TR_KEY_lastScrapeStartTime
TR_KEY_lastScrapeSucceeded
TR_KEY_lastScrapeTime
TR_KEY_lastScrapeTimedOut
TR_KEY_leecherCount
TR_KEY_leftUntilDone
TR_KEY_length
TR_KEY_location
TR_KEY_lpd_enabled
TR_KEY_m
TR_KEY_magnetLink
TR_KEY_magnet_info
TR_KEY_main_window_height
TR_KEY_main_window_is_maximized
TR_KEY_main_window_layout_order
TR_KEY_main_window_width
TR_KEY_main_window_x
TR_KEY_main_window_y
TR_KEY_manualAnnounceTime
TR_KEY_maxConnectedPeers
TR_KEY_max_peers
TR_KEY_memory_bytes
TR_KEY_memory_units
TR_KEY_message_level
TR_KEY_metadataPercentComplete
TR_KEY_metadata_size
TR_KEY_metainfo
TR_KEY_method
TR_KEY_min_interval
TR_KEY_min_request_interval
TR_KEY_move
TR_KEY_msg_type
TR_KEY_mtimes
TR_KEY_name
TR_KEY_name_utf_8
TR_KEY_nextAnnounceTime
TR_KEY_nextScrapeTime
TR_KEY_nodes
TR_KEY_nodes6
TR_KEY_open_dialog_dir
TR_KEY_p
TR_KEY_path
TR_KEY_path_utf_8
TR_KEY_paused
TR_KEY_pausedTorrentCount
TR_KEY_peerIsChoked
TR_KEY_peerIsInterested
TR_KEY_peer_congestion_algorithm
TR_KEY_peer_id_ttl_hours
TR_KEY_peer_limit
TR_KEY_peer_limit_global
TR_KEY_peer_limit_per_torrent
TR_KEY_peer_port
TR_KEY_peer_port_random_high
TR_KEY_peer_port_random_low
TR_KEY_peer_port_random_on_start
TR_KEY_peer_socket_tos
TR_KEY_peers
TR_KEY_peers2
TR_KEY_peers6
TR_KEY_peers2_6
TR_KEY_peersConnected
TR_KEY_peersFrom
TR_KEY_peersGettingFromUs
TR_KEY_peersSendingToUs
TR_KEY_percentDone
TR_KEY_pex_enabled
TR_KEY_piece
TR_KEY_pieceCount
TR_KEY_pieceSize
TR_KEY_piece_length
TR_KEY_pieces
TR_KEY_play_download_complete_sound
TR_KEY_port
TR_KEY_port_forwarding_enabled
TR_KEY_port_is_open
TR_KEY_preallocation
TR_KEY_prefetch_enabled
TR_KEY_priorities
TR_KEY_priority
TR_KEY_priority_high
TR_KEY_priority_low
TR_KEY_priority_normal
TR_KEY_private
TR_KEY_progress
TR_KEY_prompt_before_exit
TR_KEY_queuePosition
TR_KEY_queue_move_bottom
TR_KEY_queue_move_down
TR_KEY_queue_move_top
TR_KEY_queue_move_up
TR_KEY_queue_stalled_enabled
TR_KEY_queue_stalled_minutes
TR_KEY_rateDownload
TR_KEY_rateToClient
TR_KEY_rateToPeer
TR_KEY_rateUpload
TR_KEY_ratio_limit
TR_KEY_ratio_limit_enabled
TR_KEY_ratio_mode
TR_KEY_recent_download_dir_1
TR_KEY_recent_download_dir_2
TR_KEY_recent_download_dir_3
TR_KEY_recent_download_dir_4
TR_KEY_recheckProgress
TR_KEY_remote_session_enabled
TR_KEY_remote_session_host
TR_KEY_remote_session_password
TR_KEY_remote_session_port
TR_KEY_remote_session_requres_authentication
TR_KEY_remote_session_username
TR_KEY_removed
TR_KEY_rename_partial_files
TR_KEY_reqq
TR_KEY_result
TR_KEY_rpc_authentication_required
TR_KEY_rpc_bind_address
TR_KEY_rpc_enabled
TR_KEY_rpc_host_whitelist
TR_KEY_rpc_host_whitelist_enabled
TR_KEY_rpc_password
TR_KEY_rpc_port
TR_KEY_rpc_url
TR_KEY_rpc_username
TR_KEY_rpc_version
TR_KEY_rpc_version_minimum
TR_KEY_rpc_whitelist
TR_KEY_rpc_whitelist_enabled
TR_KEY_scrape
TR_KEY_scrapeState
TR_KEY_scrape_paused_torrents_enabled
TR_KEY_script_torrent_done_enabled
TR_KEY_script_torrent_done_filename
TR_KEY_secondsActive
TR_KEY_secondsDownloading
TR_KEY_secondsSeeding
TR_KEY_seconds_active
TR_KEY_seedIdleLimit
TR_KEY_seedIdleMode
TR_KEY_seedRatioLimit
TR_KEY_seedRatioLimited
TR_KEY_seedRatioMode
TR_KEY_seed_queue_enabled
TR_KEY_seed_queue_size
TR_KEY_seederCount
TR_KEY_seeding_time_seconds
TR_KEY_sessionCount
TR_KEY_session_count
TR_KEY_session_id
TR_KEY_show_backup_trackers
TR_KEY_show_extra_peer_details
TR_KEY_show_filterbar
TR_KEY_show_notification_area_icon
TR_KEY_show_options_window
TR_KEY_show_statusbar
TR_KEY_show_toolbar
TR_KEY_show_tracker_scrapes
TR_KEY_sizeWhenDone
TR_KEY_size_bytes
TR_KEY_size_units
TR_KEY_sort_mode
TR_KEY_sort_reversed
TR_KEY_speed
TR_KEY_speed_Bps
TR_KEY_speed_bytes
TR_KEY_speed_limit_down
TR_KEY_speed_limit_down_enabled
TR_KEY_speed_limit_up
TR_KEY_speed_limit_up_enabled
TR_KEY_speed_units
TR_KEY_startDate
TR_KEY_start_added_torrents
TR_KEY_start_minimized
TR_KEY_status
TR_KEY_statusbar_stats
TR_KEY_tag
TR_KEY_tier
TR_KEY_time_checked
TR_KEY_torrentCount
TR_KEY_torrentFile
TR_KEY_torrent_added
TR_KEY_torrent_added_notification_command
TR_KEY_torrent_added_notification_enabled
TR_KEY_torrent_complete_notification_command
TR_KEY_torrent_complete_notification_enabled
TR_KEY_torrent_complete_sound_command
TR_KEY_torrent_complete_sound_enabled
TR_KEY_torrent_duplicate
TR_KEY_torrent_get
TR_KEY_torrent_set
TR_KEY_torrent_set_location
TR_KEY_torrents
TR_KEY_totalSize
TR_KEY_total_size
TR_KEY_trackerAdd
TR_KEY_trackerRemove
TR_KEY_trackerReplace
TR_KEY_trackerStats
TR_KEY_tracker_id
TR_KEY_trackers
TR_KEY_trash_can_enabled
TR_KEY_trash_original_torrent_files
TR_KEY_umask
TR_KEY_units
TR_KEY_uploadLimit
TR_KEY_uploadLimited
TR_KEY_uploadRatio
TR_KEY_uploadSpeed
TR_KEY_upload_only
TR_KEY_upload_slots_per_torrent
TR_KEY_uploaded
TR_KEY_uploadedBytes
TR_KEY_uploadedEver
TR_KEY_uploaded_bytes
TR_KEY_url_list
TR_KEY_use_global_speed_limit
TR_KEY_use_speed_limit
TR_KEY_user_has_given_informed_consent
TR_KEY_ut_comment
TR_KEY_ut_holepunch
TR_KEY_ut_metadata
TR_KEY_ut_pex
TR_KEY_ut_recommend
TR_KEY_utp_enabled
TR_KEY_v
TR_KEY_version
TR_KEY_wanted
TR_KEY_warning_message
TR_KEY_watch_dir
TR_KEY_watch_dir_enabled
TR_KEY_webseeds
TR_KEY_webseedsSendingToUs
TR_LOC_DONE
TR_LOC_ERROR
TR_LOC_MOVING
TR_N_KEYS
TR_PEER_FROM_DHT
TR_PEER_FROM_INCOMING
TR_PEER_FROM_LPD
TR_PEER_FROM_LTEP
TR_PEER_FROM_PEX
TR_PEER_FROM_RESUME
TR_PEER_FROM_TRACKER
TR_PEER_FROM__MAX
TR_PRI_HIGH
TR_PRI_LOW
TR_PRI_NORMAL
TR_RATIO_INF
TR_RATIO_NA
TR_RPC_SESSION_ID_HEADER
TR_VARIANT_TYPE_BOOL
TR_VARIANT_TYPE_DICT
TR_VARIANT_TYPE_INT
TR_VARIANT_TYPE_LIST
TR_VARIANT_TYPE_REAL
TR_VARIANT_TYPE_STR
UINT8_MAX
UINT16_MAX
UINT32_MAX
UINTPTR_MAX
UINT_FAST8_MAX
UINT_FAST16_MAX
UINT_FAST32_MAX
UINT_LEAST8_MAX
UINT_LEAST16_MAX
UINT_LEAST32_MAX
WINT_MAX
WINT_MIN
_ATFILE_SOURCE
_BITS_STDINT_INTN_H
_BITS_STDINT_UINTN_H
_BITS_TIME_H
_BITS_TYPESIZES_H
_BITS_TYPES_H
_BITS_TYPES_LOCALE_T_H
_BITS_TYPES___LOCALE_T_H
_BITS_WCHAR_H
_DEFAULT_SOURCE
_FEATURES_H
_INTTYPES_H
_POSIX_C_SOURCE
_POSIX_SOURCE
_STDC_PREDEF_H
_STDINT_H
_SYS_CDEFS_H
_TIME_H
__FD_SETSIZE
__GLIBC_MINOR__
__GLIBC_USE_DEPRECATED_GETS
__GLIBC_USE_IEC_60559_BFP_EXT
__GLIBC_USE_IEC_60559_FUNCS_EXT
__GLIBC_USE_IEC_60559_TYPES_EXT
__GLIBC_USE_LIB_EXT2
__GLIBC__
__GNUC_VA_LIST
__GNU_LIBRARY__
__HAVE_GENERIC_SELECTION
__INO_T_MATCHES_INO64_T
__OFF_T_MATCHES_OFF64_T
__PRI64_PREFIX
__PRIPTR_PREFIX
__RLIM_T_MATCHES_RLIM64_T
__STDC_IEC_559__
__STDC_IEC_559_COMPLEX__
__STDC_ISO_10646__
__STDC_NO_THREADS__
__SYSCALL_WORDSIZE
__USE_ATFILE
__USE_FORTIFY_LEVEL
__USE_ISOC11
__USE_ISOC95
__USE_ISOC99
__USE_MISC
__USE_POSIX
__USE_POSIX2
__USE_POSIX199309
__USE_POSIX199506
__USE_POSIX_IMPLICITLY
__USE_XOPEN2K
__USE_XOPEN2K8
__WORDSIZE
__WORDSIZE_TIME64_COMPAT32
____gwchar_t_defined
__bool_true_false_are_defined
__clock_t_defined
__clockid_t_defined
__glibc_c99_flexarr_available
__itimerspec_defined
__struct_tm_defined
__time_t_defined
__timer_t_defined
__timespec_defined
false_
true_

Statics

__daylight
__timezone
__tr_current_time
__tzname
daylight
timezone
tr_mem_K
tr_size_K
tr_speed_K
tzname

Functions

asctime
asctime_r
clock
clock_getcpuclockid
clock_getres
clock_gettime
clock_nanosleep
clock_settime
compareInt
ctime
ctime_r
difftime
dysize
evbuffer_free_to_str
gmtime
gmtime_r
imaxabs
imaxdiv
localtime
localtime_r
mktime
nanosleep
stime
strftime
strftime_l
strtoimax
strtoumax
time
timegm
timelocal
timer_create
timer_delete
timer_getoverrun
timer_gettime
timer_settime
timespec_get
tr_addressIsIP

@brief convenience function to determine if an address is an IP address (IPv4 or IPv6)

tr_binary_to_hex
tr_blocklistExists
tr_blocklistGetRuleCount
tr_blocklistGetURL
tr_blocklistIsEnabled
tr_blocklistSetContent

Specify a range of IPs for Transmission to block.

tr_blocklistSetEnabled
tr_blocklistSetURL

@brief The blocklist that ges updated when an RPC client invokes the "blocklist-update" method

tr_buildPath

@brief build a filename from a series of elements using the platform's correct directory separator.

tr_ctorFree

@brief Free a torrent constructor object

tr_ctorGetBandwidthPriority

@brief Get the torrent's bandwidth priority.

tr_ctorGetDeleteSource

@brief Get the "delete .torrent file" flag from this peer constructor

tr_ctorGetDownloadDir

@brief Get the download path from this peer constructor

tr_ctorGetIncompleteDir

@brief Get the incomplete directory from this peer constructor

tr_ctorGetMetainfo

@brief Get the metainfo from this peer constructor

tr_ctorGetPaused

@brief Get the "isPaused" flag from this peer constructor

tr_ctorGetPeerLimit

@brief Get this peer constructor's peer limit

tr_ctorGetSession

@brief Get the tr_session poiner from this peer constructor

tr_ctorGetSourceFile

@brief Get the .torrent file that this ctor's metainfo came from, or NULL if tr_ctorSetMetainfoFromFile() wasn't used

tr_ctorNew

@brief Create a torrent constructor object used to instantiate a tr_torrent @param session_or_NULL the tr_session. This is required if you're going to call tr_torrentNew(), but you can use NULL for tr_torrentParse(). @see tr_torrentNew(), tr_torrentParse()

tr_ctorSetBandwidthPriority

@brief Set the torrent's bandwidth priority.

tr_ctorSetDeleteSource

@brief Set whether or not to delete the source .torrent file when the torrent is added. (Default: False)

tr_ctorSetDownloadDir

@brief Set the download folder for the torrent being added with this ctor. @see tr_ctorSetDownloadDir() @see tr_sessionInit()

tr_ctorSetFilePriorities

@brief Set the priorities for files in a torrent

tr_ctorSetFilesWanted

@brief Set the download flag for files in a torrent

tr_ctorSetIncompleteDir

@brief Set the incompleteDir for this torrent.

tr_ctorSetMetainfo

@brief Set the constructor's metainfo from a raw benc already in memory

tr_ctorSetMetainfoFromFile

@brief Set the constructor's metainfo from a local .torrent file

tr_ctorSetMetainfoFromHash

@brief Set the metainfo from an existing file in tr_getTorrentDir().

tr_ctorSetMetainfoFromMagnetLink

@brief Set the constructor's metainfo from a magnet link

tr_ctorSetPaused

Set whether or not the torrent begins downloading/seeding when created. (Default: not paused)

tr_ctorSetPeerLimit

@brief Set how many peers this torrent can connect to. (Default: 50)

tr_env_get_int

@brief Get environment variable value as int.

tr_env_get_string

@brief Get environment variable value as string (should be freed afterwards).

tr_env_key_exists

@brief Check if environment variable exists.

tr_formatter_get_units
tr_formatter_mem_B
tr_formatter_mem_init
tr_formatter_size_B
tr_formatter_size_init
tr_formatter_speed_KBps
tr_formatter_speed_init
tr_free

@brief Portability wrapper around free() in which `NULL' is a safe argument

tr_free_ptrv

@brief Free pointers in a NULL-terminated array (the array itself is not freed)

tr_getDefaultConfigDir

@brief returns Transmission's default configuration file directory.

tr_getDefaultDownloadDir

@brief returns Transmisson's default download directory.

tr_getDirFreeSpace

@brief Get available disk space (in bytes) for the specified folder. @return zero or positive integer on success, -1 in case of error.

tr_getRatio

@brief return TR_RATIO_NA, TR_RATIO_INF, or a number in [0..1] @return TR_RATIO_NA, TR_RATIO_INF, or a number in [0..1]

tr_gettimeofday

@brief Portability wrapper for gettimeofday(), with tz argument dropped

tr_hex_to_binary
tr_htonll

@brief Portability wrapper for htonll() that uses the system implementation if available

tr_loadFile

@brief Loads a file and returns its contents. On failure, NULL is returned and errno is set.

tr_localtime_r

@brief Portability wrapper for localtime_r() that uses the system implementation if available

tr_logFreeQueue
tr_logGetQueue
tr_logGetQueueEnabled
tr_logSetLevel
tr_logSetQueueEnabled
tr_lowerBound

@brief similar to bsearch() but returns the index of the lower bound

tr_makeMetaInfo

@brief create a new .torrent file

tr_malloc

@brief Portability wrapper around malloc() in which `0' is a safe argument

tr_malloc0

@brief Portability wrapper around calloc() in which `0' is a safe argument

tr_memcmp0

@brief like memcmp() but gracefully handles NULL pointers

tr_memdup

@brief make a newly-allocated copy of a chunk of memory @param src the memory to copy @param byteCount the number of bytes to copy @return a newly-allocated copy of `src' that can be freed with tr_free()

tr_memmem

@brief Portability wrapper for memmem() that uses the system implementation if available

tr_metaInfoBuilderCreate
tr_metaInfoBuilderFree
tr_metaInfoBuilderSetPieceSize

Call this before tr_makeMetaInfo() to override the builder.pieceSize and builder.pieceCount values that were set by tr_metainfoBuilderCreate()

tr_metainfoFree

@brief free a metainfo @see tr_torrentParse

tr_moveFile

@brief move a file @return True on success, false otherwise (with error set accordingly).

tr_net_init
tr_ntohll

@brief Portability wrapper for htonll() that uses the system implementation if available

tr_parseNumberRange

@brief Given a string like "1-4" or "1-4,6,9,14-51", this returns a newly-allocated array of all the integers in the set. @return a newly-allocated array of integers that must be freed with tr_free(), or NULL if a fragment of the string can't be parsed.

tr_quark_get_string

Get the string that corresponds to the specified quark

tr_quark_lookup

Find the quark that matches the specified string

tr_quark_new

Create a new quark for the specified string. If a quark already exists for that string, it is returned so that no duplicates are created.

tr_quickfindFirstK

@brief moves the best k items to the first slots in the array. O(n)

tr_realloc

@brief Portability wrapper around reallocf() in which `0' is a safe argument

tr_removeElementFromArray

@brief convenience function to remove an item from an array

tr_sessionClearAltSpeedFunc
tr_sessionClearStats
tr_sessionClose

@brief End a libtransmission session @see tr_sessionInit()

tr_sessionGetActiveSpeedLimit_KBps
tr_sessionGetAltSpeedBegin
tr_sessionGetAltSpeedDay
tr_sessionGetAltSpeedEnd
tr_sessionGetAltSpeed_KBps
tr_sessionGetCacheLimit_MB
tr_sessionGetConfigDir

@brief Return the session's configuration directory.

tr_sessionGetCumulativeStats

@brief Get cumulative bandwidth statistics for current and past sessions

tr_sessionGetDefaultSettings

Add libtransmission's default settings to the benc dictionary.

tr_sessionGetDeleteSource
tr_sessionGetDirFreeSpace

@brief Get available disk space (in bytes) for the specified directory. @return zero or positive integer on success, -1 in case of error.

tr_sessionGetDownloadDir

@brief Get the default download folder for new torrents.

tr_sessionGetEncryption
tr_sessionGetIdleLimit
tr_sessionGetIncompleteDir

@brief get the per-session incomplete download folder

tr_sessionGetPaused
tr_sessionGetPeerLimit
tr_sessionGetPeerLimitPerTorrent
tr_sessionGetPeerPort
tr_sessionGetPeerPortRandomOnStart
tr_sessionGetPortForwarding
tr_sessionGetQueueEnabled

@brief Return true if we're limiting how many torrents can concurrently download (TR_DOWN) or seed (TR_UP) at the same time

tr_sessionGetQueueSize

@brief Return the number of torrents allowed to download (if direction is TR_DOWN) or seed (if direction is TR_UP) at the same time

tr_sessionGetQueueStalledEnabled

@return true if we're torrents idle for over N minutes will be flagged as 'stalled'

tr_sessionGetQueueStalledMinutes

@return the number of minutes a torrent can be idle before being considered as stalled

tr_sessionGetRPCBindAddress
tr_sessionGetRPCPassword

@brief get the password used to restrict RPC requests. @return the password string. @see tr_sessionInit() @see tr_sessionSetRPCPassword()

tr_sessionGetRPCPort

@brief Get which port to listen for RPC requests on. @see tr_sessionInit() @see tr_sessionSetRPCPort

tr_sessionGetRPCUrl

@brief Get the base URL. @see tr_sessionInit() @see tr_sessionSetRPCUrl

tr_sessionGetRPCUsername
tr_sessionGetRPCWhitelist

@brief get the Access Control List for allowing/denying RPC requests. @return a comma-separated string of whitelist domains. @see tr_sessionInit @see tr_sessionSetRPCWhitelist

tr_sessionGetRPCWhitelistEnabled
tr_sessionGetRatioLimit
tr_sessionGetRawSpeed_KBps
tr_sessionGetSettings

Add the session's current configuration settings to the benc dictionary.

tr_sessionGetSpeedLimit_KBps
tr_sessionGetStats

@brief Get bandwidth use statistics for the current session

tr_sessionGetTorrentDoneScript
tr_sessionInit

@brief Initialize a libtransmission session.

tr_sessionIsDHTEnabled
tr_sessionIsIdleLimited
tr_sessionIsIncompleteDirEnabled

@brief get whether or not the incomplete download folder is enabled

tr_sessionIsIncompleteFileNamingEnabled

@brief return true if files will end in ".part" until they're complete

tr_sessionIsLPDEnabled
tr_sessionIsPexEnabled
tr_sessionIsPortForwardingEnabled
tr_sessionIsRPCEnabled

@brief Get whether or not RPC calls are allowed in this session. @see tr_sessionInit() @see tr_sessionSetRPCEnabled()

tr_sessionIsRPCPasswordEnabled
tr_sessionIsRatioLimited
tr_sessionIsSpeedLimited
tr_sessionIsTorrentDoneScriptEnabled
tr_sessionIsUTPEnabled
tr_sessionLimitSpeed
tr_sessionLoadSettings

Load settings from the configuration directory's settings.json file, using libtransmission's default settings as fallbacks for missing keys.

tr_sessionLoadTorrents

Load all the torrents in tr_getTorrentDir(). This can be used at startup to kickstart all the torrents from the previous session.

tr_sessionReloadBlocklists

@brief Rescan the blocklists directory and reload whatever blocklist files are found there

tr_sessionSaveSettings

Add the session's configuration settings to the benc dictionary and save it to the configuration directory's settings.json file.

tr_sessionSet

@brief Update a session's settings from a benc dictionary like to the one used in tr_sessionInit()

tr_sessionSetAltSpeedBegin
tr_sessionSetAltSpeedDay
tr_sessionSetAltSpeedEnd
tr_sessionSetAltSpeedFunc
tr_sessionSetAltSpeed_KBps

Alternative speed limits that are used during scheduled times

tr_sessionSetCacheLimit_MB
tr_sessionSetDHTEnabled
tr_sessionSetDeleteSource
tr_sessionSetDownloadDir

@brief Set the per-session default download folder for new torrents. @see tr_sessionInit() @see tr_sessionGetDownloadDir() @see tr_ctorSetDownloadDir()

tr_sessionSetEncryption
tr_sessionSetIdleLimit
tr_sessionSetIdleLimited
tr_sessionSetIncompleteDir

@brief set the per-session incomplete download folder.

tr_sessionSetIncompleteDirEnabled

@brief enable or disable use of the incomplete download folder

tr_sessionSetIncompleteFileNamingEnabled

@brief When enabled, newly-created files will have ".part" appended to their filename until the file is fully downloaded

tr_sessionSetLPDEnabled
tr_sessionSetPaused
tr_sessionSetPeerLimit
tr_sessionSetPeerLimitPerTorrent
tr_sessionSetPeerPort
tr_sessionSetPeerPortRandom
tr_sessionSetPeerPortRandomOnStart
tr_sessionSetPexEnabled

@brief Set whether or not torrents are allowed to do peer exchanges.

tr_sessionSetPortForwardingEnabled

Incoming Peer Connections Port

tr_sessionSetQueueEnabled

@brief Set whether or not to limit how many torrents can download (TR_DOWN) or seed (TR_UP) at the same time

tr_sessionSetQueueSize

@brief Set the number of torrents allowed to download (if direction is TR_DOWN) or seed (if direction is TR_UP) at the same time

tr_sessionSetQueueStalledEnabled

@brief Set whether or not to count torrents idle for over N minutes as 'stalled'

tr_sessionSetQueueStalledMinutes

@brief Consider torrent as 'stalled' when it's been inactive for N minutes. Stalled torrents are left running but are not counted by tr_sessionGetQueueSize().

tr_sessionSetRPCCallback

Register to be notified whenever something is changed via RPC, such as a torrent being added, removed, started, stopped, etc.

tr_sessionSetRPCEnabled

@brief Set whether or not RPC calls are allowed in this session.

tr_sessionSetRPCPassword
tr_sessionSetRPCPasswordEnabled
tr_sessionSetRPCPort

@brief Specify which port to listen for RPC requests on. @see tr_sessionInit() @see tr_sessionGetRPCPort

tr_sessionSetRPCUrl

@brief Specify which base URL to use.

tr_sessionSetRPCUsername
tr_sessionSetRPCWhitelist

@brief Specify a whitelist for remote RPC access

tr_sessionSetRPCWhitelistEnabled
tr_sessionSetRatioLimit
tr_sessionSetRatioLimited
tr_sessionSetSpeedLimit_KBps

Primary session speed limits

tr_sessionSetTorrentDoneScript
tr_sessionSetTorrentDoneScriptEnabled
tr_sessionSetUTPEnabled
tr_sessionUseAltSpeed
tr_sessionUseAltSpeedTime
tr_sessionUsesAltSpeed
tr_sessionUsesAltSpeedTime
tr_snprintf

@brief Portability wrapper for snprintf() that uses the system implementation if available

tr_str_has_suffix

@brief Returns true if the string ends with the specified case-insensitive suffix

tr_strcmp0

@brief like strcmp() but gracefully handles NULL strings

tr_strdup

@brief make a newly-allocated copy of a string @param in is a void* so that callers can pass in both signed & unsigned without a cast @return a newly-allocated copy of `in' that can be freed with tr_free()

tr_strdup_printf

@brief sprintf() a string into a newly-allocated buffer large enough to hold it @return a newly-allocated string that can be freed with tr_free()

tr_strdup_vprintf
tr_strerror

@brief Convenience wrapper around strerorr() guaranteed to not return NULL @param errnum the error number to describe

tr_strip_positional_args

@addtogroup utils Utilities @{

tr_strlcpy

@brief Portability wrapper for strlcpy() that uses the system implementation if available

tr_strndup

@brief make a newly-allocated copy of a substring @param in is a void* so that callers can pass in both signed & unsigned without a cast @param len length of the substring to copy. if a length less than zero is passed in, strlen(len) is used @return a newly-allocated copy of `in' that can be freed with tr_free()

tr_strpercent
tr_strratio

@param buf the buffer to write the string to @param buflen buf's size @param ratio the ratio to convert to a string @param infinity the string represntation of "infinity"

tr_strsep

@brief Portability wrapper for strsep() that uses the system implementation if available

tr_strstrip

@brief strips leading and trailing whitspace from a string @return the stripped string

tr_time_msec

@brief return the current date in milliseconds

tr_timerAdd

@brief Convenience wrapper around timer_add() to have a timer wake up in a number of seconds and microseconds @param timer the timer to set @param seconds seconds to wait @param microseconds microseconds to wait

tr_timerAddMsec

@brief Convenience wrapper around timer_add() to have a timer wake up in a number of milliseconds @param timer the timer to set @param milliseconds milliseconds to wait

tr_torrentAmountFinished
tr_torrentAvailability

tr_torrentAvailability

tr_torrentCanManualUpdate
tr_torrentClearCompletenessCallback
tr_torrentClearIdleLimitHitCallback
tr_torrentClearRatioLimitHitCallback
tr_torrentFiles
tr_torrentFilesFree
tr_torrentFindFile

@brief find the location of a torrent's file by looking with and without the ".part" suffix, looking in downloadDir and incompleteDir, etc. @return a newly-allocated string (that must be tr_free()d by the caller when done) that gives the location of this file on disk, or NULL if no file exists yet. @param tor the torrent whose file we're looking for @param fileNum the fileIndex, in [0...tr_info.fileCount)

tr_torrentFindFromHash
tr_torrentFindFromId
tr_torrentFindFromMagnetLink

@brief Convenience function similar to tr_torrentFindFromHash()

tr_torrentGetBytesLeftToAllocate
tr_torrentGetCurrentDir

Returns the root directory of where the torrent is.

tr_torrentGetDownloadDir
tr_torrentGetFilePriorities

@brief Get this torrent's file priorities.

tr_torrentGetIdleLimit
tr_torrentGetIdleMode
tr_torrentGetPeerLimit
tr_torrentGetPriority
tr_torrentGetQueuePosition

@brief Return the queued torrent's position in the queue it's in. [0...n)

tr_torrentGetRatioLimit
tr_torrentGetRatioMode
tr_torrentGetSeedIdle
tr_torrentGetSeedRatio
tr_torrentGetSpeedLimit_KBps
tr_torrentId

@brief Returns this torrent's unique ID.

tr_torrentInfo
tr_torrentInfoGetMagnetLink
tr_torrentManualUpdate

MANUAL ANNOUNCE

tr_torrentName

@return this torrent's name.

tr_torrentNew

Instantiate a single torrent.

tr_torrentParse

@brief Parses the specified metainfo

tr_torrentPeers
tr_torrentPeersFree
tr_torrentRemove

@brief Removes our .torrent and .resume files for this torrent

tr_torrentRenamePath

@brief Rename a file or directory in a torrent.

tr_torrentSetActivityDate

@deprecated

tr_torrentSetAddedDate

@deprecated

tr_torrentSetAnnounceList

@brief Modify a torrent's tracker list.

tr_torrentSetCompletenessCallback

Register to be notified whenever a torrent's "completeness" changes. This will be called, for example, when a torrent finishes downloading and changes from TR_LEECH to either TR_SEED or TR_PARTIAL_SEED.

tr_torrentSetDoneDate

@deprecated

tr_torrentSetDownloadDir
tr_torrentSetFileDLs

@brief Set a batch of files to be downloaded or not.

tr_torrentSetFilePriorities

@brief Set a batch of files to a particular priority.

tr_torrentSetIdleLimit
tr_torrentSetIdleLimitHitCallback

Register to be notified whenever a torrent's idle limit has been hit. This will be called when the seeding torrent's idle time has met or exceeded the designated idle limit.

tr_torrentSetIdleMode
tr_torrentSetLocation

@brief Tell transmsision where to find this torrent's local data.

tr_torrentSetMetadataCallback

Register to be notified whenever a torrent changes from having incomplete metadata to having complete metadata. This happens when a magnet link finishes downloading metadata from its peers.

tr_torrentSetPeerLimit

Peer Limits

tr_torrentSetPriority
tr_torrentSetQueuePosition

@brief Set the queued torrent's position in the queue it's in. Special cases: pos <= 0 moves to the front; pos >= queue length moves to the back

tr_torrentSetQueueStartCallback

@brief Set a callback that is invoked when the queue starts a torrent

tr_torrentSetRatioLimit
tr_torrentSetRatioLimitHitCallback

Register to be notified whenever a torrent's ratio limit has been hit. This will be called when the torrent's ul/dl ratio has met or exceeded the designated ratio limit.

tr_torrentSetRatioMode
tr_torrentSetSpeedLimit_KBps

Torrent speed limits

tr_torrentStart

@brief Start a torrent

tr_torrentStartNow

@brief Like tr_torrentStart(), but resumes right away regardless of the queues.

tr_torrentStat

Return a pointer to an tr_stat structure with updated information on the torrent. This is typically called by the GUI clients every second or so to get a new snapshot of the torrent's status.

tr_torrentStatCached

Like tr_torrentStat(), but only recalculates the statistics if it's been longer than a second since they were last calculated. This can reduce the CPU load if you're calling tr_torrentStat() frequently.

tr_torrentStop

@brief Stop (pause) a torrent

tr_torrentTrackers
tr_torrentTrackersFree
tr_torrentUseSessionLimits
tr_torrentUseSpeedLimit
tr_torrentUsesSessionLimits
tr_torrentUsesSpeedLimit
tr_torrentVerify

Queue a torrent for verification.

tr_torrentWebSpeeds_KBps

@brief get the download speeds for each of this torrent's webseed sources.

tr_torrentsQueueMoveBottom

@brief Convenience function for moving a batch of torrents to the back of their queue(s)

tr_torrentsQueueMoveDown

@brief Convenience function for moving a batch of torrents back one step in their queue(s)

tr_torrentsQueueMoveTop

@brief Convenience function for moving a batch of torrents to the front of their queue(s)

tr_torrentsQueueMoveUp

@brief Convenience function for moving a batch of torrents ahead one step in their queue(s)

tr_truncd

@brief truncate a double value at a given number of decimal places.

tr_urlIsValid

@brief return true if the url is a [ http, https, ftp, sftp ] url that Transmission understands

tr_urlIsValidTracker

@brief return true if the url is a http or https or UDP url that Transmission understands

tr_urlParse

@brief parse a URL into its component parts @return True on success or false if an error occurred

tr_utf8clean

@brief make a copy of 'str' whose non-utf8 content has been corrected or stripped @return a newly-allocated string that must be freed with tr_free() @param str the string to make a clean copy of @param len the length of the string to copy. If -1, the entire string is used.

tr_valloc
tr_variantDictAdd
tr_variantDictAddBool
tr_variantDictAddDict
tr_variantDictAddInt
tr_variantDictAddList
tr_variantDictAddQuark
tr_variantDictAddRaw
tr_variantDictAddReal
tr_variantDictAddStr
tr_variantDictChild
tr_variantDictFind
tr_variantDictFindBool
tr_variantDictFindDict
tr_variantDictFindInt
tr_variantDictFindList
tr_variantDictFindRaw
tr_variantDictFindReal
tr_variantDictFindStr
tr_variantDictRemove
tr_variantDictReserve
tr_variantDictSteal
tr_variantFree
tr_variantFromBuf
tr_variantFromFile
tr_variantGetBool
tr_variantGetInt
tr_variantGetRaw
tr_variantGetReal
tr_variantGetStr
tr_variantInitBool
tr_variantInitDict
tr_variantInitInt
tr_variantInitList
tr_variantInitQuark
tr_variantInitRaw
tr_variantInitReal
tr_variantInitStr
tr_variantListAdd
tr_variantListAddBool
tr_variantListAddDict
tr_variantListAddInt
tr_variantListAddList
tr_variantListAddQuark
tr_variantListAddRaw
tr_variantListAddReal
tr_variantListAddStr
tr_variantListChild
tr_variantListRemove
tr_variantListReserve
tr_variantListSize
tr_variantMergeDicts
tr_variantToBuf
tr_variantToFile
tr_variantToStr
tr_wait_msec

@brief sleep the specified number of milliseconds

tr_wildmat

@brief Rich Salz's classic implementation of shell-style pattern matching for ?, , [], and * characters. @return 1 if the pattern matches, 0 if it doesn't, or -1 if an error occured

tzset
wcstoimax
wcstoumax

Type Definitions

__blkcnt64_t
__blkcnt_t
__blksize_t
__builtin_va_list
__caddr_t
__clock_t
__clockid_t
__daddr_t
__dev_t
__fsblkcnt64_t
__fsblkcnt_t
__fsfilcnt64_t
__fsfilcnt_t
__fsword_t
__gid_t
__gnuc_va_list
__gwchar_t
__id_t
__ino64_t
__ino_t
__int8_t
__int16_t
__int32_t
__int64_t
__intmax_t
__intptr_t
__key_t
__locale_t
__loff_t
__mode_t
__nlink_t
__off64_t
__off_t
__pid_t
__quad_t
__rlim64_t
__rlim_t
__sig_atomic_t
__socklen_t
__ssize_t
__suseconds_t
__syscall_slong_t
__syscall_ulong_t
__time_t
__timer_t
__u_char
__u_int
__u_long
__u_quad_t
__u_short
__uid_t
__uint8_t
__uint16_t
__uint32_t
__uint64_t
__uintmax_t
__useconds_t
clock_t
clockid_t
int_fast8_t
int_fast16_t
int_fast32_t
int_fast64_t
int_least8_t
int_least16_t
int_least32_t
int_least64_t
intmax_t
locale_t
pid_t
time_t
timer_t
tr_altSpeedFunc
tr_block_index_t
tr_fileFunc

@addtogroup tr_torrent Torrents @{

tr_file_index_t
tr_piece_index_t
tr_port
tr_priority_t
tr_quark
tr_rpc_func
tr_torrent_completeness_func

@param wasRunning whether or not the torrent was running when it changed its completeness state

tr_torrent_idle_limit_hit_func
tr_torrent_metadata_func
tr_torrent_ratio_limit_hit_func
tr_torrent_rename_done_func
tr_verify_done_func

Callback function invoked when a torrent finishes being verified.

uint_fast8_t
uint_fast16_t
uint_fast32_t
uint_fast64_t
uint_least8_t
uint_least16_t
uint_least32_t
uint_least64_t
uintmax_t
va_list
wchar_t

Unions

tr_variant__bindgen_ty_1
tr_variant_string__bindgen_ty_1