Categorygithub.com/asimpleidea/salsa
modulepackage
0.3.0
Repository: https://github.com/asimpleidea/salsa.git
Documentation: pkg.go.dev

# README

salsa

A modern and powerful client for Saucenao written in go.

# Packages

Package indexes contains definitions of the indexes to be used with Saucenao.
Package sauces contains definitions for the source of an image found by Saucenao.

# Functions

NewSauceClient returns an instance for the Client.
WithHTTPClient sets a custom HTTP Client instead of the new one.
WithIndex modifies the index to look for.
WithMinimumSimilarity tells Saucenao to filter results that have a similarity lower than the one provided.
WithResultsNumber sets the maximum number of the results.
WithSafetyLevel sets the safety level for this request.
WithTestMode sets test mode to true.

# Constants

AnonymousAccount defines that the user is not logged.
HideExpectedAndSuspectedExplicit is exactly like HideExpectedExplicit but it also hides results that are suspected to be explicit.
HideExpectedExplicit tells Saucenao to hide results that are expected to be explicit.
NormalAccount specifies that the user is logged.
PremiumAccount specifies that the user is logged and has a premium subscription.
Safest only shows safe results.
ShowAll specifies the all results should be returned.
Unknown account type.

# Variables

ErrClientSide is returned when the request for source was successfully sent but could not complete because of an error on user's request.
ErrIteratorFinished specifies that the iterator arrived at the end of its internal list and thus could not retrieve any more results.
ErrOptions represents an error that occurs when the options provided by the user contains invalid values.
ErrServerSide is returned when the request for source was successfully sent but could not complete because of a server side error.
ErrUknownIndex is returned when the provided or returned index is not known or supported.

# Structs

RequestOptions contains options to include with the request.
Response is the response sent by Saucenao and parsed and cleaned by salsa.
ResultsIterator is an iterator with all the results returned by Saucenao.
SauceClient is an implementation of the Client interface for connecting to Saucenao and query for source to a picture.

# Interfaces

Client is an interface for communicating with Saucenao and querying for source for a local or remote image .

# Type aliases

AccountType defines the type of the account of the Saucenao user making the request.
RequestOption adds an option to the request.
SafetyLevel is the level of the.