Struct google_books1::api::VolumeListCall
source · [−]pub struct VolumeListCall<'a> { /* private fields */ }
Expand description
Performs a book search.
A builder for the list method supported by a volume resource.
It is not used directly, but through a VolumeMethods
instance.
Example
Instantiate a resource method builder
// 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.volumes().list("q")
.start_index(75)
.source("rebum.")
.show_preorders(false)
.projection("dolores")
.print_type("sed")
.partner("invidunt")
.order_by("clita")
.max_results(2)
.max_allowed_maturity_rating("aliquyam")
.library_restrict("magna")
.lang_restrict("diam")
.filter("nonumy")
.download("et")
.doit().await;
Implementations
sourceimpl<'a> VolumeListCall<'a>
impl<'a> VolumeListCall<'a>
sourcepub async fn doit(self) -> Result<(Response<Body>, Volumes)>
pub async fn doit(self) -> Result<(Response<Body>, Volumes)>
Perform the operation you have build so far.
sourcepub fn q(self, new_value: &str) -> VolumeListCall<'a>
pub fn q(self, new_value: &str) -> VolumeListCall<'a>
Full-text search query string.
Sets the q query property to the given value.
Even though the property as already been set when instantiating this call, we provide this method for API completeness.
sourcepub fn start_index(self, new_value: u32) -> VolumeListCall<'a>
pub fn start_index(self, new_value: u32) -> VolumeListCall<'a>
Index of the first result to return (starts at 0)
Sets the start index query property to the given value.
sourcepub fn source(self, new_value: &str) -> VolumeListCall<'a>
pub fn source(self, new_value: &str) -> VolumeListCall<'a>
String to identify the originator of this request.
Sets the source query property to the given value.
sourcepub fn show_preorders(self, new_value: bool) -> VolumeListCall<'a>
pub fn show_preorders(self, new_value: bool) -> VolumeListCall<'a>
Set to true to show books available for preorder. Defaults to false.
Sets the show preorders query property to the given value.
sourcepub fn projection(self, new_value: &str) -> VolumeListCall<'a>
pub fn projection(self, new_value: &str) -> VolumeListCall<'a>
Restrict information returned to a set of selected fields.
Sets the projection query property to the given value.
sourcepub fn print_type(self, new_value: &str) -> VolumeListCall<'a>
pub fn print_type(self, new_value: &str) -> VolumeListCall<'a>
Restrict to books or magazines.
Sets the print type query property to the given value.
sourcepub fn partner(self, new_value: &str) -> VolumeListCall<'a>
pub fn partner(self, new_value: &str) -> VolumeListCall<'a>
Restrict and brand results for partner ID.
Sets the partner query property to the given value.
sourcepub fn order_by(self, new_value: &str) -> VolumeListCall<'a>
pub fn order_by(self, new_value: &str) -> VolumeListCall<'a>
Sort search results.
Sets the order by query property to the given value.
sourcepub fn max_results(self, new_value: u32) -> VolumeListCall<'a>
pub fn max_results(self, new_value: u32) -> VolumeListCall<'a>
Maximum number of results to return.
Sets the max results query property to the given value.
sourcepub fn max_allowed_maturity_rating(self, new_value: &str) -> VolumeListCall<'a>
pub fn max_allowed_maturity_rating(self, new_value: &str) -> VolumeListCall<'a>
The maximum allowed maturity rating of returned recommendations. Books with a higher maturity rating are filtered out.
Sets the max allowed maturity rating query property to the given value.
sourcepub fn library_restrict(self, new_value: &str) -> VolumeListCall<'a>
pub fn library_restrict(self, new_value: &str) -> VolumeListCall<'a>
Restrict search to this user’s library.
Sets the library restrict query property to the given value.
sourcepub fn lang_restrict(self, new_value: &str) -> VolumeListCall<'a>
pub fn lang_restrict(self, new_value: &str) -> VolumeListCall<'a>
Restrict results to books with this language code.
Sets the lang restrict query property to the given value.
sourcepub fn filter(self, new_value: &str) -> VolumeListCall<'a>
pub fn filter(self, new_value: &str) -> VolumeListCall<'a>
Filter search results.
Sets the filter query property to the given value.
sourcepub fn download(self, new_value: &str) -> VolumeListCall<'a>
pub fn download(self, new_value: &str) -> VolumeListCall<'a>
Restrict to volumes by download availability.
Sets the download query property to the given value.
sourcepub fn delegate(self, new_value: &'a mut dyn Delegate) -> VolumeListCall<'a>
pub fn delegate(self, new_value: &'a mut dyn Delegate) -> VolumeListCall<'a>
The delegate implementation is consulted whenever there is an intermediate result, or if something goes wrong while executing the actual API request.
It should be used to handle progress information, and to implement a certain level of resilience.
Sets the delegate property to the given value.
sourcepub fn param<T>(self, name: T, value: T) -> VolumeListCall<'a> where
T: AsRef<str>,
pub fn param<T>(self, name: T, value: T) -> VolumeListCall<'a> where
T: AsRef<str>,
Set any additional parameter of the query string used in the request. It should be used to set parameters which are not yet available through their own setters.
Please note that this method must not be used to set any of the known parameters which have their own setter method. If done anyway, the request will fail.
Additional Parameters
- $.xgafv (query-string) - V1 error format.
- access_token (query-string) - OAuth access token.
- alt (query-string) - Data format for response.
- callback (query-string) - JSONP
- fields (query-string) - Selector specifying which fields to include in a partial response.
- key (query-string) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
- oauth_token (query-string) - OAuth 2.0 token for the current user.
- prettyPrint (query-boolean) - Returns response with indentations and line breaks.
- quotaUser (query-string) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
- uploadType (query-string) - Legacy upload protocol for media (e.g. “media”, “multipart”).
- upload_protocol (query-string) - Upload protocol for media (e.g. “raw”, “multipart”).
sourcepub fn add_scope<T, S>(self, scope: T) -> VolumeListCall<'a> where
T: Into<Option<S>>,
S: AsRef<str>,
pub fn add_scope<T, S>(self, scope: T) -> VolumeListCall<'a> where
T: Into<Option<S>>,
S: AsRef<str>,
Identifies the authorization scope for the method you are building.
Use this method to actively specify which scope should be used, instead the default Scope
variant
Scope::Full
.
The scope
will be added to a set of scopes. This is important as one can maintain access
tokens for more than one scope.
If None
is specified, then all scopes will be removed and no default scope will be used either.
In that case, you have to specify your API-key using the key
parameter (see the param()
function for details).
Usually there is more than one suitable scope to authorize an operation, some of which may encompass more rights than others. For example, for listing resources, a read-only scope will be sufficient, a read-write scope will do as well.
Trait Implementations
impl<'a> CallBuilder for VolumeListCall<'a>
Auto Trait Implementations
impl<'a> !RefUnwindSafe for VolumeListCall<'a>
impl<'a> Send for VolumeListCall<'a>
impl<'a> !Sync for VolumeListCall<'a>
impl<'a> Unpin for VolumeListCall<'a>
impl<'a> !UnwindSafe for VolumeListCall<'a>
Blanket Implementations
sourceimpl<T> BorrowMut<T> for T where
T: ?Sized,
impl<T> BorrowMut<T> for T where
T: ?Sized,
const: unstable · sourcefn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more
sourceimpl<T> Instrument for T
impl<T> Instrument for T
sourcefn instrument(self, span: Span) -> Instrumented<Self>
fn instrument(self, span: Span) -> Instrumented<Self>
sourcefn in_current_span(self) -> Instrumented<Self>
fn in_current_span(self) -> Instrumented<Self>
sourceimpl<T> WithSubscriber for T
impl<T> WithSubscriber for T
sourcefn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self> where
S: Into<Dispatch>,
fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self> where
S: Into<Dispatch>,
Attaches the provided Subscriber
to this type, returning a
WithDispatch
wrapper. Read more
sourcefn with_current_subscriber(self) -> WithDispatch<Self>
fn with_current_subscriber(self) -> WithDispatch<Self>
Attaches the current default Subscriber
to this type, returning a
WithDispatch
wrapper. Read more