transmission/libtransmission/inout.h

44 lines
1.2 KiB
C
Raw Normal View History

// This file Copyright © Mnemosyne LLC.
2022-08-08 18:05:39 +00:00
// It may be used under GPLv2 (SPDX: GPL-2.0-only), GPLv3 (SPDX: GPL-3.0-only),
// or any future license endorsed by Mnemosyne LLC.
// License text can be found in the licenses/ folder.
2006-07-16 19:39:23 +00:00
#pragma once
#ifndef __TRANSMISSION__
#error only libtransmission should #include this header.
#endif
#include <cstddef> // size_t
#include <cstdint> // uint8_t, uint32_t
2023-07-08 15:24:03 +00:00
#include "libtransmission/transmission.h"
2023-07-08 15:24:03 +00:00
#include "libtransmission/block-info.h"
struct tr_torrent;
2006-07-16 19:39:23 +00:00
/**
* @addtogroup file_io File IO
* @{
*/
/**
* Reads the block specified by the piece index, offset, and length.
2008-10-03 04:49:06 +00:00
* @return 0 on success, or an errno value on failure.
*/
[[nodiscard]] int tr_ioRead(tr_torrent const& tor, tr_block_info::Location const& loc, size_t len, uint8_t* setme);
/**
* Writes the block specified by the piece index, offset, and length.
2008-10-03 04:49:06 +00:00
* @return 0 on success, or an errno value on failure.
*/
[[nodiscard]] int tr_ioWrite(tr_torrent& tor, tr_block_info::Location const& loc, size_t len, uint8_t const* writeme);
2007-01-14 12:00:21 +00:00
/**
* @brief Test to see if the piece matches its metainfo's SHA1 checksum.
*/
[[nodiscard]] bool tr_ioTestPiece(tr_torrent const& tor, tr_piece_index_t piece);
2006-07-16 19:39:23 +00:00
/* @} */