Torrent

https://pkg.go.dev/github.com/anacrolix/torrent
Admin
This repository implements BitTorrent-related packages and command-line utilities in Go. The...
Tokens:123,390
Snippets:1,689
Trust Score:10
Update:3 months ago
Show doc for...
Tokens:
Raw
### Install bencode Package

Source: https://pkg.go.dev/github.com/anacrolix/torrent/bencode

Install the bencode package using go get.

```bash
go get github.com/anacrolix/torrent

```

--------------------------------

### Install Callbacks for PeerUploadOrder

Source: https://pkg.go.dev/github.com/anacrolix/torrent/analysis

Method to install callbacks for the PeerUploadOrder, likely for event handling.

```go
func (me *PeerUploadOrder) Install(cbs *torrent.Callbacks)
```

--------------------------------

### PeerUploadOrder.Install

Source: https://pkg.go.dev/github.com/anacrolix/torrent/analysis

Installs the PeerUploadOrder with the given callbacks.

```APIDOC
## func (*PeerUploadOrder) Install

```
func (me *PeerUploadOrder) Install(cbs *torrent.Callbacks)
```
```

--------------------------------

### Initiate File Download

Source: https://pkg.go.dev/github.com/anacrolix/torrent

Starts or resumes the download process for this file.

```go
f.Download()
```

--------------------------------

### RunSimple

Source: https://pkg.go.dev/github.com/anacrolix/torrent/tracker/udp/server

Starts a simple UDP tracker server with the provided configuration.

```APIDOC
## RunSimple

### Description
Starts a simple UDP tracker server with the provided configuration.

### Method
func RunSimple(ctx context.Context, s *Server, pc net.PacketConn, family udp.AddrFamily) error

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
- **ctx** (context.Context) - Required - The context for the server operation.
- **s** (*Server) - Required - The server instance to run.
- **pc** (net.PacketConn) - Required - The packet connection to use for the server.
- **family** (udp.AddrFamily) - Required - The address family for the server.

### Request Example
```json
{
  "ctx": "context.Context",
  "s": "*Server",
  "pc": "net.PacketConn",
  "family": "udp.AddrFamily"
}
```

### Response
#### Success Response (0)
- **error** (error) - An error if the server fails to start or run.

#### Response Example
```json
{
  "error": "error"
}
```
```

--------------------------------

### Iterate Table2 Keys From a Starting Point

Source: https://pkg.go.dev/github.com/anacrolix/torrent/internal/indexed

Iterates over the keys in a Table2 starting from a specified key. Returns a sequence of keys.

```go
func (me *Table2[K, V]) IterKeysFrom(start K) iter.Seq[K]
```

--------------------------------

### Create Default Client Configuration

Source: https://pkg.go.dev/github.com/anacrolix/torrent

Returns a default ClientConfig. No specific setup is required.

```go
func NewDefaultClientConfig() *ClientConfig
```

--------------------------------

### TrackerClient Start Method

Source: https://pkg.go.dev/github.com/anacrolix/torrent/webtorrent

Finishes initialization and starts the tracker client's run routine. It accepts an onStop callback that is invoked when the routine completes. This prevents race conditions between initialization and closing. This method is added in v1.34.0.

```go
func (tc *TrackerClient) Start(onStop func(error))
```

--------------------------------

### Get File Info

Source: https://pkg.go.dev/github.com/anacrolix/torrent

Returns the metainfo.FileInfo associated with this file.

```go
info := f.FileInfo()
```

--------------------------------

### Create Default Client Configuration

Source: https://pkg.go.dev/github.com/anacrolix/torrent

Returns a default ClientConfig. Use this as a starting point for client configuration.

```go
cfg := torrent.NewDefaultClientConfig()
```

--------------------------------

### Iterate Table2 Records From a Starting Point

Source: https://pkg.go.dev/github.com/anacrolix/torrent/internal/indexed

Iterates over the records in a Table2 starting from a specified record. Returns a sequence of records.

```go
func (me Table2) IterFrom(start R) iter.Seq[R]
```

--------------------------------

### Create a New Torrent Client

Source: https://pkg.go.dev/github.com/anacrolix/torrent

Initializes a new torrent client with default configuration. Use this to start managing torrents.

```go
cl, err := torrent.NewClient(cfg)
if err != nil {
	panic(err)
}
```

--------------------------------

### Iterate Map Entries from Start

Source: https://pkg.go.dev/github.com/anacrolix/torrent/internal/indexed

Creates a sequence iterator for map entries starting from a specified record. Useful for partial iteration of the map.

```go
func (me Map) IterFrom(start R) iter.Seq[R]
```

--------------------------------

### Get File Begin Piece Index

Source: https://pkg.go.dev/github.com/anacrolix/torrent

Returns the index of the first piece that belongs to this file.

```go
idx := f.BeginPieceIndex()
```

--------------------------------

### Get Display Path for File

Source: https://pkg.go.dev/github.com/anacrolix/torrent

Returns the user-friendly display path for the file.

```go
path := f.DisplayPath()
```

--------------------------------

### Begin Function

Source: https://pkg.go.dev/github.com/anacrolix/torrent/internal/nestedmaps

Initializes a new Path to the root of a given map, allowing for the start of nested map traversal.

```APIDOC
## func Begin[K comparable, M ~map[K]V, V any](m *M) Path[M]

### Description
Begins a traversal of a nested map structure, returning a Path interface to the root.

### Parameters
- **m** (*M): A pointer to the map to traverse.
```

--------------------------------

### Usage Example: Marshal and Unmarshal

Source: https://pkg.go.dev/github.com/anacrolix/torrent/bencode

Demonstrates encoding a struct to bencode format and then decoding it back. Ensure necessary imports are included.

```go
package demo

import (
	bencode "github.com/anacrolix/torrent/bencode"
	"fmt"
	"log"
)

type Message struct {
	Query string `json:"q,omitempty" bencode:"q,omitempty"`
}

var v Message

func main(){
	// encode
	data, err := bencode.Marshal(v)
	if err != nil {
		log.Fatal(err)
	}
	
	//decode
	err = bencode.Unmarshal(data, &v)
	if err != nil {
		log.Fatal(err)
	}
	fmt.Println(v)
}

```

--------------------------------

### Begin Function Signature

Source: https://pkg.go.dev/github.com/anacrolix/torrent/internal/nestedmaps

Initializes a new Path for a given map. This function is used to start navigating a nested map structure.

```go
func Begin[K comparable, M ~map[K]V, V any](m *M) Path[M]
```

--------------------------------

### Client.StartNewRequest

Source: https://pkg.go.dev/github.com/anacrolix/torrent/webseed

Initiates a new request to fetch data from a webseed. This is the primary method for starting data retrieval.

