webtor

package module

Go to main page

Versions in this module

v0

v0.4.0

Aug 12, 2026

Changes in this version

type LibraryListOptions

+ Watched LibraryWatched

type LibraryListResponse

+ Watched string

type LibrarySort

+ const LibrarySortRating

+ type LibraryWatched string

+ const LibraryWatchedAll

+ const LibraryWatchedUnwatched

+ const LibraryWatchedWatched

v0.3.0

Aug 12, 2026

Changes in this version

type LibrarySort

+ const LibrarySortYear

v0.2.0

Aug 10, 2026

Changes in this version

+ const CodeAuthorizationPending

+ const CodeBadRequest

+ const CodeConflict

+ const CodeExpiredToken

+ const CodeForbidden

+ const CodeInternal

+ const CodeMethodNotAllowed

+ const CodeNotFound

+ const CodePaymentRequired

+ const CodeRateLimited

+ const CodeSlowDown

+ const CodeUnauthorized

+ const CodeUnavailable

+ const CodeUpstream

+ const CodeUpstreamTimeout

+ const DefaultListLimit

+ const DefaultRapidAPIBaseURL

+ const DefaultWebUIBaseURL

+ const MaxTorrentSize

+ const PledgeStatusExpired

+ const PledgeStatusFailed

+ const PledgeStatusQueued

+ const PledgeStatusStoring

+ const PledgeStatusVaulted

+ const PledgeStatusWaiting

+ const Version

+ var ErrDeviceAuthExpired = errors.New("webtor: device authorization expired, start over")

+ func IsConflict(err error) bool

+ func IsForbidden(err error) bool

+ func IsNotFound(err error) bool

+ func IsPaymentRequired(err error) bool

+ func IsRateLimited(err error) bool

+ func IsUnauthorized(err error) bool

+ type ArchiveFormat string

+ const ArchiveFormatTar

+ const ArchiveFormatZip

+ type Backend interface

+ Authorize func(req *http.Request)

+ BaseURL func() *url.URL

+ Capabilities func() Capabilities

+ Kind func() BackendKind

+ func Direct(baseURL string, opts ...DirectOption) (Backend, error)

+ func RapidAPI(key string, opts ...RapidAPIOption) (Backend, error)

+ func WebUI(apiKey string, opts ...WebUIOption) (Backend, error)

+ type BackendKind string

+ const KindDirect

+ const KindRapidAPI

+ const KindWebUI

+ type Capabilities uint32

+ const CapDeviceFlow

+ const CapLibrary

+ const CapProfile

+ const CapVault

+ func (c Capabilities) String() string

+ type CapabilityError struct

+ Backend BackendKind

+ Capability Capabilities

+ func (e *CapabilityError) Error() string

+ type Client struct

+ func New(b Backend, opts ...Option) (*Client, error)

+ func (c *Client) AddResource(ctx context.Context, src ResourceSource) (*ResourceResponse, error)

+ func (c *Client) Backend() Backend

+ func (c *Client) Export(ctx context.Context, resourceID, contentID string, o ExportOptions) (*ExportResponse, error)

+ func (c *Client) LibraryAdd(ctx context.Context, resourceID string) (*LibraryItem, error)

+ func (c *Client) LibraryGet(ctx context.Context, resourceID string) (*LibraryItem, error)

+ func (c *Client) LibraryList(ctx context.Context, o LibraryListOptions) (*LibraryListResponse, error)

+ func (c *Client) LibraryRemove(ctx context.Context, resourceID string) error

+ func (c *Client) LibraryRename(ctx context.Context, resourceID, name string) (*LibraryItem, error)

+ func (c *Client) List(ctx context.Context, resourceID string, o ListOptions) (*ListResponse, error)

+ func (c *Client) ListAll(ctx context.Context, resourceID string, o ListOptions) func(yield func(ListItem, error) bool)

+ func (c *Client) OpenArchive(ctx context.Context, resourceID, contentID string, format ArchiveFormat, ...) (io.ReadCloser, string, error)

+ func (c *Client) OpenDownload(ctx context.Context, resourceID, contentID string, opts ...DownloadOption) (*Download, error)

+ func (c *Client) Profile(ctx context.Context) (*ProfileResponse, error)

+ func (c *Client) Resource(ctx context.Context, resourceID string) (*ResourceResponse, error)

+ func (c *Client) StartDeviceAuth(ctx context.Context, deviceName string) (*DeviceAuth, error)

+ func (c *Client) Supports(caps Capabilities) bool

+ func (c *Client) TorrentFile(ctx context.Context, resourceID string) ([]byte, error)

+ func (c *Client) UpdateProfile(ctx context.Context, u ProfileUpdate) (*ProfileResponse, error)

+ func (c *Client) Vault(ctx context.Context) (*VaultResponse, error)

+ func (c *Client) VaultPledge(ctx context.Context, resourceID string) (*Pledge, error)

+ func (c *Client) VaultPledgeStatus(ctx context.Context, resourceID string) (*PledgeStatusResponse, error)

+ func (c *Client) VaultUnpledge(ctx context.Context, resourceID string) error

+ func (c *Client) WaitDeviceToken(ctx context.Context, da *DeviceAuth, onTick func()) (string, error)

+ type DeviceAuth struct

+ ExpiresAt time.Time

+ UserCode string

+ VerificationURI string

+ VerificationURIComplete string

+ type DeviceCodeResponse struct

+ DeviceCode string

+ ExpiresIn int

+ Interval int

