[][src]Crate google_safebrowsing4

This documentation was generated from safebrowsing crate version 1.0.10+20190702, where 20190702 is the exact revision of the safebrowsing:v4 schema built by the mako code generator v1.0.10.

Everything else about the safebrowsing v4 API can be found at the official documentation site. The original source code is on github.


Handle the following Resources with ease from the central hub ...

Not what you are looking for ? Find all other Google APIs in their Rust documentation index.

Structure of this Library

The API is structured into the following primary items:

  • Hub
    • a central object to maintain state and allow accessing all Activities
    • creates Method Builders which in turn allow access to individual Call Builders
  • Resources
    • primary types that you can apply Activities to
    • a collection of properties and Parts
    • Parts
      • a collection of properties
      • never directly used in Activities
  • Activities
    • operations to apply to Resources

All structures are marked with applicable traits to further categorize them and ease browsing.

Generally speaking, you can invoke Activities like this:

let r = hub.resource().activity(...).doit()

Or specifically ...

This example is not tested
let r = hub.full_hashes().find(...).doit()
let r = hub.encoded_full_hashes().get(...).doit()

The resource() and activity(...) calls create builders. The second one dealing with Activities supports various methods to configure the impending operation (not shown here). It is made such that all required arguments have to be specified right away (i.e. (...)), whereas all optional ones can be build up as desired. The doit() method performs the actual communication with the server and returns the respective result.


Setting up your Project

To use this library, you would put the following lines into your Cargo.toml file:

google-safebrowsing4 = "*"
# This project intentionally uses an old version of Hyper. See
# https://github.com/Byron/google-apis-rs/issues/173 for more
# information.
hyper = "^0.10"
hyper-rustls = "^0.6"
serde = "^1.0"
serde_json = "^1.0"
yup-oauth2 = "^1.0"

A complete example

extern crate hyper;
extern crate hyper_rustls;
extern crate yup_oauth2 as oauth2;
extern crate google_safebrowsing4 as safebrowsing4;
use safebrowsing4::{Result, Error};
use std::default::Default;
use oauth2::{Authenticator, DefaultAuthenticatorDelegate, ApplicationSecret, MemoryStorage};
use safebrowsing4::Safebrowsing;
// Get an ApplicationSecret instance by some means. It contains the `client_id` and 
// `client_secret`, among other things.
let secret: ApplicationSecret = Default::default();
// Instantiate the authenticator. It will choose a suitable authentication flow for you, 
// unless you replace  `None` with the desired Flow.
// Provide your own `AuthenticatorDelegate` to adjust the way it operates and get feedback about 
// what's going on. You probably want to bring in your own `TokenStorage` to persist tokens and
// retrieve them from storage.
let auth = Authenticator::new(&secret, DefaultAuthenticatorDelegate,
                              <MemoryStorage as Default>::default(), None);