```APIDOC
## func (ws *Client) StartNewRequest(ctx context.Context, r RequestSpec, debugLogger *slog.Logger) Request

### Description
Starts a new request to fetch data from a webseed. This method takes a context, a request specification, and an optional debug logger to initiate the data retrieval process.

### Method
*Client Method*

### Parameters
* **ctx** (context.Context) - The context for the request, used for cancellation and deadlines.
* **r** (RequestSpec) - The specification for the data request.
* **debugLogger** (*slog.Logger) - An optional logger for debugging information.
```

--------------------------------

### Get Metainfo

Source: https://pkg.go.dev/github.com/anacrolix/torrent

Returns a run-time generated metainfo for the torrent, including info bytes and announce-list.

```go
func (t *Torrent) Metainfo() metainfo.MetaInfo
```

--------------------------------

### Client.AddListener

Source: https://pkg.go.dev/github.com/anacrolix/torrent

Registers a Listener and starts accepting connections on it. Listeners provided this way must be Closed by the user.

```APIDOC
## Client.AddListener

### Description
Registers a Listener and starts accepting connections on it. Listeners provided this way must be Closed by the user.

### Method
(Not specified, likely internal or part of a specific protocol)

### Endpoint
(Not applicable)

### Parameters
#### Path Parameters
(None)

#### Query Parameters
(None)

#### Request Body
- **l** (Listener) - The Listener to register.

### Request Example
(Not applicable)

### Response
#### Success Response
(None)

#### Response Example
(Not applicable)
```

--------------------------------

### FileInfo.BeginPieceIndex Method

Source: https://pkg.go.dev/github.com/anacrolix/torrent/metainfo

Calculates the starting piece index for a FileInfo given a piece length. This is useful for determining which pieces belong to a specific file.

```go
func (fi *FileInfo) BeginPieceIndex(pieceLength int64) int
```

--------------------------------

### Get Peer Statistics

Source: https://pkg.go.dev/github.com/anacrolix/torrent

Retrieves statistics for the peer connection. This is the recommended way to get peer performance metrics.

```go
func (p *Peer) Stats() (ret PeerStats)
```

--------------------------------

### Get Files

Source: https://pkg.go.dev/github.com/anacrolix/torrent

Returns handles to the files within the torrent. This requires that the Info is available first.

```go
func (t *Torrent) Files() []*File
```

--------------------------------

### Create File Storage Client with Completion

Source: https://pkg.go.dev/github.com/anacrolix/torrent/storage

Initializes a file storage client that supports custom piece completion logic. Returns a ClientImplCloser.

```go
func NewFileWithCompletion(baseDir string, completion PieceCompletion) ClientImplCloser
```

--------------------------------

### PieceCompletionGetSetter Interface

Source: https://pkg.go.dev/github.com/anacrolix/torrent/storage

Interface for getting and setting the completion status of individual pieces. The extra error parameter in Get is vestigial.

```go
type PieceCompletionGetSetter interface {
	// I think the extra error parameter is vestigial. Looks like you should put your error in
	// Completion.Err.
	Get(metainfo.PieceKey) (Completion, error)
	Set(_ metainfo.PieceKey, complete bool) error
}
```

--------------------------------

### Add Listener to Client

Source: https://pkg.go.dev/github.com/anacrolix/torrent

Registers a Listener with the client and starts accepting connections on it. Listeners provided this way must be closed by the user.

```go
func (cl *Client) AddListener(l Listener)
```

--------------------------------

### Get All Torrent Handles

Source: https://pkg.go.dev/github.com/anacrolix/torrent

Returns handles to all torrents currently loaded in the client.

```go
func (cl *Client) Torrents() []*Torrent
```

--------------------------------

### FileInfo.BeginPieceIndex

Source: https://pkg.go.dev/github.com/anacrolix/torrent/metainfo

Calculates the starting piece index for the file, given a piece length.

```APIDOC
## BeginPieceIndex

### Description
Calculates the starting piece index for the file, given a piece length.

### Method
* (fi *FileInfo) BeginPieceIndex(pieceLength int64) int

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Parameters
#### Path Parameters
- **pieceLength** (int64) - Required - The length of each piece in bytes.

### Response
#### Success Response
- **int**: The starting piece index.

### Request Example
None

### Response Example
None
```

--------------------------------

### New

Source: https://pkg.go.dev/github.com/anacrolix/torrent/util/dirwatch

Creates a new Instance of the dirwatch package, which starts monitoring the specified directory for changes. It returns an Instance and an error if the directory cannot be monitored.

```APIDOC
## New

### Description

Creates a new Instance of the dirwatch package, which starts monitoring the specified directory for changes. It returns an Instance and an error if the directory cannot be monitored.

### Signature

```go
func New(dirName string) (i *Instance, err error)
```

### Parameters

#### Path Parameters

- **dirName** (string) - Required - The name of the directory to monitor.
```

--------------------------------

### Get Client String Representation

Source: https://pkg.go.dev/github.com/anacrolix/torrent

Returns a string representation of the client. Added in v1.8.0.

```go
func (cl *Client) String() string
```

--------------------------------

### New Instance Function

Source: https://pkg.go.dev/github.com/anacrolix/torrent/util/dirwatch

Creates and returns a new Instance for watching a specified directory. It returns an error if the directory cannot be initialized for watching.

```go
func New(dirName string) (i *Instance, err error)
```

--------------------------------

### Get Piece Completion Range

Source: https://pkg.go.dev/github.com/anacrolix/torrent/storage

Retrieves piece completion as an iterator, optimized for long sequences of Gets. It utilizes the PieceCompletionGetRanger interface if implemented.

```go
func GetPieceCompletionRange(pc PieceCompletion, ih infohash.T, begin, end int) iter.Seq[Completion]
```

--------------------------------

### TrackerClient.Start

Source: https://pkg.go.dev/github.com/anacrolix/torrent/webtorrent

Starts the tracker client, initiating its background operations. It accepts a callback function to be executed when the client stops.

```APIDOC
## TrackerClient.Start

### Description
Starts the tracker client, initiating its background operations. It accepts a callback function to be executed when the client stops.

### Method
func

### Parameters
#### Path Parameters
- **onStop** (func(error)) - Required - A callback function that is executed when the tracker client stops, receiving an error if one occurred.
```

--------------------------------

### Create File Storage Client with Options

Source: https://pkg.go.dev/github.com/anacrolix/torrent/storage

Creates a new file storage client with advanced configuration options. Returns a ClientImplCloser.

```go
func NewFileOpts(opts NewFileClientOpts) ClientImplCloser
```

--------------------------------

### Iterate Table2 Records From a Starting Point with a Condition

Source: https://pkg.go.dev/github.com/anacrolix/torrent/internal/indexed

Iterates over the records in a Table2 starting from a specified record and continuing as long as a condition is met. Returns a sequence of records.

```go
func (me Table2) IterFromWhile(gte R, while func(R) bool) iter.Seq[R]
```

--------------------------------

### Iterate Map Entries from Start While Condition Met

Source: https://pkg.go.dev/github.com/anacrolix/torrent/internal/indexed

Creates a sequence iterator for map entries starting from a specified record, continuing as long as a condition is met. Useful for conditional iteration.