+ UserCode string

+ VerificationURI string

+ VerificationURIComplete string

+ type DeviceTokenResponse struct

+ Key string

+ type DirectOption func(*directConfig)

+ func WithDirectAPIKey(k string) DirectOption

+ func WithDirectToken(t string) DirectOption

+ type Download struct

+ Name string

+ Size int64

+ func (d *Download) BytesRead() int64

+ func (d *Download) Close() error

+ func (d *Download) Read(p []byte) (int, error)

+ type DownloadOption func(*downloadConfig)

+ func WithOffset(n int64) DownloadOption

+ type Error struct

+ Code string

+ HTTPStatus int

+ Message string

+ RetryAfter time.Duration

+ func (e *Error) Error() string

+ type ExportItem struct

+ Meta *ExportMeta

+ Tag *ExportTag

+ URL string

+ type ExportMeta struct

+ Cache bool

+ Multibitrate bool

+ Transcode bool

+ TranscodeCache bool

+ type ExportOptions struct

+ ArchiveFormat string

+ IMDBID string

+ Paths []string

+ Types []ExportType

+ type ExportResponse struct

+ Exports map[ExportType]ExportItem

+ Source ListItem

+ func (r *ExportResponse) Cached() bool

+ func (r *ExportResponse) DownloadURL() (string, bool)

+ func (r *ExportResponse) StreamURL() (string, bool)

+ type ExportSource struct

+ Src string

+ Type string

+ type ExportTag struct

+ Alt string

+ Name string

+ Poster string

+ Preload string

+ Sources []ExportSource

+ Src string

+ Tracks []ExportTrack

+ type ExportTrack struct

+ Kind string

+ Label string

+ Src string

+ SrcLang string

+ type ExportType string

+ const ExportTypeDownload

+ const ExportTypeMediaProbe

+ const ExportTypeStream

+ const ExportTypeSubtitles

+ const ExportTypeTorrentClientStat

+ type LibraryItem struct

+ AddedAt time.Time

+ FilesCount int

+ Name string

+ ResourceID string

+ Size int64

+ type LibraryListOptions struct

+ Limit int

+ Offset int

+ Sort LibrarySort

+ Type LibraryType

+ type LibraryListResponse struct

+ Count int

+ Items []LibraryItem

+ Limit int

+ Offset int

+ Sort string

+ Type string

+ type LibrarySort string

+ const LibrarySortName

+ const LibrarySortRecent

+ type LibraryType string

+ const LibraryTypeAll

+ const LibraryTypeMovies

+ const LibraryTypeSeries

+ type ListItem struct

+ Ext string

+ ID string

+ Index int

+ MediaFormat MediaFormat

+ MimeType string

+ Name string

+ Path string

+ Size int64

+ Type ListType

+ type ListOptions struct

+ Limit int

+ Offset int

+ Output ListOutput

+ Path string

+ Sort ListSort

+ type ListOutput string

+ const ListOutputFlat

+ const ListOutputTree

+ type ListResponse struct

+ Count int

+ Items []ListItem

+ type ListSort string

+ const ListSortName

+ const ListSortSize

+ type ListType string

+ const ListTypeDirectory

+ const ListTypeFile

+ type MediaFormat string

+ const MediaFormatAudio

+ const MediaFormatImage

+ const MediaFormatSubtitle

+ const MediaFormatVideo

+ type Option func(*Client)

+ func WithHTTPClient(h *http.Client) Option

+ func WithLogger(l *slog.Logger) Option

+ func WithRetry(p RetryPolicy) Option

+ func WithUserAgent(ua string) Option

+ type Pledge struct

+ Amount float64

+ CreatedAt time.Time

+ Expired bool

+ Frozen bool

+ Funded bool

+ FundedVP float64

+ Name string

+ PledgeID string

+ RequiredVP float64

+ ResourceID string

+ Vaulted bool

+ type PledgeStatusResponse struct

+ Progress *float64

+ Status string

+ StoredSize *int64

+ TotalSize *int64

+ type ProfileResponse struct

+ Email string

+ Scopes []string

+ Settings ProfileSettings

+ Tier ProfileTier

+ UserID string

+ type ProfileSettings struct

+ ShowAdult bool

+ type ProfileTier struct

+ ID uint32

+ Name string

+ type ProfileUpdate struct

+ ShowAdult *bool

+ type RapidAPIOption func(*rapidAPIConfig)

+ func WithRapidAPIBaseURL(u string) RapidAPIOption

+ type ResourceResponse struct

+ File *ListItem

+ FilesCount int

+ ID string

+ MagnetURI string

+ MultiFile bool

+ Name string

+ Size int64

+ type ResourceSource struct

+ func Magnet(uri string) ResourceSource

+ func TorrentBytes(b []byte) ResourceSource

+ func TorrentReader(r io.Reader) ResourceSource

+ type RetryPolicy struct

+ BaseWait time.Duration

+ MaxAttempts int

+ MaxWait time.Duration

+ func DefaultRetryPolicy() RetryPolicy

+ type VaultContent struct

+ Expiring int

+ Loading int

+ Vaulted int

+ type VaultPoints struct

+ Available *float64

+ Claimable float64

+ Frozen float64

+ Funded float64

+ Total *float64

+ type VaultResponse struct

+ Content VaultContent

+ Pledges []Pledge

+ Points VaultPoints

+ type WebUIOption func(*webUIConfig)

+ func WithWebUIBaseURL(u string) WebUIOption

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL