Struct RequestOptions 

#[non_exhaustive]
pub struct RequestOptions {
    pub priority: Priority,
    pub request_tag: String,
    pub transaction_tag: String,
    pub client_context: Option<ClientContext>,
    /* private fields */
}

Common request options for various APIs.

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

priority: Priority

Priority for the request.

request_tag: String

A per-request tag which can be applied to queries or reads, used for statistics collection. Both request_tag and transaction_tag can be specified for a read or query that belongs to a transaction. This field is ignored for requests where it’s not applicable (for example, CommitRequest). Legal characters for request_tag values are all printable characters (ASCII 32 - 126) and the length of a request_tag is limited to 50 characters. Values that exceed this limit are truncated. Any leading underscore (_) characters are removed from the string.

transaction_tag: String

A tag used for statistics collection about this transaction. Both request_tag and transaction_tag can be specified for a read or query that belongs to a transaction. To enable tagging on a transaction, transaction_tag must be set to the same value for all requests belonging to the same transaction, including BeginTransaction. If this request doesn’t belong to any transaction, transaction_tag is ignored. Legal characters for transaction_tag values are all printable characters (ASCII 32 - 126) and the length of a transaction_tag is limited to 50 characters. Values that exceed this limit are truncated. Any leading underscore (_) characters are removed from the string.

client_context: Option<ClientContext>

Optional. Optional context that may be needed for some requests.

Implementations

impl RequestOptions

pub fn new() -> Self

Creates a new default instance.

pub fn set_priority<T: Into<Priority>>(self, v: T) -> Self

Sets the value of priority.

pub fn set_request_tag<T: Into<String>>(self, v: T) -> Self

Sets the value of request_tag.

pub fn set_transaction_tag<T: Into<String>>(self, v: T) -> Self

Sets the value of transaction_tag.

pub fn set_client_context<T>(self, v: T) -> Self

where T: Into<ClientContext>,

Sets the value of client_context.

pub fn set_or_clear_client_context<T>(self, v: Option<T>) -> Self

where T: Into<ClientContext>,

Sets or clears the value of client_context.

Trait Implementations

impl Clone for RequestOptions

fn clone(&self) -> RequestOptions

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for RequestOptions

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

Formats the value using the given formatter.

impl Default for RequestOptions

fn default() -> RequestOptions

Returns the “default value” for a type.

impl Message for RequestOptions

fn typename() -> &'static str

The typename of this message.

impl PartialEq for RequestOptions

fn eq(&self, other: &RequestOptions) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for RequestOptions