```go
func (me Map) IterFromWhile(gte R, while func(R) bool) iter.Seq[R]
```

--------------------------------

### Get ICE Servers

Source: https://pkg.go.dev/github.com/anacrolix/torrent

Retrieves the list of ICE servers configured for WebRTC, if any.

```go
ices := cl.ICEServers()
```

--------------------------------

### Cache Init Method

Source: https://pkg.go.dev/github.com/anacrolix/torrent/smartban

Initializes the cache.

```go
func (me *Cache[Peer, BlockKey, Hash]) Init()
```

--------------------------------

### Get Listen Addresses

Source: https://pkg.go.dev/github.com/anacrolix/torrent

Returns a slice of network addresses the client is listening on.

```go
addrs := cl.ListenAddrs()
```

--------------------------------

### File.Download Method

Source: https://pkg.go.dev/github.com/anacrolix/torrent

Initiates the download process for all pieces that contain data relevant to this file.

```go
func (f *File) Download()
```

--------------------------------

### Get Torrent Client String Representation

Source: https://pkg.go.dev/github.com/anacrolix/torrent

Returns a string representation of the torrent client.

```go
s := cl.String()
```

--------------------------------

### Get Infohash as Hex String

Source: https://pkg.go.dev/github.com/anacrolix/torrent/types/infohash

Returns the hexadecimal string representation of the Infohash.

```go
func (t T) HexString() string
```

--------------------------------

### New Storage Client

Source: https://pkg.go.dev/github.com/anacrolix/torrent/storage

Constructs a new storage client using a provided ClientImpl. This is the entry point for interacting with storage backends.

```go
func NewClient(cl ClientImpl) *Client
```

--------------------------------

### Get Piece Index

Source: https://pkg.go.dev/github.com/anacrolix/torrent/metainfo

Returns the index of the piece.

```APIDOC
## Get Piece Index

### Description
Returns the index of the piece.

### Method
```go
func (p Piece) Index() int
```

### Returns
* **int** - The index of the piece.
```

--------------------------------

### Get Piece Index

Source: https://pkg.go.dev/github.com/anacrolix/torrent/metainfo

Returns the index of the piece.

```go
func (p Piece) Index() int
```

--------------------------------

### Create File Storage Client Partitioned by InfoHash

Source: https://pkg.go.dev/github.com/anacrolix/torrent/storage

Initializes a file storage client where data is partitioned by infohash within the base directory. Returns a ClientImplCloser.

```go
func NewFileByInfoHash(baseDir string) ClientImplCloser
```

--------------------------------

### File.Offset Method

Source: https://pkg.go.dev/github.com/anacrolix/torrent

Returns the starting byte offset of this file's data within the overall torrent.

```go
func (f *File) Offset() int64
```

--------------------------------

### RunSimple Function Signature

Source: https://pkg.go.dev/github.com/anacrolix/torrent/tracker/udp/server

The signature for the RunSimple function, which starts a UDP tracker server.

```go
func RunSimple(ctx context.Context, s *Server, pc net.PacketConn, family udp.AddrFamily) error
```

--------------------------------

### New Memory-Mapped Client with Completion

Source: https://pkg.go.dev/github.com/anacrolix/torrent/storage

Initializes a new memory-mapped storage client that supports piece completion tracking.

```go
func NewMMapWithCompletion(baseDir string, completion PieceCompletion) *mmapClientImpl
```

--------------------------------

### Table.IterFrom

Source: https://pkg.go.dev/github.com/anacrolix/torrent/internal/indexed

Returns an iterator that starts from a specified record.

```APIDOC
## Table.IterFrom

### Description
Returns an iterator that starts from a specified record.

### Method
Not applicable (Go method)

### Endpoint
Not applicable (Go method)

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Request Example
None

### Response
#### Success Response (200)
- **iter.Seq[R]** - An iterator sequence starting from the specified record.
```

--------------------------------

### PieceBytesMissing

Source: https://pkg.go.dev/github.com/anacrolix/torrent

Get missing bytes count for a specific piece.

```APIDOC
## PieceBytesMissing

### Description
Get missing bytes count for a specific piece.

### Method
func (*Torrent) PieceBytesMissing(piece int) int64
```

--------------------------------

### Create Resource Pieces Client with Options

Source: https://pkg.go.dev/github.com/anacrolix/torrent/storage

Creates a new client for managing resource pieces with additional options. Requires a PieceProvider and ResourcePiecesOpts.

```go
func NewResourcePiecesOpts(p PieceProvider, opts ResourcePiecesOpts) ClientImpl
```

--------------------------------

### Create Testing Client Configuration

Source: https://pkg.go.dev/github.com/anacrolix/torrent

Returns a ClientConfig suitable for testing. Requires a testing.TB object.

```go
func TestingConfig(t testing.TB) *ClientConfig
```

--------------------------------

### Get Torrent Info

Source: https://pkg.go.dev/github.com/anacrolix/torrent

Returns the metainfo info dictionary, or nil if it's not yet available.

```go
func (t *Torrent) Info() (info *metainfo.Info)
```

--------------------------------

### Get Piece Length

Source: https://pkg.go.dev/github.com/anacrolix/torrent/metainfo

Returns the length of the piece in bytes.

```APIDOC
## Get Piece Length

### Description
Returns the length of the piece in bytes.

### Method
```go
func (p Piece) Length() int64
```

### Returns
* **int64** - The length of the piece.
```

--------------------------------

### Create New Torrent Client

Source: https://pkg.go.dev/github.com/anacrolix/torrent

Initializes a new torrent client with the given configuration. Takes ownership of the ClientConfig.

```go
func NewClient(cfg *ClientConfig) (cl *Client, err error)
```

--------------------------------

### Get Piece Length

Source: https://pkg.go.dev/github.com/anacrolix/torrent/metainfo

Returns the length of the piece in bytes.

```go
func (p Piece) Length() int64
```

--------------------------------

### PexPeerFlags Get Method

Source: https://pkg.go.dev/github.com/anacrolix/torrent/peer_protocol

Checks if a specific PexPeerFlags is set.

```go
func (me PexPeerFlags) Get(f PexPeerFlags) bool
```

--------------------------------

### Create Testing Client Configuration

Source: https://pkg.go.dev/github.com/anacrolix/torrent

Generates a ClientConfig suitable for testing environments. Requires a testing.TB instance.

```go
cfg := torrent.TestingConfig(t)
```

--------------------------------

### Create Memory-Mapped File Storage Client

Source: https://pkg.go.dev/github.com/anacrolix/torrent/storage

Initializes a memory-mapped file storage client. Supports advanced configurations similar to NewFileOpts. Returns a ClientImplCloser.

```go
func NewMMap(baseDir string) ClientImplCloser
```

--------------------------------

### Get Closed Channel

Source: https://pkg.go.dev/github.com/anacrolix/torrent

Returns a channel that is closed when the Torrent is closed.

```go
func (t *Torrent) Closed() events.Done
```

--------------------------------

### Client.SetInfo

Source: https://pkg.go.dev/github.com/anacrolix/torrent/webseed

Sets the torrent info and file index for the webseed client. This is likely an internal setup method.

```APIDOC
## func (me *Client) SetInfo(info *metainfo.Info, fileIndex *segments.Index)

### Description
Sets the torrent info and file index for the webseed client. This method is used to configure the client with the necessary metadata for fetching torrent pieces.

### Method
*Client Method*

### Parameters
* **info** (*metainfo.Info) - Description of the torrent metadata.
* **fileIndex** (*segments.Index) - Description of the file index for the torrent.
```

--------------------------------

### Get Peer ID

Source: https://pkg.go.dev/github.com/anacrolix/torrent

Returns the client's Peer ID.

```go
func (cl *Client) PeerID() PeerID
```

--------------------------------

### Client.StartNewRequest Method Signature

Source: https://pkg.go.dev/github.com/anacrolix/torrent/webseed

Method signature for initiating a new webseed request.

```go
func (ws *Client) StartNewRequest(ctx context.Context, r RequestSpec, debugLogger *slog.Logger) Request
```

--------------------------------

### Get Listeners

Source: https://pkg.go.dev/github.com/anacrolix/torrent

Retrieves the list of listeners for the client. Added in v1.29.0.

```go
func (cl *Client) Listeners() []Listener
```

--------------------------------

### PeerUploadOrder.Init

Source: https://pkg.go.dev/github.com/anacrolix/torrent/analysis

Initializes the PeerUploadOrder.

```APIDOC
## func (*PeerUploadOrder) Init

```
func (me *PeerUploadOrder) Init()
```
```

--------------------------------

### Get All Connection Statistics

Source: https://pkg.go.dev/github.com/anacrolix/torrent

Returns a struct containing statistics for all connections.

```go
stats := me.Copy()
```

--------------------------------

### Get Count as String

Source: https://pkg.go.dev/github.com/anacrolix/torrent

Returns a string representation of the Count value.

```go
s := me.String()
```

--------------------------------

### Get Count as Int64

Source: https://pkg.go.dev/github.com/anacrolix/torrent

Returns the current value of the Count as an int64.

```go
val := me.Int64()
```

--------------------------------

### Create BoltDB Storage Client

Source: https://pkg.go.dev/github.com/anacrolix/torrent/storage

Initializes a new BoltDB storage client. Requires a file path for the database. Returns a ClientImplCloser.

```go
func NewBoltDB(filePath string) ClientImplCloser
```

--------------------------------

### Get File Length

Source: https://pkg.go.dev/github.com/anacrolix/torrent

Returns the total size in bytes of the file.

```go
length := f.Length()
```

--------------------------------

### Get Listeners

Source: https://pkg.go.dev/github.com/anacrolix/torrent

Retrieves a slice of all active listeners managed by the client.

```go
listeners := cl.Listeners()
```

--------------------------------

### Get All Torrents

Source: https://pkg.go.dev/github.com/anacrolix/torrent

Retrieves a slice of all torrents currently managed by the client.

```go
torrents := cl.Torrents()
```

--------------------------------

### Get Piece Offset

Source: https://pkg.go.dev/github.com/anacrolix/torrent/metainfo

Returns the offset of the piece within the file.

```go
func (p Piece) Offset() int64
```

--------------------------------

### NewClient Function

Source: https://pkg.go.dev/github.com/anacrolix/torrent/tracker

Creates a new tracker client.

```go
func NewClient(urlStr string, opts NewClientOpts) (Client, error)
```

--------------------------------

### Create File Storage Client

Source: https://pkg.go.dev/github.com/anacrolix/torrent/storage

Initializes a new file storage client using the OS native filesystem. All torrent data is stored in the specified base directory. Returns a ClientImplCloser.

```go
func NewFile(baseDir string) ClientImplCloser
```

--------------------------------

### Table2.GetGte

Source: https://pkg.go.dev/github.com/anacrolix/torrent/internal/indexed

Gets the first record that is greater than or equal to the specified record.

```APIDOC
## Table2.GetGte

### Description
Gets the first record that is greater than or equal to the specified record. Hopes to avoid allocation for an iterator.

### Method
Not applicable (Go method)

### Endpoint
Not applicable (Go method)

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Request Example
None

### Response
#### Success Response (200)
- **ret** (g.Option[R]) - The first record greater than or equal to the specified record, if found.
```

--------------------------------

### Table.GetGte

Source: https://pkg.go.dev/github.com/anacrolix/torrent/internal/indexed

Gets the first record that is greater than or equal to the specified record.

```APIDOC
## Table.GetGte

### Description
Gets the first record that is greater than or equal to the specified record. Hopes to avoid allocation for an iterator.

### Method
Not applicable (Go method)

### Endpoint
Not applicable (Go method)

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Request Example
None

### Response
#### Success Response (200)
- **ret** (g.Option[R]) - The first record greater than or equal to the specified record, if found.
```

--------------------------------

### Create Resource Pieces Client

Source: https://pkg.go.dev/github.com/anacrolix/torrent/storage

Creates a new client for managing resource pieces. Accepts a PieceProvider.

```go
func NewResourcePieces(p PieceProvider) ClientImpl
```

--------------------------------

### File.State Method

Source: https://pkg.go.dev/github.com/anacrolix/torrent

Returns the download state of each piece that makes up this file.

```go
func (f *File) State() (ret []FilePieceState)
```

--------------------------------

### IterKeysFrom

Source: https://pkg.go.dev/github.com/anacrolix/torrent/internal/indexed

IterKeysFrom iterates over the keys in the table starting from a specified key.

```APIDOC
## IterKeysFrom

### Description
Iterates over the keys in the table starting from a specified key.

### Signature
```go
func (me *Table2[K, V]) IterKeysFrom(start K) iter.Seq[K]
```
```

--------------------------------

### NewFileOpts

Source: https://pkg.go.dev/github.com/anacrolix/torrent/storage

Creates a new file storage client using the OS native filesystem with custom options.

```APIDOC
## NewFileOpts

### Description
Creates a new file storage client using the OS native filesystem with custom options.

### Signature
```go
func NewFileOpts(opts NewFileClientOpts) ClientImplCloser
```

### Parameters
#### Path Parameters
- **opts** (NewFileClientOpts) - Options for configuring the file client.

### Returns
- **ClientImplCloser** - An implementation of the ClientImplCloser interface.
```

--------------------------------

### IterFrom

Source: https://pkg.go.dev/github.com/anacrolix/torrent/internal/indexed

IterFrom returns a sequence of records starting from the specified record.

```APIDOC
## IterFrom

### Description
Returns a sequence of records starting from the specified record.

### Signature
```go
func (me Table2) IterFrom(start R) iter.Seq[R]
```
```

--------------------------------

### FileInfo.BeginPieceIndex