let mut hub = Safebrowsing::new(hyper::Client::with_connector(hyper::net::HttpsConnector::new(hyper_rustls::TlsClient::new())), auth);
// You can configure optional parameters by calling the respective setters at will, and
// execute the final call using `doit()`.
// Values shown here are possibly random and not representative !
let result = hub.encoded_full_hashes().get("encodedRequest")
match result {
    Err(e) => match e {
        // The Error enum provides details about what exactly happened.
        // You can also just use its `Debug`, `Display` or `Error` traits
        |Error::UploadSizeLimitExceeded(_, _)
        |Error::JsonDecodeError(_, _) => println!("{}", e),
    Ok(res) => println!("Success: {:?}", res),

Handling Errors

All errors produced by the system are provided either as Result enumeration as return value of the doit() methods, or handed as possibly intermediate results to either the Hub Delegate, or the Authenticator Delegate.

When delegates handle errors or intermediate values, they may have a chance to instruct the system to retry. This makes the system potentially resilient to all kinds of errors.

Uploads and Downloads

If a method supports downloads, the response body, which is part of the Result, should be read by you to obtain the media. If such a method also supports a Response Result, it will return that by default. You can see it as meta-data for the actual media. To trigger a media download, you will have to set up the builder by making this call: .param("alt", "media").

Methods supporting uploads can do so using up to 2 different protocols: simple and resumable. The distinctiveness of each is represented by customized doit(...) methods, which are then named upload(...) and upload_resumable(...) respectively.

Customization and Callbacks

You may alter the way an doit() method is called by providing a delegate to the Method Builder before making the final doit() call. Respective methods will be called to provide progress information, as well as determine whether the system should retry on failure.

The delegate trait is default-implemented, allowing you to customize it with minimal effort.

Optional Parts in Server-Requests

All structures provided by this library are made to be enocodable and decodable via json. Optionals are used to indicate that partial requests are responses are valid. Most optionals are are considered Parts which are identifiable by name, which will be sent to the server to indicate either the set parts of the request or the desired parts in the response.

Builder Arguments

Using method builders, you are able to prepare an action call by repeatedly calling it's methods. These will always take a single argument, for which the following statements are true.

Arguments will always be copied or cloned into the builder, to make them independent of their original life times.



The expected state of a client's local database.


The client metadata associated with Safe Browsing API requests.


The constraints for this update.


Implements the Content-Range header, for serialization only


A delegate with a conservative default implementation, which is used if no other delegate is set.


A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance:


A builder for the get method supported by a encodedFullHashe resource. It is not used directly, but through a EncodedFullHasheMethods instance.


A builder providing access to all methods supported on encodedFullHashe resources. It is not used directly, but through the Safebrowsing hub.


A builder for the get method supported by a encodedUpdate resource. It is not used directly, but through a EncodedUpdateMethods instance.


A builder providing access to all methods supported on encodedUpdate resources. It is not used directly, but through the Safebrowsing hub.


A utility to represent detailed errors we might see in case there are BadRequests. The latter happen if the sent parameters or request structures are unsound


Describes a Safe Browsing API update request. Clients can request updates for multiple lists in a single request. NOTE: Field index 2 is unused. NEXT: 5


There is no detailed description.


Request to return full hashes matched by the provided hash prefixes.


There is no detailed description.


Request to check entries against lists.


There is no detailed description.


Finds the full hashes that match the requested hash prefixes.


A builder providing access to all methods supported on fullHashe resources. It is not used directly, but through the Safebrowsing hub.


A utility type which can decode a server response that indicates error


There is no detailed description.


A single list update request.


An update to an individual list.


A single metadata entry.


Contains information about an API request.


Provides a Read interface that converts multiple parts into the protocol identified by RFC2387. Note: This implementation is just as rich as it needs to be to perform uploads to google APIs, and might not be a fully-featured implementation.


The uncompressed threat entries in hash format of a particular prefix length. Hashes can be anywhere from 4 to 32 bytes in size. A large majority are 4 bytes, but some hashes are lengthened if they collide with the hash of a popular URL.


A set of raw indices to remove from a local list.


A utility type to perform a resumable upload from start to end.


The Rice-Golomb encoded data. Used for sending compressed 4-byte hashes or compressed removal indices.


Central instance to access all Safebrowsing related resource activities


An individual threat; for example, a malicious URL or its hash representation. Only one of these fields should be set.


The metadata associated with a specific threat entry. The client is expected to know the metadata key/value pairs associated with each threat type.


A set of threats that should be added or removed from a client's local database.


There is no detailed description.


Reports a Safe Browsing threat list hit to Google. Only projects with TRUSTED_REPORTER visibility can use this method.


A builder providing access to all methods supported on threatHit resources. It is not used directly, but through the Safebrowsing hub.


The information regarding one or more threats that a client submits when checking for matches in threat lists.


Describes an individual threat list. A list is defined by three parameters: the type of threat posed, the type of platform targeted by the threat, and the type of entries in the list.


Lists the Safe Browsing threat lists available for download.


A builder providing access to all methods supported on threatList resources. It is not used directly, but through the Safebrowsing hub.


Fetches the most recent threat list updates. A client can request updates for multiple lists at once.


A builder providing access to all methods supported on threatListUpdate resources. It is not used directly, but through the Safebrowsing hub.


A match when checking a threat entry in the Safe Browsing threat lists.


Finds the threat entries that match the Safe Browsing lists.


A builder providing access to all methods supported on threatMatche resources. It is not used directly, but through the Safebrowsing hub.


A single resource related to a threat hit.


Details about the user that encountered the threat.


The X-Upload-Content-Type header.





Identifies types which represent builders for a particular resource method


A trait specifying functionality to help controlling any request performed by the API. The trait has a conservative default implementation.


Identifies the Hub. There is only one per library, this trait is supposed to make intended use more explicit. The hub allows to access all resource methods more easily.


Identifies types for building methods of a particular resource type


Identifies types which are only used by other types internally. They have no special meaning, this trait just marks them for completeness.


Identifies types which are only used as part of other types, which usually are carrying the Resource trait.


A utility to specify reader types which provide seeking capabilities too


Identifies types which are used in API requests.


Identifies types which can be inserted and deleted. Types with this trait are most commonly used by clients of this API.


Identifies types which are used in API responses.


A trait for all types that can convert themselves into a parts string


Identifies types which are not actually used by the API This might be a bug within the google API schema.



Type Definitions


A universal result type used as return for all calls.