Struct machinebox::tagbox::Tagbox

pub struct Tagbox { /* fields omitted */ }

The client for the tagbox machine box.

Methods

impl Tagbox

pub fn new(url: &str) -> Tagbox

Creates a new tagbox client connecting to the supplied URL.

pub fn check<T: Read + Send + 'static>(
    &self,
    reader: T
) -> Result<CheckResponse, Error>

Gets the tags for the image to which reader points

pub fn check_path(&self, source_path: &str) -> Result<CheckResponse, Error>

Gets the tags for the image at source_path

pub fn check_base64(&self, data: &str) -> Result<CheckResponse, Error>

Gets the tags for the image contained in the base64 encoded data

pub fn check_url(&self, image_url: &str) -> Result<CheckResponse, Error>

Gets the tags for the image at the given URL

pub fn teach_url(
    &self,
    image_url: &str,
    tag: &str,
    id: Option<String>
) -> Result<(), Error>

Teaches the tagbox the image with a custom tag at the specified URL

pub fn remove_custom_tag(&self, id: &str) -> Result<(), Error>

Deletes a custom tag by its ID

pub fn rename_custom_tag(&self, id: &str, tag: &str) -> Result<(), Error>

Renames a custom tag with the indicated ID

pub fn similar_file(&self, source_path: &str) -> Result<Vec<Tag>, Error>

Checks the image file at source_path for similar images based on previously taught tags

pub fn similar_url(&self, image_url: &str) -> Result<Vec<Tag>, Error>

Checks the image at the image_url for similar images based on previously taught tags.

pub fn similar_base64(&self, data: &str) -> Result<Vec<Tag>, Error>

Checks the image within the base64 encoded string for similar images based on previously taught tags.

pub fn download_state<W>(&self, buf: &mut W) -> Result<u64, Error> where
    W: Write, 

Downloads the state of the tagbox into the buf buffer, returning the number of bytes written

pub fn post_state(&self, source_path: &str) -> Result<(), Error>

Submits the state file indicated by the source_path parameter to the tagbox

pub fn post_state_url(&self, state_url: &str) -> Result<(), Error>

Submits a state URL to the tagbox

Trait Implementations

impl BoxClient for Tagbox

fn url(&self) -> &str

Indicates the URL of the box

fn info(&self) -> Result<BoxInfo, Error>

Provides information about the box

fn health(&self) -> Result<Health, Error>

Checks the health of the box

fn is_live(&self) -> Result<bool, Error>

Determines whether the box is live

fn is_ready(&self) -> Result<bool, Error>

Determines if the box is ready. Some boxes may take a while to start up, so you can use this function to check if it is acceptable to start using the box-specific functionality