Source: https://pkg.go.dev/github.com/anacrolix/torrent/metainfo

Calculates the starting piece index for a given file based on the piece length. This is essential for locating file data within the torrent.

```APIDOC
## func (*FileInfo) BeginPieceIndex

### Description
Calculates the starting piece index for a given file based on the piece length.

### Signature
```go
func (fi *FileInfo) BeginPieceIndex(pieceLength int64) int
```

### Parameters
* `pieceLength` (int64) - The piece length of the torrent.

### Returns
* `int` - The starting piece index for the file.
```

--------------------------------

### Get Client Connection Statistics

Source: https://pkg.go.dev/github.com/anacrolix/torrent

Returns aggregate connection statistics at the client level. Consider using Client.Stats() for more comprehensive statistics.

```go
func (cl *Client) ConnStats() ConnStats
```

--------------------------------

### NewMMapWithCompletion

Source: https://pkg.go.dev/github.com/anacrolix/torrent/storage

Initializes a new memory-mapped client with a specified base directory and completion tracker.

```APIDOC
## NewMMapWithCompletion

### Description
Initializes a new memory-mapped client with a specified base directory and completion tracker.

### Function Signature
```
func NewMMapWithCompletion(baseDir string, completion PieceCompletion) *mmapClientImpl
```

### Parameters
#### Path Parameters
- **baseDir** (string) - Description: The base directory for the memory-mapped storage.
- **completion** (PieceCompletion) - Description: The piece completion tracker to use.
```

--------------------------------

### NewClient

Source: https://pkg.go.dev/github.com/anacrolix/torrent/storage

Creates a new Client instance using the provided ClientImpl.

```APIDOC
## NewClient

### Description
Creates a new Client instance using the provided ClientImpl.

### Function Signature
```
func NewClient(cl ClientImpl) *Client
```

### Parameters
#### Path Parameters
- **cl** (ClientImpl) - Description: The ClientImpl to use for the new Client.
```

--------------------------------

### Get Torrent Handle

Source: https://pkg.go.dev/github.com/anacrolix/torrent

Returns a handle to a specific torrent by its info hash.

```go
func (cl *Client) Torrent(ih metainfo.Hash) (t *Torrent, ok bool)
```

--------------------------------

### Get Client Statistics

Source: https://pkg.go.dev/github.com/anacrolix/torrent

Retrieves comprehensive client statistics. Added in v1.51.0.

```go
func (cl *Client) Stats() ClientStats
```

--------------------------------

### Get Listening Addresses

Source: https://pkg.go.dev/github.com/anacrolix/torrent

Returns the network addresses the client is currently listening on.

```go
func (cl *Client) ListenAddrs() (ret []net.Addr)
```

--------------------------------

### File.SetPriority Method

Source: https://pkg.go.dev/github.com/anacrolix/torrent

Sets the minimum priority for all pieces that constitute this file. This influences download order.

```go
func (f *File) SetPriority(prio PiecePriority)
```

--------------------------------

### Get DHT Servers

Source: https://pkg.go.dev/github.com/anacrolix/torrent

Retrieves the list of DHT servers associated with the client.

```go
func (cl *Client) DhtServers() []DhtServer
```

--------------------------------

### Client DHT Configuration Structure

Source: https://pkg.go.dev/github.com/anacrolix/torrent

Defines configuration options for the Distributed Hash Table (DHT) used by the client. Allows disabling DHT, specifying starting nodes, configuring DHT servers, and setting query hooks.

```go
type ClientDhtConfig struct {
	// Don't create a DHT.
	// cfg.NoDHT aka cfg.DisableDHT
	NoDHT            bool `long:"disable-dht"`
	DhtStartingNodes func(network string) dht.StartingNodesGetter
	// Called for each anacrolix/dht Server created for the Client.
	ConfigureAnacrolixDhtServer       func(*dht.ServerConfig)
	PeriodicallyAnnounceTorrentsToDht bool
	// OnQuery hook func
	DHTOnQuery func(query *krpc.Msg, source net.Addr) (propagate bool)
}
```

--------------------------------

### FileTree.Walk Method

Source: https://pkg.go.dev/github.com/anacrolix/torrent/metainfo

Recursively walks through the FileTree, applying a function to each file and directory. The function receives the path and the FileTree node.

```go
func (ft *FileTree) Walk(path []string, f func(path []string, ft *FileTree))
```

--------------------------------

### File.Priority Method

Source: https://pkg.go.dev/github.com/anacrolix/torrent

Retrieves the current priority setting for the pieces belonging to this file.

```go
func (f *File) Priority() (prio PiecePriority)
```

--------------------------------

### Initialize PeerUploadOrder

Source: https://pkg.go.dev/github.com/anacrolix/torrent/analysis

Method to initialize a PeerUploadOrder instance.

```go
func (me *PeerUploadOrder) Init()
```

--------------------------------

### Get DHT Servers

Source: https://pkg.go.dev/github.com/anacrolix/torrent

Retrieves a slice of all DHT servers configured for the client.

```go
servers := cl.DhtServers()
```

--------------------------------

### Get Piece Offset

Source: https://pkg.go.dev/github.com/anacrolix/torrent/metainfo

Returns the offset of the piece within the torrent data.

```APIDOC
## Get Piece Offset

### Description
Returns the offset of the piece within the torrent data.

### Method
```go
func (p Piece) Offset() int64
```

### Returns
* **int64** - The offset of the piece.
```

--------------------------------

### NewDefaultClientConfig

Source: https://pkg.go.dev/github.com/anacrolix/torrent

Creates a new ClientConfig with default settings. This is the recommended way to initialize a configuration object.

```APIDOC
## NewDefaultClientConfig

### Description
Creates a new ClientConfig with default settings. This is the recommended way to initialize a configuration object.

### Method
func

### Endpoint
N/A

### Parameters
None

### Response
- **ClientConfig** (*ClientConfig) - A pointer to the newly created default client configuration.
```

--------------------------------

### Get Table2 Length

Source: https://pkg.go.dev/github.com/anacrolix/torrent/internal/indexed

Returns the number of records in the Table2. This operation is O(1).

```go
func (me Table2) Len() int
```

--------------------------------

### Client Announce Method

Source: https://pkg.go.dev/github.com/anacrolix/torrent/tracker/udp

Initiates an Announce request to a UDP tracker. Requires a context, AnnounceRequest, Options, and a function to determine IPv6 address usage.

```go
func (cl *Client) Announce(
	ctx context.Context, req AnnounceRequest, opts Options,

	ipv6 func(net.Addr) bool,
) (
	respHdr AnnounceResponseHeader,

```

--------------------------------

### Get Infohash as Byte Slice

Source: https://pkg.go.dev/github.com/anacrolix/torrent/types/infohash

Returns the byte slice representation of the Infohash.

```go
func (t T) Bytes() []byte
```

--------------------------------

### Client.NewClient

Source: https://pkg.go.dev/github.com/anacrolix/torrent

