Struct Sauce

pub struct Sauce {
    pub ext_urls: Vec<String>,
    pub title: Option<String>,
    pub site: String,
    pub index: u32,
    pub index_id: u32,
    pub similarity: f32,
    pub thumbnail: String,
    pub additional_fields: Option<Value>,
}

A Sauce struct contains one result from a API call made by the Handler.

Example

use rustnao::{Sauce, HandlerBuilder};
let mut handle = HandlerBuilder::default().api_key("your_api_key").build();
let result : rustnao::Result<Vec<Sauce>> = handle.get_sauce("https://i.pximg.net/img-master/img/2019/02/10/03/11/39/73095123_p0_master1200.jpg", None, None);

Fields

ext_urls: Vec<String>

A Vec of Strings representing the external URLs for the image

title: Option<String>

An optional String to represent the title of the image

site: String

A string to represent the site the image is from

index: u32

The official index on SauceNAO for the index the site corresponds to

index_id: u32

The index returned by the SauceNAO API. Usually this is equal to the index but sometimes it is different (see Sankaku, for example)

similarity: f32

The similarity the image has with the guess

thumbnail: String

A string representing the URL of the thumbnail

additional_fields: Option<Value>

Any additional fields that are specific to the source

Implementations

impl Sauce

pub fn has_empty_url(&self) -> bool

Returns whether the Sauce struct contains an empty ext_url field.

Example

use rustnao::{HandlerBuilder, Sauce};
let file = "https://i.imgur.com/W42kkKS.jpg";
   let mut handle = HandlerBuilder::default().api_key("your_api_key").build();
   handle.set_min_similarity(45);
   let result = handle.get_sauce(file, None, None);
   if result.is_ok() {
       let res : Vec<Sauce> = result.unwrap().into_iter().filter(|sauce| sauce.has_empty_url()).collect();
       for i in res {
           println!("{:?}", i);
       }
   }
   else {
       println!("Failed to make a query.");
   }

Examples found in repository

examples/filter.rs (line 19)

fn main() {
    let data = std::fs::read_to_string("config.json").expect("Couldn't read file.");
    let json: serde_json::Value =
        serde_json::from_str(data.as_str()).expect("JSON not well formatted.");
    let api_key = json["api_key"].as_str();
    let file = "https://i.imgur.com/W42kkKS.jpg";

    if let Some(key) = api_key {
        let handle = HandlerBuilder::default().api_key(key).build();
        handle.set_min_similarity(61.31);
        let result: Vec<Sauce> = handle
            .get_sauce(file, None, None)
            .unwrap()
            .into_iter()
            .filter(|sauce| !sauce.has_empty_url())
            .collect(); // Remove empty results
        for i in result {
            println!("{:?}", i);
        }
    }
}

Trait Implementations

impl Debug for Sauce

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Serialize for Sauce

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.