Creates a new Torrent client instance. This is the entry point for initializing the torrent client with a given configuration.

```APIDOC
## Client.NewClient

### Description
Creates a new Torrent client instance. This is the entry point for initializing the torrent client with a given configuration.

### Method
(Not specified, likely a constructor)

### Endpoint
(Not applicable)

### Parameters
#### Path Parameters
(None)

#### Query Parameters
(None)

#### Request Body
- **cfg** (*ClientConfig) - The configuration for the new client. Takes ownership of the ClientConfig.

### Request Example
(Not applicable)

### Response
#### Success Response
- **cl** (*Client) - A pointer to the newly created Client.
- **err** (error) - An error if the client creation failed.

#### Response Example
(Not specified)
```

--------------------------------

### AnnounceEvent Constants

Source: https://pkg.go.dev/github.com/anacrolix/torrent/tracker/shared

Defines constants for AnnounceEvent: None, Completed, Started, and Stopped.

```go
const (
	None      AnnounceEvent = iota
	Completed               // The local peer just completed the torrent.
	Started                 // The local peer has just resumed this torrent.
	Stopped                 // The local peer is leaving the swarm.
)
```

--------------------------------

### Options for NewFile Client

Source: https://pkg.go.dev/github.com/anacrolix/torrent/storage

Configuration options for creating a new file-based torrent client. Added in v1.31.0.

```go
type NewFileClientOpts struct {
	// The base directory for all downloads.
	ClientBaseDir   string
	FilePathMaker   FilePathMaker
	TorrentDirMaker TorrentDirFilePathMaker
	// If part files are enabled, this will default to inferring completion from file names at
	// startup, and keep the rest in memory.
	PieceCompletion PieceCompletion
	UsePartFiles    g.Option[bool]
	Logger          *slog.Logger
}
```

--------------------------------

### Get Info Hash

Source: https://pkg.go.dev/github.com/anacrolix/torrent

Returns the torrent's infohash, which uniquely identifies the torrent.

```go
func (t *Torrent) InfoHash() metainfo.Hash
```

--------------------------------

### Get WebRTC Peer Connection Stats

Source: https://pkg.go.dev/github.com/anacrolix/torrent

Retrieves statistics for WebRTC peer connections.

```go
func (t *Torrent) GetWebRtcPeerConnStats() map[string]webRtcStatsReports
```

--------------------------------

### Client Announce Method

Source: https://pkg.go.dev/github.com/anacrolix/torrent/tracker/http

Performs an announce request using the client.

```go
func (cl Client) Announce(ctx context.Context, ar AnnounceRequest, opt AnnounceOpt) (ret AnnounceResponse, err error)
```

--------------------------------

### NewClient Function

Source: https://pkg.go.dev/github.com/anacrolix/torrent/tracker/http

Creates a new HTTP tracker client with the given URL and options.

```go
func NewClient(url_ *url.URL, opts NewClientOpts) Client
```

--------------------------------

### Get Client Closed Event

Source: https://pkg.go.dev/github.com/anacrolix/torrent

Returns an events.Done channel that is closed when the client is shut down.

```go
func (cl *Client) Closed() events.Done
```

--------------------------------

### Get Bytes Completed for File

Source: https://pkg.go.dev/github.com/anacrolix/torrent

Returns the number of bytes that have been successfully downloaded for this file.

```go
n := f.BytesCompleted()
```

--------------------------------

### Create Storage Client from Squirrel Cache

Source: https://pkg.go.dev/github.com/anacrolix/torrent/storage/sqlite

Creates a storage.ClientImpl from a provided squirrel.Cache. The caller is responsible for closing the squirrel.Cache.

```go
func NewWrappingClient(cache *squirrel.Cache) storage.ClientImpl
```

--------------------------------

### Add Torrent from File

Source: https://pkg.go.dev/github.com/anacrolix/torrent

Adds a torrent to the client by reading its metainfo from a file.

```go
func (cl *Client) AddTorrentFromFile(filename string) (T *Torrent, err error)
```

--------------------------------

### Get Peer ID

Source: https://pkg.go.dev/github.com/anacrolix/torrent

Returns the unique Peer ID assigned to this client instance.

```go
id := cl.PeerID()
```

--------------------------------

### NewClientOpts Struct Definition

Source: https://pkg.go.dev/github.com/anacrolix/torrent/tracker

Defines options for creating a new tracker client.

```go
type NewClientOpts struct {
	Http trHttp.NewClientOpts
	// Overrides the network in the scheme. Probably a legacy thing.
	UdpNetwork   string
	Logger       log.Logger
	ListenPacket func(network, addr string) (net.PacketConn, error)
}
```

--------------------------------

### Get Local Port

Source: https://pkg.go.dev/github.com/anacrolix/torrent

Returns the local port number the client is primarily listening on.

```go
port := cl.LocalPort()
```

--------------------------------

### Get Connection Statistics

Source: https://pkg.go.dev/github.com/anacrolix/torrent

Retrieves statistics for all active network connections managed by the client.

```go
stats := cl.ConnStats()
```

--------------------------------

### Get Piece V1 Length

Source: https://pkg.go.dev/github.com/anacrolix/torrent/metainfo

Returns the v1 length of the piece. Added in v1.56.0.

```APIDOC
## Get Piece V1 Length

### Description
Returns the v1 length of the piece. Added in v1.56.0.

### Method
```go
func (p Piece) V1Length() int64
```

### Returns
* **int64** - The v1 length of the piece.
```

--------------------------------

### Create IPList from Reader

Source: https://pkg.go.dev/github.com/anacrolix/torrent/iplist

Creates an IPList by reading from an io.Reader, expecting data in a line-delimited P2P Plaintext file format.

```go
func NewFromReader(f io.Reader) (ret *IPList, err error)
```

--------------------------------

### Add Torrent from File

Source: https://pkg.go.dev/github.com/anacrolix/torrent

Adds a torrent to the client by specifying the path to its .torrent file. This is a convenient way to load torrents.

```go
T, err := cl.AddTorrentFromFile(filename)
```

--------------------------------

### Get Hash Info Bytes

Source: https://pkg.go.dev/github.com/anacrolix/torrent/metainfo

Calculates and returns the info hash bytes for the MetaInfo.

```APIDOC
## Get Hash Info Bytes

### Description
Calculates and returns the info hash bytes for the MetaInfo.

### Method
```go
func (mi *MetaInfo) HashInfoBytes() (infoHash Hash)
```

### Returns
* **infoHash** (Hash) - The computed info hash.
```

--------------------------------

### Get Map Length

Source: https://pkg.go.dev/github.com/anacrolix/torrent/internal/indexed

Returns the number of elements currently in the map. This operation is O(1).

```go
func (me Map) Len() int
```

--------------------------------

### Create New IPList

Source: https://pkg.go.dev/github.com/anacrolix/torrent/iplist

Creates a new IP list from a slice of Ranges. The input ranges must be pre-sorted by their lower bound IP. Overlapping ranges may lead to undefined behavior.

```go
func New(initSorted []Range) *IPList
```

--------------------------------

### File.Path Method

Source: https://pkg.go.dev/github.com/anacrolix/torrent

Returns the file's path, with directory components joined by '/'.

```go
func (f *File) Path() string
```

--------------------------------

### Table.IterFromWhile

Source: https://pkg.go.dev/github.com/anacrolix/torrent/internal/indexed

Returns an iterator that starts from a specified record and continues as long as a condition is met.

```APIDOC
## Table.IterFromWhile

### Description
Returns an iterator that starts from a specified record and continues as long as a condition is met.

### Method
Not applicable (Go method)

### Endpoint
Not applicable (Go method)

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Request Example
None

### Response
#### Success Response (200)
- **iter.Seq[R]** - An iterator sequence satisfying the conditions.
```

--------------------------------

### Create File Storage Client with Custom Path Maker and Completion (Deprecated)

Source: https://pkg.go.dev/github.com/anacrolix/torrent/storage

Deprecated: Allows specifying both a custom path maker and custom piece completion logic. Added in v1.27.0.

```go
func NewFileWithCustomPathMakerAndCompletion(
	baseDir string,
	pathMaker TorrentDirFilePathMaker,
	completion PieceCompletion,
) ClientImplCloser
```

--------------------------------

### FileInfo.DisplayPath Method

Source: https://pkg.go.dev/github.com/anacrolix/torrent/metainfo

Generates a displayable path for a file within the torrent. It uses the torrent's Info structure to construct the path.

```go
func (fi *FileInfo) DisplayPath(info *Info) string
```

--------------------------------

### Load MetaInfo from File

Source: https://pkg.go.dev/github.com/anacrolix/torrent/metainfo

Convenience function to load a MetaInfo object from a specified file path. Returns an error if the file cannot be read or parsed.

```go
func LoadFromFile(filename string) (*MetaInfo, error)
```

--------------------------------

### Get State of a Specific Piece

Source: https://pkg.go.dev/github.com/anacrolix/torrent

Retrieves the current state of a specific piece within the torrent.

```go
func (t *Torrent) PieceState(piece pieceIndex) (ps PieceState)
```

--------------------------------

### Get Number of Pieces

Source: https://pkg.go.dev/github.com/anacrolix/torrent

Returns the number of pieces in the torrent. Requires that the info has been obtained first.

```go
func (t *Torrent) NumPieces() pieceIndex
```

--------------------------------

### File.String Method

Source: https://pkg.go.dev/github.com/anacrolix/torrent

Returns a string representation of the File object.

```go
func (f *File) String() string
```

--------------------------------

### Client.StartNewRequest

Source: https://pkg.go.dev/github.com/anacrolix/torrent/webseed

Initiates a new webseed request for a given context and request specification. It returns a Request object that can be used to read the response body or cancel the request.

```APIDOC
## func (*Client) StartNewRequest

### Description
Starts a new webseed request for the given context and request specification. It returns a `Request` object which can be used to read the response body or cancel the request.

### Signature
```go
func (ws *Client) StartNewRequest(ctx context.Context, r RequestSpec, debugLogger *slog.Logger) Request
```
```

--------------------------------

### Create Direct Storage Client

Source: https://pkg.go.dev/github.com/anacrolix/torrent/storage/sqlite

A convenience function that creates a connection pool, resource provider, and a pieces storage ClientImpl and returns them all with a Close attached.

```go
func NewDirectStorage(opts NewDirectStorageOpts) (_ storage.ClientImplCloser, err error)
```

--------------------------------

### Greeting Test Torrent Structure

Source: https://pkg.go.dev/github.com/anacrolix/torrent/internal/testutil

Defines a sample Torrent structure named Greeting for testing purposes. It includes a single file with predefined content and name.

```go
var Greeting = Torrent{
	Files: []File{{ 
		Data: GreetingFileContents,
	}},
	Name: GreetingFileName,
}
```

--------------------------------

### Get Info Channel

Source: https://pkg.go.dev/github.com/anacrolix/torrent

Returns a channel that is closed when the torrent's info has become available.

```go
func (t *Torrent) GotInfo() events.Done
```

--------------------------------

### Set Default MetaInfo Values

Source: https://pkg.go.dev/github.com/anacrolix/torrent/metainfo

Sets sensible default values for a MetaInfo object, preparing it for creation.

```go
func (mi *MetaInfo) SetDefaults()
```

--------------------------------

### Get ICE Servers

Source: https://pkg.go.dev/github.com/anacrolix/torrent

Retrieves the list of ICE servers configured for the client. Added in v1.56.0.

```go
func (cl *Client) ICEServers() []webrtc.ICEServer
```

--------------------------------

### Initialize Timer

Source: https://pkg.go.dev/github.com/anacrolix/torrent/internal/mytimer

Initializes the timer with a first execution time and a callback function.

```go
func (me *Timer) Init(first TimeValue, f Func)
```

--------------------------------

### Download All Pieces

Source: https://pkg.go.dev/github.com/anacrolix/torrent

Marks the entire torrent for download. This requires the info to be available first.

```go
func (t *Torrent) DownloadAll()
```

--------------------------------

### Get Bad Peer IPs

Source: https://pkg.go.dev/github.com/anacrolix/torrent

Retrieves a list of IP addresses identified as bad peers.

```go
func (cl *Client) BadPeerIPs() (ips []string)
```

--------------------------------

### File.BeginPieceIndex Method

Source: https://pkg.go.dev/github.com/anacrolix/torrent

Returns the index of the first piece that contains data for this file.

```go
func (f *File) BeginPieceIndex() int
```

--------------------------------

### Get DHT Server Stats

Source: https://pkg.go.dev/github.com/anacrolix/torrent

Retrieves statistics from the DHT server. This method is part of the AnacrolixDhtServerWrapper.

```go
func (me AnacrolixDhtServerWrapper) Stats() interface{}
```

--------------------------------

### Get File End Piece Index

Source: https://pkg.go.dev/github.com/anacrolix/torrent

Returns the index of the last piece that belongs to this file.

```go
idx := f.EndPieceIndex()
```

--------------------------------

### Offer Struct

Source: https://pkg.go.dev/github.com/anacrolix/torrent/webtorrent

Represents a WebRTC offer, containing an offer ID and the session description.

```go
type Offer struct {
	OfferID string                    `json:"offer_id"`
	Offer   webrtc.SessionDescription `json:"offer"`
}
```

--------------------------------

### TestingConfig

Source: https://pkg.go.dev/github.com/anacrolix/torrent

Creates a ClientConfig suitable for testing environments. It accepts a testing.TB to integrate with Go's testing framework.

```APIDOC
## TestingConfig

### Description
Creates a ClientConfig suitable for testing environments. It accepts a testing.TB to integrate with Go's testing framework.

### Method
func

### Endpoint
N/A

### Parameters
- **t** (*testing.TB) - The testing interface to use.

### Response
- **ClientConfig** (*ClientConfig) - A pointer to the client configuration for testing.
```

--------------------------------

### Get Piece V1 Hash

Source: https://pkg.go.dev/github.com/anacrolix/torrent/metainfo

Returns the v1 hash of the piece, if available. Added in v1.56.0.

```APIDOC
## Get Piece V1 Hash

### Description
Returns the v1 hash of the piece, if available. Added in v1.56.0.

### Method
```go
func (p Piece) V1Hash() (ret g.Option[Hash])
```

### Returns
* **ret** (g.Option[Hash]) - An optional Hash value for the piece.
```

--------------------------------

### Client Methods

Source: https://pkg.go.dev/github.com/anacrolix/torrent

Provides methods for initializing and managing the torrent client, including adding torrents, configuring DHT, and retrieving statistics.

```APIDOC
## Client

### Description
Represents a torrent client with various configuration and management capabilities.

### Methods

#### func NewClient(cfg *ClientConfig) (cl *Client, err error)
Creates a new torrent client with the given configuration.

#### func (cl *Client) AddDhtNodes(nodes []string)
Adds a list of DHT nodes to the client's routing table.

#### func (cl *Client) AddDhtServer(d DhtServer)
Adds a DHT server to the client.

#### func (cl *Client) AddDialer(d Dialer)
Adds a custom dialer to the client for establishing peer connections.

#### func (cl *Client) AddListener(l Listener)
Adds a network listener to the client for accepting incoming connections.

#### func (cl *Client) AddMagnet(uri string) (T *Torrent, err error)
Adds a torrent to the client using a magnet URI.

#### func (cl *Client) AddTorrent(mi *metainfo.MetaInfo) (T *Torrent, err error)
Adds a torrent to the client from its metainfo.

#### func (cl *Client) AddTorrentFromFile(filename string) (T *Torrent, err error)
Adds a torrent to the client by reading its metainfo from a file.

#### func (cl *Client) AddTorrentInfoHash(infoHash metainfo.Hash) (t *Torrent, new bool)
Adds a torrent to the client using its info hash. Returns true if the torrent was new.

#### func (cl *Client) AddTorrentInfoHashWithStorage(infoHash metainfo.Hash, specStorage storage.ClientImpl) (t *Torrent, new bool)
Adds a torrent with a specific storage implementation.

#### func (cl *Client) AddTorrentOpt(opts AddTorrentOpts) (t *Torrent, new bool)
Adds a torrent with custom options.

#### func (cl *Client) AddTorrentSpec(spec *TorrentSpec) (t *Torrent, new bool, err error)
Adds a torrent using a TorrentSpec.

#### func (cl *Client) BadPeerIPs() (ips []string)
Returns a list of IP addresses of peers that have been marked as bad.

#### func (cl *Client) Close() (errs []error)
Closes the client and all its associated resources.

#### func (cl *Client) Closed() events.Done
Returns a channel that is closed when the client is shut down.

#### func (cl *Client) ConnStats() ConnStats
Returns statistics about active network connections.

#### func (cl *Client) DhtServers() []DhtServer
Returns the list of DHT servers managed by the client.

#### func (cl *Client) ICEServers() []webrtc.ICEServer
Returns the list of ICE servers configured for WebRTC.

#### func (cl *Client) ListenAddrs() (ret []net.Addr)
Returns the network addresses the client is listening on.

#### func (cl *Client) Listeners() []Listener
Returns the list of network listeners used by the client.

#### func (cl *Client) LocalPort() (port int)
Returns the local port the client is listening on.

#### func (cl *Client) NewAnacrolixDhtServer(conn net.PacketConn) (s *dht.Server, err error)
Creates a new DHT server using the provided network connection.

#### func (cl *Client) PeerID() PeerID
Returns the client's peer ID.

#### func (cl *Client) PublicIPs() (ips []net.IP)
Returns the client's public IP addresses.

#### func (cl *Client) Stats() ClientStats
Returns overall client statistics.

#### func (cl *Client) String() string
Returns a string representation of the client.

#### func (cl *Client) Torrent(ih metainfo.Hash) (t *Torrent, ok bool)
Retrieves a torrent by its info hash.

#### func (cl *Client) Torrents() []*Torrent
Returns a list of all torrents managed by the client.

#### func (cl *Client) WaitAll() bool
Blocks until all torrents have completed downloading.

#### func (cl *Client) WriteStatus(_w io.Writer)
Writes the client's status to the given writer.
```

--------------------------------

### Get Piece V1 Length

Source: https://pkg.go.dev/github.com/anacrolix/torrent/metainfo

Returns the v1 length of the piece in bytes. Added in v1.56.0.

```go
func (p Piece) V1Length() int64
```

--------------------------------

### Create TorrentSpec from MetaInfo

Source: https://pkg.go.dev/github.com/anacrolix/torrent

Constructs a TorrentSpec from a metainfo.MetaInfo object. Panics if essential information is missing from the metainfo.

```go
func TorrentSpecFromMetaInfo(mi *metainfo.MetaInfo) *TorrentSpec
```

--------------------------------

### Get Piece V1 Hash

Source: https://pkg.go.dev/github.com/anacrolix/torrent/metainfo

Returns the v1 hash of the piece, if available. Added in v1.56.0.

```go
func (p Piece) V1Hash() (ret g.Option[Hash])
```

--------------------------------

### Table Len Function Signature

Source: https://pkg.go.dev/github.com/anacrolix/torrent/internal/indexed

Signature for getting the number of records in a Table. This is an O(1) operation.

```go
func (me *Table) Len() int
```

--------------------------------

### NewMMap

Source: https://pkg.go.dev/github.com/anacrolix/torrent/storage

Creates a new memory-mapped file storage client.

```APIDOC
## NewMMap

### Description
Creates a new memory-mapped file storage client.

### Signature
```go
func NewMMap(baseDir string) ClientImplCloser
```

### Parameters
#### Path Parameters
- **baseDir** (string) - The base directory for storing torrent data.

### Returns
- **ClientImplCloser** - An implementation of the ClientImplCloser interface.
```

--------------------------------

### Root TorrentFS Method Signature

Source: https://pkg.go.dev/github.com/anacrolix/torrent/fs

Provides the method signature for getting the root node of the TorrentFS.

```go
func (tfs *TorrentFS) Root() (fusefs.Node, error)
```

--------------------------------

### ReadaheadContext Struct Definition

Source: https://pkg.go.dev/github.com/anacrolix/torrent

Context for readahead operations, including the start position and current position.

```go
type ReadaheadContext struct {
	ContiguousReadStartPos int64
	CurrentPos             int64
}
```

--------------------------------

### FileInfo.BestPath Method

Source: https://pkg.go.dev/github.com/anacrolix/torrent/metainfo

Returns the most suitable path for a file. This method considers different path representations and selects the best one available.

```go
func (fi *FileInfo) BestPath() []string
```
Tokens:
Raw